]> xenbits.xensource.com Git - people/andrewcoop/xen.git/commitdiff
docs/sphinx: Fix syntax issues in exclude-list.rst
authorAndrew Cooper <andrew.cooper3@citrix.com>
Wed, 8 Nov 2023 14:47:10 +0000 (14:47 +0000)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 13 Nov 2023 14:53:48 +0000 (14:53 +0000)
sphinx-build reports:

  docs/misra/exclude-list.rst:47: WARNING: Unexpected indentation.
  docs/misra/exclude-list.rst:50: WARNING: Inline emphasis start-string without end-string.

Nested lists require newlines as delimiters, and * either needs escaping, or
put in a literal block.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Reviewed-by: Luca Fancellu <luca.fancellu@arm.com>
Acked-by: Stefano Stabellini <sstabellini@kernel.org>
Release-acked-by: Henry Wang <Henry.Wang@arm.com>
docs/misra/exclude-list.rst

index 42dbceb825230960d16adbaf402100b9928d665a..a63b128c3d27d96b5ec9582e6a49b11e6f6ddaf9 100644 (file)
@@ -44,10 +44,11 @@ Here is an explanation of the fields inside an object of the "content" array:
    their results. This field is optional and when not specified, it means every
    checker will use that entry.
    Current implemented values for this field are:
+
     - xen-analysis: the xen-analysis.py script exclude this entry for both MISRA
       and static analysis scan. (Implemented only for Cppcheck tool)
 
 To ease the review and the modifications of the entries, they shall be listed in
 alphabetical order referring to the rel_path field.
-Excluded folder paths shall end with '/*' in order to match everything on that
+Excluded folder paths shall end with ``/*`` in order to match everything on that
 folder.