[0/2] Documentation: Explain EAS and EM

Message

Quentin Perret Jan. 10, 2019, 11:05 a.m. UTC

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.

The two new doc files are simple .txt to be consistent with the existing
documentation of the relevant subsystems, but I'm happy to translate to
.rst if deemed necessary.

All feedback is welcome.

Thanks !
Quentin

Quentin Perret (2):
  PM / EM: Document the Energy Model framework
  sched: Document Energy Aware Scheduling

 Documentation/power/energy-model.txt     | 144 ++++++++
 Documentation/scheduler/sched-energy.txt | 425 +++++++++++++++++++++++
 2 files changed, 569 insertions(+)
 create mode 100644 Documentation/power/energy-model.txt
 create mode 100644 Documentation/scheduler/sched-energy.txt