RE: [PATCH v1] Documentation: ACPI: explain how to use gpio-line-names

Flavio Suligoi
2020-11-11T15:34:32Z

> > > Since it's rest, I would expect gpio-line-names in above paragraphs to
> > > be a term, something like
> > > ``gpio-line-names`` (double back quotes on each side). Yes, I know
> > > that there are other places which need to be amended, but I believe
> > > it's out of scope of this patch.
> >
> > Ok, I'll use the backquotes for code samples, right!
> > If you want, when this patch will be concluded, I can check all the ACPI
> > documentation to put all code samples into backquotes.
>
> I'm not sure I understand what you meant under 'code samples'. The
> code excerpts like below are fine, what I'm talking about is the
> reference to properties in the text.

ok, now it's clearer!

>
> ...
>
> > > ``""`` but better to check the resulting (rendered) file. You may use
> > > rst2pdf script for that.
> >
> > OK for the``""``.
> > I check the rendered HTML using the usual "make htmldocs". Is it enough?
>
> Ideally it's not enough. html, pdf and man all should be checked.

ok, I'll check all of them

>
> --
> With Best Regards,
> Andy Shevchenko

Regards,
Flavio