From: Steven Rostedt <rostedt@goodmis.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Suraj Sonawane <surajsonawane0215@gmail.com>,
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 09:54:13 -0400 [thread overview]
Message-ID: <20241011095413.0e57758f@gandalf.local.home> (raw)
In-Reply-To: <87h69izs3b.fsf@trenco.lwn.net>
On Fri, 11 Oct 2024 07:28:40 -0600
Jonathan Corbet <corbet@lwn.net> wrote:
> Suraj Sonawane <surajsonawane0215@gmail.com> writes:
>
> > Can I send an updated patch with this change (moving debugging section
> > to the top)?
>
> The patch is already applied, so no. You can send a new patch against
> docs-next if that sort of movement is warranted.
>
> Honestly, though, just shuffling one file around only seems so useful.
> What would be nice would be to turn index.rst into a good starting point
> for people wanting to learn about tracing, rather than just a jumble of
> files. It needs organization into sections and some connecting text; as
> an example, see the (minimal) organizational work that I did for
> Documentation/process/index.rst.
>
> It's more work, but would certainly pay off.
I'm still new to how the Documentation directory is set up. But I agree
with Jon. It's been on my todo list to make the tracing directory more of a
tutorial. I just need to find the time to do so.
-- Steve
next prev parent reply other threads:[~2024-10-11 13:54 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
2024-10-11 13:28 ` Jonathan Corbet
2024-10-11 13:54 ` Steven Rostedt [this message]
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=20241011095413.0e57758f@gandalf.local.home \
--to=rostedt@goodmis.org \
--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=surajsonawane0215@gmail.com \
/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