Linux Trace Kernel
 help / color / mirror / Atom feed
From: Suraj Sonawane <surajsonawane0215@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, Steven Rostedt <rostedt@goodmis.org>
Cc: mhiramat@kernel.org, mathieu.desnoyers@efficios.com,
	linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: fix WARNING document not included in any toctree
Date: Fri, 11 Oct 2024 12:42:14 +0530	[thread overview]
Message-ID: <e7851def-91ce-43e7-880a-22dc5752c4ad@gmail.com> (raw)
In-Reply-To: <87y12vzqg0.fsf@trenco.lwn.net>

On 11/10/24 01:21, Jonathan Corbet wrote:
> Steven Rostedt <rostedt@goodmis.org> writes:
> 
>> On Thu,  3 Oct 2024 01:28:17 +0530
>> SurajSonawane2415 <surajsonawane0215@gmail.com> wrote:
>>
>>> Add debugging.rst to the relevant toctree to fix warning
>>> about missing documentation inclusion in toctree.
>>>
>>> Signed-off-by: SurajSonawane2415 <surajsonawane0215@gmail.com>
>>> ---
>>>   Documentation/trace/index.rst | 1 +
>>>   1 file changed, 1 insertion(+)
>>>
>>> diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
>>> index 0b300901f..2c991dc96 100644
>>> --- a/Documentation/trace/index.rst
>>> +++ b/Documentation/trace/index.rst
>>> @@ -24,6 +24,7 @@ Linux Tracing Technologies
>>>      histogram
>>>      histogram-design
>>>      boottime-trace
>>> +   debugging
>>
>> If order matters here, I'd like the debugging to be at the top. As I plan
>> on it being more of a tutorial for using tracing, and should be the first
>> document people see.
>>

Thanks for the feedback!

>> I need to take some time out and start filling it up!
> 
> That's the order that the links will show up in the rendered page, so
> yes, it matters.
> 
> jon
Can I send an updated patch with this change (moving debugging section 
to the top)?

Best,
Suraj

  reply	other threads:[~2024-10-11  7:12 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-02 19:58 [PATCH] docs: fix WARNING document not included in any toctree SurajSonawane2415
2024-10-07 17:09 ` Jonathan Corbet
2024-10-10 19:47 ` Steven Rostedt
2024-10-10 19:51   ` Jonathan Corbet
2024-10-11  7:12     ` Suraj Sonawane [this message]
2024-10-11 13:28       ` Jonathan Corbet
2024-10-11 13:54         ` Steven Rostedt
2024-10-11 14:09         ` Suraj Sonawane

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e7851def-91ce-43e7-880a-22dc5752c4ad@gmail.com \
    --to=surajsonawane0215@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-kernel@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mhiramat@kernel.org \
    --cc=rostedt@goodmis.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox