Re: [XEN PATCH 2/3] docs: make the docs for MISRA C:2012 Dir 4.1 visible to ECLAIR

[Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>]

On 08/09/2023 02:23, Stefano Stabellini wrote:
> On Fri, 1 Sep 2023, Nicola Vetrini wrote:
> > To be able to check for the existence of the necessary subsections in
> > the documentation for MISRA C:2012 Dir 4.1, ECLAIR needs to have a 
> > source
> > file that is built.
> >
> > This file is generated from 'C-runtime-failures.rst' in docs/misra
> > and the configuration is updated accordingly.
> >
> > Signed-off-by: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
> > ---
> > Changes from RFC:
> > - Dropped unused/useless code
> > - Revised the sed command
> > - Revised the clean target
> > ---
> >  docs/Makefile       |  7 ++++++-
> >  docs/misra/Makefile | 17 +++++++++++++++++
> >  2 files changed, 23 insertions(+), 1 deletion(-)
> >  create mode 100644 docs/misra/Makefile
> >
> > diff --git a/docs/Makefile b/docs/Makefile
> > index 966a104490ac..ff991a0c3ca2 100644
> > --- a/docs/Makefile
> > +++ b/docs/Makefile
> > @@ -43,7 +43,7 @@ DOC_PDF  := $(patsubst 
> > %.pandoc,pdf/%.pdf,$(PANDOCSRC-y)) \
> >  all: build
> >
> >  .PHONY: build
> > -build: html txt pdf man-pages figs
> > +build: html txt pdf man-pages figs misra
> >
> >  .PHONY: sphinx-html
> >  sphinx-html:
> > @@ -66,9 +66,14 @@ endif
> >  .PHONY: pdf
> >  pdf: $(DOC_PDF)
> >
> > +.PHONY: misra
> > +misra:
> > +       $(MAKE) -C misra
> > +
> >  .PHONY: clean
> >  clean: clean-man-pages
> >         $(MAKE) -C figs clean
> > +       $(MAKE) -C misra clean
> >         rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
> >         rm -rf *.ilg *.log *.ind *.toc *.bak *.tmp core
> >         rm -rf html txt pdf sphinx/html
> > diff --git a/docs/misra/Makefile b/docs/misra/Makefile
> > new file mode 100644
> > index 000000000000..8ea0505c8a20
> > --- /dev/null
> > +++ b/docs/misra/Makefile
> > @@ -0,0 +1,17 @@
> > +TARGETS := C-runtime-failures.o
> > +
> > +all: $(TARGETS)
> > +
> > +# sed is used in place of cat to prevent occurrences of '*/'
> > +# in the .rst from breaking the compilation
> Please expand this comment with what you are doing in this makefile and
> specifically what kind of .c file you are generating and why.
>
> Everything else looks good.
Ok

--
Nicola Vetrini, BSc
Software Engineer, BUGSENG srl (https://bugseng.com)