Skip to contentSkip to conversation

docs: add workload-tracing document to admin-guide

PATCH In review Shuah Khan 1 participant 2 messages Jan 31, 2023 Documentation

lore
Share & tools
lore

Shuah Khan

author reviewer
#0 lore raw

PATCH 1/1 docs: add workload-tracing document to admin-guide

Add a new section to the admin-guide with information of interest to application developers and system integrators doing analysis of the Linux kernel for safety critical applications.

This section will contain documents supporting analysis of kernel interactions with applications, and key kernel subsystems expectations.

Add a new workload-tracing document to this new section.

---
Changes since v2: Addressed review comments on v2

 Documentation/admin-guide/index.rst           |  11 +
 .../admin-guide/workload-tracing.rst          | 605 ++++++++++++++++++
 2 files changed, 616 insertions(+)
 create mode 100644 Documentation/admin-guide/workload-tracing.rst
Documentation/admin-guide/index.rst +11 -0
index 5bfafcbb9562..f475554382e2 100644
@@ -56,6 +56,17 @@ ABI will be found here.
 
    sysfs-rules
 
+This is the beginning of a section with information of interest to
+application developers and system integrators doing analysis of the
+Linux kernel for safety critical applications. Documents supporting
+analysis of kernel interactions with applications, and key kernel
+subsystems expectations will be found here.
+
+.. toctree::
+   :maxdepth: 1
+
+   workload-tracing
+
 The rest of this manual consists of various unordered guides on how to
 configure specific aspects of kernel behavior to your liking.
 
Documentation/admin-guide/workload-tracing.rst new file +605 -0

605 lines not on this page · raw message

Signature · 1 line
2.34.1
author reviewer
#1 lore raw
Quoted 11 lines · Shuah Khan

Add a new section to the admin-guide with information of interest to application developers and system integrators doing analysis of the Linux kernel for safety critical applications.

This section will contain documents supporting analysis of kernel interactions with applications, and key kernel subsystems expectations.

Add a new workload-tracing document to this new section.

Quoted 8 lines

---
Changes since v2: Addressed review comments on v2

  Documentation/admin-guide/index.rst           |  11 +
  .../admin-guide/workload-tracing.rst          | 605 ++++++++++++++++++
  2 files changed, 616 insertions(+)

create mode 100644 Documentation/admin-guide/workload-tracing.rst

Sorry forgot to tag it v3 - will send again with the correct version.

-- Shuah