From: Quentin Perret <quentin.perret@arm.com>
To: corbet@lwn.net, peterz@infradead.org, rjw@rjwysocki.net,
juri.lelli@redhat.com
Cc: mingo@redhat.com, morten.rasmussen@arm.com, qais.yousef@arm.com,
patrick.bellasi@arm.com, dietmar.eggemann@arm.com,
linux-doc@vger.kernel.org, linux-pm@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/3] Documentation: Explain EAS and EM
Date: Mon, 21 Jan 2019 11:17:21 +0000 [thread overview]
Message-ID: <20190121111724.18234-1-quentin.perret@arm.com> (raw)
The recently introduced Energy Aware Scheduling (EAS) feature relies on
a large set of concepts, assumptions, and design choices that are
probably not obvious for an outsider. Moreover, enabling EAS on a
particular platform isn't straightforward because of all its
dependencies. This series tries to address this by introducing proper
documentation files for the scheduler's part of EAS and for the newly
introduced Energy Model (EM) framework. These are meant to explain not
only the design choices of EAS but also to list its dependencies in a
human-readable location.
Changes in v2:
- Fixed typos and style in sched-energy.txt (Juri)
- Moved EM doc under Documentation/driver-api/pm/ (Rafael)
- Translated EM doc into .rst (Rafael)
- Fixed EM kerneldoc comments to avoid htmldoc build errors
Quentin Perret (3):
PM / EM: Fix broken kerneldoc
PM / EM: Document the Energy Model framework
sched: Document Energy Aware Scheduling
Documentation/driver-api/pm/energy-model.rst | 150 +++++++
Documentation/driver-api/pm/index.rst | 1 +
Documentation/scheduler/sched-energy.txt | 431 +++++++++++++++++++
include/linux/energy_model.h | 4 +-
kernel/power/energy_model.c | 2 +-
5 files changed, 585 insertions(+), 3 deletions(-)
create mode 100644 Documentation/driver-api/pm/energy-model.rst
create mode 100644 Documentation/scheduler/sched-energy.txt
--
2.20.1
next reply other threads:[~2019-01-21 11:17 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-21 11:17 Quentin Perret [this message]
2019-01-21 11:17 ` [PATCH v2 1/3] PM / EM: Fix broken kerneldoc Quentin Perret
2019-01-21 11:17 ` [PATCH v2 2/3] PM / EM: Document the Energy Model framework Quentin Perret
2019-01-21 11:17 ` [PATCH v2 3/3] sched: Document Energy Aware Scheduling Quentin Perret
2019-02-07 0:32 ` [PATCH v2 0/3] Documentation: Explain EAS and EM Jonathan Corbet
2019-02-07 8:11 ` Quentin Perret
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190121111724.18234-1-quentin.perret@arm.com \
--to=quentin.perret@arm.com \
--cc=corbet@lwn.net \
--cc=dietmar.eggemann@arm.com \
--cc=juri.lelli@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=morten.rasmussen@arm.com \
--cc=patrick.bellasi@arm.com \
--cc=peterz@infradead.org \
--cc=qais.yousef@arm.com \
--cc=rjw@rjwysocki.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).