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

[PATCH for-4.18 2/3] docs/sphinx: Fix syntax issues in exclude-list.rst


  • To: Xen-devel <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
  • Date: Wed, 8 Nov 2023 15:27:26 +0000
  • Authentication-results: esa6.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none
  • Cc: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, George Dunlap <George.Dunlap@xxxxxxxxxx>, Jan Beulich <JBeulich@xxxxxxxx>, "Stefano Stabellini" <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>, Julien Grall <julien@xxxxxxx>, Luca Fancellu <luca.fancellu@xxxxxxx>, Henry Wang <Henry.Wang@xxxxxxx>
  • Delivery-date: Wed, 08 Nov 2023 15:27:53 +0000
  • Ironport-data: A9a23:kFSvdKCehBEF9BVW//njw5YqxClBgxIJ4kV8jS/XYbTApDpw3mdVy TYaXWyHOPyMYTH1eIh/bYi08UJTsJKDz94yQQY4rX1jcSlH+JHPbTi7wuUcHAvJd5GeExg3h yk6QoOdRCzhZiaE/n9BCpC48D8kk/nOH+KgYAL9EngZbRd+Tys8gg5Ulec8g4p56fC0GArIs t7pyyHlEAbNNwVcbCRMsMpvlDs15K6p4WpA7gRnDRx2lAS2e0c9Xcp3yZ6ZdxMUcqEMdsamS uDKyq2O/2+x13/B3fv8z94X2mVTKlLjFVDmZkh+AsBOsTAbzsAG6Y4pNeJ0VKtio27hc+ada jl6ncfYpQ8BZsUgkQmGOvVSO3kW0aZuoNcrLZUj2CA6IoKvn3bEmp1T4E8K0YIw3bl6CjwR7 8YkLz0XZRm+nuCGyeKYRbw57igjBJGD0II3v3hhyXfSDOo8QICFSKLPjTNa9G5u3IYUR6+YP pdIL2U3BPjDS0Qn1lM/IZQyhuq3wFL4dCVVsgm9rqsr+WnDigd21dABNfKMIIPTHp8IxhvwS mTurm7ZDzEmC/ylkT+KyXnvu77rvA7LYddHfFG/3qEz2wDCroAJMzUGWF3+rfSnh0qWX9NEN 1dS6icotbI19kGgUp/6RRLQiFyuswMYWtFQO/Yn8wzLwa3Riy6CHXQNRDNFbN0gtec1SCYs2 1vPmMnmbRRwtJWFRHTb8a2bxRuwJCwUIGkqdSICCwwf7LHLpJw4h1TBR9BoHaqxk/X8AzS2y DePxAAeirMJnIg03qO01VndhnSnoZ2hc+IuzlyJBCT/tFo/PdP0IdPwgbTG0RpeBKHGQ1Lc4 2I+p8+T9usHMIiPpCXdY+pYSdlF+M253C3gbU9HRsdwpmj0pib/LOi88xkkeh01bJxslSvBJ R+L410Mvve/KVPzNfcvC79dHfjG2kQJ+T7NfffOZ94GWYBrdQmI50mCjmbLhDiyySDAfUwlU Kp3kPpA7l5AUsyLNBLsG48gPUYDn0jSP1/7S5Hh1AiA2rGDfnOTQrptGALQP7FivPnc8FqIq Yk32y62J/J3CbKWX8Uq2ddOdg5iwYYTXvgaVPC7hsbce1E7SQnN+tfawK87epwNokimvr6gw 51JYWcBkACXrSSeeW23hoVLNOuHsWBX8ShqYkTB/D+AhxAeXGpYxP5FKMJpJOd4qbcLIDwdZ 6BtRvhsy89nElzvkwnxp7GkxGC+XHxHXT6zAhc=
  • Ironport-hdrordr: A9a23:WUTDb6yfMZu241kcLPcgKrPxMegkLtp133Aq2lEZdPULSKClfp GV8cjziyWftN9IYgBYpTnyAtj5fZq8z+893WB1B9zMYOCIghrMEGgP1+XfKnjbakvDH41mpO 9dmspFebnN5DFB5K7HCUuDYrEdKbG8geSVbIzlr0uFODsaCZ2ImD0JaTpzfHcWeCB2Qb4CUL aM7MtOoDStPVwRc8SAH3EAG8TTutHRk5riQBgeQzoq8hOHgz+E4KPzV0Hw5GZVbxp/hZMZtU TVmQ3w4auu99m91x/nzmfWq7hGhdf7zdNHJcqUzuwYMC/lhAqEbJloH5eCoDc2iuey70tCqq iGnz4Qe+BIr1/BdGC8phXgnyP61iw11nPkwViExVP+vM3QXlsBeod8rLMcViGcx1srvdl63q 4O9XmerYBrARTJmzm4z8TUVittilG/rRMZ4KIuZj1kIMQjgY1q3M0iFXBuYdc99eXBmcMa+d xVfY/hDTBtABGnhj7izyxSKZeXLw8O91+9MzI/U4WuokRrdHwV9Tpk+OUP2ngH754zUJ9C+q DNNblpjqhHSosMYbt6H/ppe7rCNoXhe2O/DIupGyWTKIgXf3bW75Ln6rQ84++nPJQO0ZspgZ zEFFdVr3Q7dU7iAdCHmMQjyGG6fEytGTD2js1O7ZlwvbPxALLtLC2YUVgr18+tue8WDMHXU+ u6fJhWH/jgJ23zHpsh5XyIZ7BCbX0FFMEFsNcyXFyD5srNN43xr+TeNO3eIbL8eAxUKV8Xwk FzLAQbCP8wn3xDAEWI/yQ5c0mdBHDCwQ==
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

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@xxxxxxxxxx>
---
CC: George Dunlap <George.Dunlap@xxxxxxxxxx>
CC: Jan Beulich <JBeulich@xxxxxxxx>
CC: Stefano Stabellini <sstabellini@xxxxxxxxxx>
CC: Wei Liu <wl@xxxxxxx>
CC: Julien Grall <julien@xxxxxxx>
CC: Luca Fancellu <luca.fancellu@xxxxxxx>
CC: Henry Wang <Henry.Wang@xxxxxxx>
---
 docs/misra/exclude-list.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/misra/exclude-list.rst b/docs/misra/exclude-list.rst
index 42dbceb82523..a63b128c3d27 100644
--- a/docs/misra/exclude-list.rst
+++ b/docs/misra/exclude-list.rst
@@ -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.
-- 
2.30.2




 


Rackspace

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