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

[Jonathan Corbet]

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.

Thanks,

jon