Re: [PATCH v3] Documentation: livepatch: document reliable stacktrace

[Mark Rutland]

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@xxxxxxxxxx> 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.