[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen master] docs/sphinx: Fix indexing



commit fb41228ececea948c7953c8c16fe28fd65c6536b
Author:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
AuthorDate: Wed Nov 8 14:53:23 2023 +0000
Commit:     Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
CommitDate: Mon Nov 13 14:53:48 2023 +0000

    docs/sphinx: Fix indexing
    
    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 <andrew.cooper3@xxxxxxxxxx>
    Acked-by: Stefano Stabellini <sstabellini@xxxxxxxxxx>
    Release-acked-by: Henry Wang <Henry.Wang@xxxxxxx>
---
 docs/index.rst       | 13 +++++++------
 docs/misra/index.rst | 18 ++++++++++++++++++
 2 files changed, 25 insertions(+), 6 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index f3f779f89c..22fdde8059 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.
 
 .. toctree::
    :maxdepth: 2
 
-   misra/rules
-   misra/deviations
+   designs/launch/hyperlaunch
+   designs/launch/hyperlaunch-devicetree
+   misc/xen-makefiles/makefiles
+   misra/index
 
 
 Miscellanea
diff --git a/docs/misra/index.rst b/docs/misra/index.rst
new file mode 100644
index 0000000000..5068ee5aef
--- /dev/null
+++ b/docs/misra/index.rst
@@ -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
--
generated by git-patchbot for /home/xen/git/xen.git#master



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.