Re: [PATCH v3] docs: add workload-tracing document to admin-guide

From: Shuah Khan
Date: Thu Feb 02 2023 - 14:13:12 EST


On 2/2/23 10:43, Jonathan Corbet wrote:
Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx> writes:

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.

Signed-off-by: Shefali Sharma <sshefali021@xxxxxxxxx>
Signed-off-by: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>
---
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

I've applied this with a couple of sphinx tweaks, including:


+.. SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)
+
+Discovering Linux kernel subsystems used by a workload
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

This doesn't follow our normal conventions, so I made it:

======================================================
Discovering Linux kernel subsystems used by a workload
======================================================

Instead.


Thank you.

-- Shuah