[PATCH] docs: move tracing tools

Costa Shulyupin posted 1 patch 2 years, 9 months ago
Documentation/index.rst       | 1 -
Documentation/tools/index.rst | 1 +
2 files changed, 1 insertion(+), 1 deletion(-)
[PATCH] docs: move tracing tools
Posted by Costa Shulyupin 2 years, 9 months ago
from list of development tools to user tools
because these tools work on running kernel
and are invoked from user mode

Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
 Documentation/index.rst       | 1 -
 Documentation/tools/index.rst | 1 +
 2 files changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 9dfdc826618c..81e1af951731 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -56,7 +56,6 @@ Various other manuals with useful information for all kernel developers.
    dev-tools/index
    dev-tools/testing-overview
    kernel-hacking/index
-   trace/index
    fault-injection/index
    livepatch/index
    rust/index
diff --git a/Documentation/tools/index.rst b/Documentation/tools/index.rst
index 80488e290e10..6a9a44f7f88a 100644
--- a/Documentation/tools/index.rst
+++ b/Documentation/tools/index.rst
@@ -12,6 +12,7 @@ more additions are needed here:
 
    rtla/index
    rv/index
+   ../trace/index
 
 .. only::  subproject and html
 
-- 
2.40.0
Re: [PATCH] docs: move tracing tools
Posted by Steven Rostedt 2 years, 9 months ago
On Tue, 25 Apr 2023 16:02:30 +0300
Costa Shulyupin <costa.shul@redhat.com> wrote:

> from list of development tools to user tools
> because these tools work on running kernel
> and are invoked from user mode

Wait what? No!

The trace/ directory has a lot that is kernel internal only. Yes, it may
explain how user space can interact with it, but it's also how internal
kernel processes can use the ftrace infrastructure, and also explains a lot
of the kernel design of that code.

NACK!

-- Steve


> 
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
> ---
>  Documentation/index.rst       | 1 -
>  Documentation/tools/index.rst | 1 +
>  2 files changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 9dfdc826618c..81e1af951731 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -56,7 +56,6 @@ Various other manuals with useful information for all kernel developers.
>     dev-tools/index
>     dev-tools/testing-overview
>     kernel-hacking/index
> -   trace/index
>     fault-injection/index
>     livepatch/index
>     rust/index
> diff --git a/Documentation/tools/index.rst b/Documentation/tools/index.rst
> index 80488e290e10..6a9a44f7f88a 100644
> --- a/Documentation/tools/index.rst
> +++ b/Documentation/tools/index.rst
> @@ -12,6 +12,7 @@ more additions are needed here:
>  
>     rtla/index
>     rv/index
> +   ../trace/index
>  
>  .. only::  subproject and html
>
Re: [PATCH] docs: move tracing tools
Posted by Daniel Bristot de Oliveira 2 years, 9 months ago
On 4/25/23 19:48, Steven Rostedt wrote:
> On Tue, 25 Apr 2023 16:02:30 +0300
> Costa Shulyupin <costa.shul@redhat.com> wrote:
> 
>> from list of development tools to user tools
>> because these tools work on running kernel
>> and are invoked from user mode
> Wait what? No!
> 
> The trace/ directory has a lot that is kernel internal only. Yes, it may
> explain how user space can interact with it, but it's also how internal
> kernel processes can use the ftrace infrastructure, and also explains a lot
> of the kernel design of that code.
> 
> NACK!

NACK++

-- Daniel