Skip to content

Commit

Permalink
docs/sphinx: Fix indexing
Browse files Browse the repository at this point in the history
sphinx-build reports:

  docs/designs/launch/hyperlaunch.rst: WARNING: document isn't included in any toctree
  docs/designs/launch/hyperlaunch-devicetree.rst: WARNING: document isn't included in any toctree
  docs/misc/xen-makefiles/makefiles.rst: WARNING: document isn't included in any toctree
  docs/misra/C-language-toolchain.rst: WARNING: document isn't included in any toctree
  docs/misra/C-runtime-failures.rst: WARNING: document isn't included in any toctree
  docs/misra/documenting-violations.rst: WARNING: document isn't included in any toctree
  docs/misra/exclude-list.rst: WARNING: document isn't included in any toctree
  docs/misra/xen-static-analysis.rst: WARNING: document isn't included in any toctree

Create an up-to-date index.rst in misra/ create an "unsorted docs" section at
the top level to contain everything else.  They can be re-filed at a later
date.

Signed-off-by: Andrew Cooper <[email protected]>
Acked-by: Stefano Stabellini <[email protected]>
Release-acked-by: Henry Wang <[email protected]>
  • Loading branch information
andyhhp committed Nov 13, 2023
1 parent ab03b28 commit fb41228
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

.. toctree::
:maxdepth: 2

misra/rules
misra/deviations
designs/launch/hyperlaunch
designs/launch/hyperlaunch-devicetree
misc/xen-makefiles/makefiles
misra/index


Miscellanea
Expand Down
18 changes: 18 additions & 0 deletions docs/misra/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. SPDX-License-Identifier: CC-BY-4.0
MISRA C coding guidelines
=========================

MISRA C rules and directive to be used as coding guidelines when writing
Xen hypervisor code and related documents.

.. toctree::
:maxdepth: 2

rules
deviations
C-language-toolchain
C-runtime-failures
documenting-violations
exclude-list
xen-static-analysis

0 comments on commit fb41228

Please sign in to comment.