Message ID | 20231108152727.58764-3-andrew.cooper3@citrix.com (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | docs/sphinx: Fix syntax errors and warnings | expand |
> On 8 Nov 2023, at 15:27, Andrew Cooper <andrew.cooper3@citrix.com> wrote: > > 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> > --- Thanks for that. Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> Cheers, Luca
Hi, > On Nov 8, 2023, at 23:30, Luca Fancellu <Luca.Fancellu@arm.com> wrote: > >> On 8 Nov 2023, at 15:27, Andrew Cooper <andrew.cooper3@citrix.com> wrote: >> >> 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> >> --- > > Thanks for that. > > Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> Release-acked-by: Henry Wang <Henry.Wang@arm.com> Kind regards, Henry > > Cheers, > Luca > > >
On Wed, 8 Nov 2023, Luca Fancellu wrote: > > On 8 Nov 2023, at 15:27, Andrew Cooper <andrew.cooper3@citrix.com> wrote: > > > > 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> > > --- > > Thanks for that. > > Reviewed-by: Luca Fancellu <luca.fancellu@arm.com> Acked-by: Stefano Stabellini <sstabellini@kernel.org>
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.
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> --- CC: George Dunlap <George.Dunlap@citrix.com> CC: Jan Beulich <JBeulich@suse.com> CC: Stefano Stabellini <sstabellini@kernel.org> CC: Wei Liu <wl@xen.org> CC: Julien Grall <julien@xen.org> CC: Luca Fancellu <luca.fancellu@arm.com> CC: Henry Wang <Henry.Wang@arm.com> --- docs/misra/exclude-list.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)