linux-kernel - Re: [PATCH] docs: fix WARNING document not included in any toctree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <e7851def-91ce-43e7-880a-22dc5752c4ad@gmail.com>
Date: Fri, 11 Oct 2024 12:42:14 +0530
From: Suraj Sonawane <surajsonawane0215@...il.com>
To: Jonathan Corbet <corbet@....net>, Steven Rostedt <rostedt@...dmis.org>
Cc: mhiramat@...nel.org, mathieu.desnoyers@...icios.com,
 linux-kernel@...r.kernel.org, linux-trace-kernel@...r.kernel.org,
 linux-doc@...r.kernel.org
Subject: Re: [PATCH] docs: fix WARNING document not included in any toctree

On 11/10/24 01:21, Jonathan Corbet wrote:
> Steven Rostedt <rostedt@...dmis.org> writes:
> 
>> On Thu,  3 Oct 2024 01:28:17 +0530
>> SurajSonawane2415 <surajsonawane0215@...il.com> wrote:
>>
>>> Add debugging.rst to the relevant toctree to fix warning
>>> about missing documentation inclusion in toctree.
>>>
>>> Signed-off-by: SurajSonawane2415 <surajsonawane0215@...il.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