Skip to contentSkip to conversation

docs: scheduler: Start documenting the EEVDF scheduler

PATCH In review Carlos Bilbao 2 participants 3 messages Jul 20, 2024 – Aug 7, 2024 Documentation

lore
Share & tools
lore
#0 lore raw

v3 cover docs: scheduler: Start documenting the EEVDF scheduler

I was in the process of updating the CFS documentation, as Sergio proposed, when I realized we don't have any EEVDF documentation to point to. I have started it. I know it isn't a lot of info about EEVDF in the doc, but (1) I wanted to get the ball rolling, and (2) I prefer to keep it light until we have a solid idea of how EEVDF will actually end up. This could take a while. When or if it stops being an option, we can revisit it.

Sergio, if you’d like to update the Spanish translations of CFS and add one for this new EEVDF doc, please go for it! ;)

Thanks,
Carlos

P.S.: Jon, I have triple-checked for compilation warnings, but if you
encounter any, please LMK the versions of your tools so I can match them moving forward.

Carlos:
docs: scheduler: Start documenting the EEVDF scheduler

---
Changelog:
v3: Removed labels and used instead paths to documents.
v2: Move file within scheduler index. Remove incorrect subsection
numbering.

---
 Documentation/scheduler/index.rst            |  1 +
 Documentation/scheduler/sched-design-CFS.rst | 10 +++--
 Documentation/scheduler/sched-eevdf.rst      | 43 ++++++++++++++++++++
 3 files changed, 50 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/scheduler/sched-eevdf.rst
#1 lore raw

PATCH v3 1/1 docs: scheduler: Start documenting the EEVDF scheduler

Add some documentation regarding the newly introduced scheduler EEVDF.

---
 Documentation/scheduler/index.rst            |  1 +
 Documentation/scheduler/sched-design-CFS.rst | 10 +++--
 Documentation/scheduler/sched-eevdf.rst      | 43 ++++++++++++++++++++
 3 files changed, 50 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/scheduler/sched-eevdf.rst
Documentation/scheduler/index.rst +1 -0
index 43bd8a145b7a..1f2942c4d14b 100644
@@ -12,6 +12,7 @@ Scheduler
     sched-bwc
     sched-deadline
     sched-design-CFS
+    sched-eevdf
     sched-domains
     sched-capacity
     sched-energy
Documentation/scheduler/sched-design-CFS.rst +6 -4
index bc1e507269c6..8786f219fc73 100644
@@ -8,10 +8,12 @@ CFS Scheduler
 1.  OVERVIEW
 ============
 
-CFS stands for "Completely Fair Scheduler," and is the new "desktop" process
-scheduler implemented by Ingo Molnar and merged in Linux 2.6.23.  It is the
-replacement for the previous vanilla scheduler's SCHED_OTHER interactivity
-code.
+CFS stands for "Completely Fair Scheduler," and is the "desktop" process
+scheduler implemented by Ingo Molnar and merged in Linux 2.6.23. When
+originally merged, it was the replacement for the previous vanilla
+scheduler's SCHED_OTHER interactivity code. Nowadays, CFS is making room
+for EEVDF, for which documentation can be found in
+Documentation/scheduler/sched-eevdf.rst.
 
 80% of CFS's design can be summed up in a single sentence: CFS basically models
 an "ideal, precise multi-tasking CPU" on real hardware.
Documentation/scheduler/sched-eevdf.rst new file +43 -0

43 lines not on this page · raw message

Signature · 1 line
2.43.0
maintainer
#2 lore raw
In reply to Carlos Bilbao
Quoted 26 lines · Carlos Bilbao

I was in the process of updating the CFS documentation, as Sergio proposed, when I realized we don't have any EEVDF documentation to point to. I have started it. I know it isn't a lot of info about EEVDF in the doc, but (1) I wanted to get the ball rolling, and (2) I prefer to keep it light until we have a solid idea of how EEVDF will actually end up. This could take a while. When or if it stops being an option, we can revisit it.

Sergio, if you’d like to update the Spanish translations of CFS and add one for this new EEVDF doc, please go for it! ;)

Thanks,
Carlos

P.S.: Jon, I have triple-checked for compilation warnings, but if you
encounter any, please LMK the versions of your tools so I can match them moving forward.

Carlos:
docs: scheduler: Start documenting the EEVDF scheduler

---
Changelog:
v3: Removed labels and used instead paths to documents.
v2: Move file within scheduler index. Remove incorrect subsection
numbering.

Quoted 6 lines
---
 Documentation/scheduler/index.rst            |  1 +
 Documentation/scheduler/sched-design-CFS.rst | 10 +++--
 Documentation/scheduler/sched-eevdf.rst      | 43 ++++++++++++++++++++
 3 files changed, 50 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/scheduler/sched-eevdf.rst

So, nobody has screamed, so I went ahead and applied this.

Thanks,

jon