linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] trace: minor documentation fixes for clarity and
@ 2025-08-31 10:17 Ryan Chung
  2025-08-31 10:17 ` [PATCH 1/2] trace: rephrase for clearer documentation Ryan Chung
                   ` (2 more replies)
  0 siblings, 3 replies; 7+ messages in thread
From: Ryan Chung @ 2025-08-31 10:17 UTC (permalink / raw)
  To: rostedt, mhiramat, mathieu.desnoyers, corbet
  Cc: Ryan Chung, linux-kernel, linux-trace-kernel, linux-doc

Resend: fixed recipients; no changes

Hi all,

This short series cleans up two small wording issues in the tracing docs to
improve readability. There are no functional changes.

Ryan Chung (2):
  trace: rephrase for clearer documentation
  trace: fix grammar error in debugging.rst

 Documentation/trace/boottime-trace.rst | 2 +-
 Documentation/trace/debugging.rst      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

-- 
2.43.0


^ permalink raw reply	[flat|nested] 7+ messages in thread

* [PATCH 1/2] trace: rephrase for clearer documentation
  2025-08-31 10:17 [PATCH 0/2] trace: minor documentation fixes for clarity and Ryan Chung
@ 2025-08-31 10:17 ` Ryan Chung
  2025-08-31 10:17 ` [PATCH 2/2] trace: fix grammar error in debugging.rst Ryan Chung
  2025-09-02 14:28 ` [PATCH 0/2] trace: minor documentation fixes for clarity and Steven Rostedt
  2 siblings, 0 replies; 7+ messages in thread
From: Ryan Chung @ 2025-08-31 10:17 UTC (permalink / raw)
  To: rostedt, mhiramat, mathieu.desnoyers, corbet
  Cc: Ryan Chung, linux-kernel, linux-trace-kernel, linux-doc

Signed-off-by: Ryan Chung <seokwoo.chung130@gmail.com>
---
 Documentation/trace/boottime-trace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/trace/boottime-trace.rst b/Documentation/trace/boottime-trace.rst
index 3efac10adb36..651f3a2c01de 100644
--- a/Documentation/trace/boottime-trace.rst
+++ b/Documentation/trace/boottime-trace.rst
@@ -19,7 +19,7 @@ this uses bootconfig file to describe tracing feature programming.
 Options in the Boot Config
 ==========================
 
-Here is the list of available options list for boot time tracing in
+Here is the list of available options for boot time tracing in
 boot config file [1]_. All options are under "ftrace." or "kernel."
 prefix. See kernel parameters for the options which starts
 with "kernel." prefix [2]_.
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 7+ messages in thread

* [PATCH 2/2] trace: fix grammar error in debugging.rst
  2025-08-31 10:17 [PATCH 0/2] trace: minor documentation fixes for clarity and Ryan Chung
  2025-08-31 10:17 ` [PATCH 1/2] trace: rephrase for clearer documentation Ryan Chung
@ 2025-08-31 10:17 ` Ryan Chung
  2025-09-02 14:28 ` [PATCH 0/2] trace: minor documentation fixes for clarity and Steven Rostedt
  2 siblings, 0 replies; 7+ messages in thread
From: Ryan Chung @ 2025-08-31 10:17 UTC (permalink / raw)
  To: rostedt, mhiramat, mathieu.desnoyers, corbet
  Cc: Ryan Chung, linux-kernel, linux-trace-kernel, linux-doc

Signed-off-by: Ryan Chung <seokwoo.chung130@gmail.com>
---
 Documentation/trace/debugging.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/trace/debugging.rst b/Documentation/trace/debugging.rst
index d54bc500af80..4d88c346fc38 100644
--- a/Documentation/trace/debugging.rst
+++ b/Documentation/trace/debugging.rst
@@ -59,7 +59,7 @@ There is various methods of acquiring the state of the system when a kernel
 crash occurs. This could be from the oops message in printk, or one could
 use kexec/kdump. But these just show what happened at the time of the crash.
 It can be very useful in knowing what happened up to the point of the crash.
-The tracing ring buffer, by default, is a circular buffer than will
+The tracing ring buffer, by default, is a circular buffer that will
 overwrite older events with newer ones. When a crash happens, the content of
 the ring buffer will be all the events that lead up to the crash.
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [PATCH 0/2] trace: minor documentation fixes for clarity and
  2025-08-31 10:17 [PATCH 0/2] trace: minor documentation fixes for clarity and Ryan Chung
  2025-08-31 10:17 ` [PATCH 1/2] trace: rephrase for clearer documentation Ryan Chung
  2025-08-31 10:17 ` [PATCH 2/2] trace: fix grammar error in debugging.rst Ryan Chung
@ 2025-09-02 14:28 ` Steven Rostedt
  2025-09-03 18:25   ` Ryan Chung
  2 siblings, 1 reply; 7+ messages in thread
From: Steven Rostedt @ 2025-09-02 14:28 UTC (permalink / raw)
  To: Ryan Chung
  Cc: mhiramat, mathieu.desnoyers, corbet, linux-kernel,
	linux-trace-kernel, linux-doc

On Sun, 31 Aug 2025 19:17:27 +0900
Ryan Chung <seokwoo.chung130@gmail.com> wrote:

> Resend: fixed recipients; no changes
> 
> Hi all,
> 
> This short series cleans up two small wording issues in the tracing docs to
> improve readability. There are no functional changes.
> 
> Ryan Chung (2):
>   trace: rephrase for clearer documentation
>   trace: fix grammar error in debugging.rst
> 
>  Documentation/trace/boottime-trace.rst | 2 +-
>  Documentation/trace/debugging.rst      | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 

Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>

The only comments I would make is the subject tag for the trace files
is actually "tracing:" and not "trace:".

Also, even though the changes are minor, a simple change log would
still be nice.

-- Steve

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH 0/2] trace: minor documentation fixes for clarity and
  2025-09-02 14:28 ` [PATCH 0/2] trace: minor documentation fixes for clarity and Steven Rostedt
@ 2025-09-03 18:25   ` Ryan Chung
  2025-09-03 19:52     ` Steven Rostedt
  0 siblings, 1 reply; 7+ messages in thread
From: Ryan Chung @ 2025-09-03 18:25 UTC (permalink / raw)
  To: Steven Rostedt
  Cc: mhiramat, mathieu.desnoyers, corbet, linux-kernel,
	linux-trace-kernel, linux-doc

On Tue, Sep 02, 2025 at 10:28:31AM -0400, Steven Rostedt wrote:
> On Sun, 31 Aug 2025 19:17:27 +0900
> Ryan Chung <seokwoo.chung130@gmail.com> wrote:
> 
> > Resend: fixed recipients; no changes
> > 
> > Hi all,
> > 
> > This short series cleans up two small wording issues in the tracing docs to
> > improve readability. There are no functional changes.
> > 
> > Ryan Chung (2):
> >   trace: rephrase for clearer documentation
> >   trace: fix grammar error in debugging.rst
> > 
> >  Documentation/trace/boottime-trace.rst | 2 +-
> >  Documentation/trace/debugging.rst      | 2 +-
> >  2 files changed, 2 insertions(+), 2 deletions(-)
> > 
> 
> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> 
> The only comments I would make is the subject tag for the trace files
> is actually "tracing:" and not "trace:".
> 
> Also, even though the changes are minor, a simple change log would
> still be nice.
> 
> -- Steve

Hi. Thank you for your comment. 
I will make sure to add the change log next time.
Please let me know if I should do it and make a v2. 

Best regards,
Ryan Chung

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH 0/2] trace: minor documentation fixes for clarity and
  2025-09-03 18:25   ` Ryan Chung
@ 2025-09-03 19:52     ` Steven Rostedt
  2025-09-03 21:32       ` Jonathan Corbet
  0 siblings, 1 reply; 7+ messages in thread
From: Steven Rostedt @ 2025-09-03 19:52 UTC (permalink / raw)
  To: Ryan Chung
  Cc: mhiramat, mathieu.desnoyers, corbet, linux-kernel,
	linux-trace-kernel, linux-doc

On Thu, 4 Sep 2025 03:25:03 +0900
Ryan Chung <seokwoo.chung130@gmail.com> wrote:

> Hi. Thank you for your comment. 
> I will make sure to add the change log next time.
> Please let me know if I should do it and make a v2. 

I already gave an ack. I'll let Jon decided if there should be a v2 or
not.

-- Steve

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH 0/2] trace: minor documentation fixes for clarity and
  2025-09-03 19:52     ` Steven Rostedt
@ 2025-09-03 21:32       ` Jonathan Corbet
  0 siblings, 0 replies; 7+ messages in thread
From: Jonathan Corbet @ 2025-09-03 21:32 UTC (permalink / raw)
  To: Steven Rostedt, Ryan Chung
  Cc: mhiramat, mathieu.desnoyers, linux-kernel, linux-trace-kernel,
	linux-doc

Steven Rostedt <rostedt@goodmis.org> writes:

> On Thu, 4 Sep 2025 03:25:03 +0900
> Ryan Chung <seokwoo.chung130@gmail.com> wrote:
>
>> Hi. Thank you for your comment. 
>> I will make sure to add the change log next time.
>> Please let me know if I should do it and make a v2. 
>
> I already gave an ack. I'll let Jon decided if there should be a v2 or
> not.

No need - I applied them and applied the tweak directly.

Thanks,

jon

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2025-09-03 21:32 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-31 10:17 [PATCH 0/2] trace: minor documentation fixes for clarity and Ryan Chung
2025-08-31 10:17 ` [PATCH 1/2] trace: rephrase for clearer documentation Ryan Chung
2025-08-31 10:17 ` [PATCH 2/2] trace: fix grammar error in debugging.rst Ryan Chung
2025-09-02 14:28 ` [PATCH 0/2] trace: minor documentation fixes for clarity and Steven Rostedt
2025-09-03 18:25   ` Ryan Chung
2025-09-03 19:52     ` Steven Rostedt
2025-09-03 21:32       ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).