linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 0/3] Documentation: Explain EAS and EM
@ 2019-01-21 11:17 Quentin Perret
  2019-01-21 11:17 ` [PATCH v2 1/3] PM / EM: Fix broken kerneldoc Quentin Perret
                   ` (3 more replies)
  0 siblings, 4 replies; 6+ messages in thread
From: Quentin Perret @ 2019-01-21 11:17 UTC (permalink / raw)
  To: corbet, peterz, rjw, juri.lelli
  Cc: mingo, morten.rasmussen, qais.yousef, patrick.bellasi,
	dietmar.eggemann, linux-doc, linux-pm, linux-kernel

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


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2019-02-07  8:11 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-01-21 11:17 [PATCH v2 0/3] Documentation: Explain EAS and EM Quentin Perret
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

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).