2020-06-30 20:48:08

by Manbing

[permalink] [raw]
Subject: [PATCH] trace doc: fix typo of trace/ftrace.rst

Some documents was converted from the plain text documentation
to reStructuredText format.

Signed-off-by: Manbing <[email protected]>
---
Documentation/trace/ftrace.rst | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
index 430a16283103..0b479243b903 100644
--- a/Documentation/trace/ftrace.rst
+++ b/Documentation/trace/ftrace.rst
@@ -34,7 +34,7 @@ Throughout the kernel is hundreds of static event points that
can be enabled via the tracefs file system to see what is
going on in certain parts of the kernel.

-See events.txt for more information.
+See events.rst for more information.


Implementation Details
@@ -376,11 +376,11 @@ of ftrace. Here is a list of some of the key files:

kprobe_events:

- Enable dynamic trace points. See kprobetrace.txt.
+ Enable dynamic trace points. See kprobetrace.rst.

kprobe_profile:

- Dynamic trace points stats. See kprobetrace.txt.
+ Dynamic trace points stats. See kprobetrace.rst.

max_graph_depth:

@@ -568,7 +568,7 @@ of ftrace. Here is a list of some of the key files:
uprobe_events:

Add dynamic tracepoints in programs.
- See uprobetracer.txt
+ See uprobetracer.rst

uprobe_profile:

@@ -589,19 +589,19 @@ of ftrace. Here is a list of some of the key files:
files at various levels that can enable the tracepoints
when a "1" is written to them.

- See events.txt for more information.
+ See events.rst for more information.

set_event:

By echoing in the event into this file, will enable that event.

- See events.txt for more information.
+ See events.rst for more information.

available_events:

A list of events that can be enabled in tracing.

- See events.txt for more information.
+ See events.rst for more information.

timestamp_mode:

--
2.17.1


2020-07-05 20:13:40

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] trace doc: fix typo of trace/ftrace.rst

On Tue, 30 Jun 2020 11:53:55 -0700
Manbing <[email protected]> wrote:

> Some documents was converted from the plain text documentation
> to reStructuredText format.
>
> Signed-off-by: Manbing <[email protected]>
> ---
> Documentation/trace/ftrace.rst | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)

I've applied this, thanks. I did change the subject line, though, since a
failure to update the names of some documents is not exactly a "typo".

In the future, please include your full name in the Signed-off-by tag.
For something this trivial it wasn't worth making a fuss about, but
maintainers are likely to balk with more significant changes.

Thanks,

jon