Re: [PATCH for-4.18 3/3] docs/sphinx: Fix indexing

[Stefano Stabellini <sstabellini@xxxxxxxxxx>]

On Fri, 10 Nov 2023, Andrew Cooper wrote:
> On 10/11/2023 12:07 am, Stefano Stabellini wrote:
> > On Wed, 8 Nov 2023, Andrew Cooper wrote:
> >> diff --git a/docs/index.rst b/docs/index.rst
> >> index f3f779f89ce5..22fdde80590c 100644
> >> --- a/docs/index.rst
> >> +++ b/docs/index.rst
> >> @@ -53,17 +53,18 @@ kind of development environment.
> >>     hypervisor-guide/index
> >>  
> >>  
> >> -MISRA C coding guidelines
> >> --------------------------
> >> +Unsorted documents
> >> +------------------
> >>  
> >> -MISRA C rules and directive to be used as coding guidelines when writing
> >> -Xen hypervisor code.
> >> +Documents in need of some rearranging.
> > I understand the need for an "Unsorted documents", but why taking away
> > "MISRA C coding guidelines" from here?
> 
> You can't have it both here and in index.rst without breaking the indexing.
> 
> Also because in it's current position it breaks the navbar.  MISRA is
> part of the developer guide, and what should be at the toplevel should
> be a general section on safety certification, which cross-references the
> developer guide amongst other things.  Nevertheless it will stay visible
> for now at the top level because of how the toctree.
> 
> It's in unsorted because I have thrown the index together with the bare
> minimum effort in order to fix Sphinx errors in time for 4.18.
> 
> This is also why I'm not changing any text.  There is 0 time between now
> and this needing fixing for the release.
> 
> Someone else can find some time to polish it - which is far more work
> than just in the index - and we can backport it when its done.

OK. I don't mean to make things difficult so if you don't think it is
easy to keep "MISRA C coding guidelines" here in docs/index.rst then so
be it. Can you at least add "and related files" to the text in
docs/misra/index.rst? Can be done on commit. Anyway:

Acked-by: Stefano Stabellini <sstabellini@xxxxxxxxxx>