From: Mark Rutland <mark.rutland@arm.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mark Brown <broonie@kernel.org>,
Josh Poimboeuf <jpoimboe@redhat.com>,
linux-kernel@vger.kernel.org, Jiri Kosina <jikos@kernel.org>,
Joe Lawrence <joe.lawrence@redhat.com>,
Miroslav Benes <mbenes@suse.cz>, Petr Mladek <pmladek@suse.com>,
linux-doc@vger.kernel.org, live-patching@vger.kernel.org,
linux-doc@vgert.kernel.org
Subject: Re: [PATCH v3] Documentation: livepatch: document reliable stacktrace
Date: Mon, 18 Jan 2021 12:21:35 +0000 [thread overview]
Message-ID: <20210118122135.GA31263@C02TD0UTHF1T.local> (raw)
In-Reply-To: <20210115102014.76e51309@lwn.net>
On Fri, Jan 15, 2021 at 10:20:14AM -0700, Jonathan Corbet wrote:
> On Fri, 15 Jan 2021 17:12:51 +0000
> Mark Brown <broonie@kernel.org> wrote:
>
> > On Fri, Jan 15, 2021 at 04:47:18PM +0000, Mark Rutland wrote:
> > > On Fri, Jan 15, 2021 at 02:24:46PM +0000, Mark Brown wrote:
> >
> > > > + 3. Considerations
> > > > + 3.1 Identifying successful termination
> >
> > > It looks like we forgot to update this with the addition of the new
> > > section 3, so this needs a trivial update to add that and fix the
> > > numbering.
> >
> > Bah, I thought the point with structured documentation formats was that
> > tooling would handle stuff like this :/
>
> The tooling *will* handle it if you let it, it's a simple matter of
> replacing the hand-generated table of contents with a Sphinx directive. I
> think that's generally the right thing to do, but it does have the
> downside of only putting the TOC in the generated docs.
Ah, I was not aware of that, and I had copied the TOC style from
Documentation/livepatch/livepatch.rst.
That does sound like the right thing to do generally, and I have no
problem doing that here, but I guess we be consistent and either do that
for all or none of the Documentation/livepatch/*.rst documents. I guess
we could do that as a followup?
Thanks,
Mark.
prev parent reply other threads:[~2021-01-18 12:22 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-15 14:24 [PATCH v3] Documentation: livepatch: document reliable stacktrace Mark Brown
2021-01-15 15:16 ` Josh Poimboeuf
2021-01-15 16:47 ` Mark Rutland
2021-01-15 17:12 ` Mark Brown
2021-01-15 17:20 ` Jonathan Corbet
2021-01-18 12:21 ` Mark Rutland [this message]
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=20210118122135.GA31263@C02TD0UTHF1T.local \
--to=mark.rutland@arm.com \
--cc=broonie@kernel.org \
--cc=corbet@lwn.net \
--cc=jikos@kernel.org \
--cc=joe.lawrence@redhat.com \
--cc=jpoimboe@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-doc@vgert.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=live-patching@vger.kernel.org \
--cc=mbenes@suse.cz \
--cc=pmladek@suse.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;
as well as URLs for NNTP newsgroup(s).