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

Flavio Suligoi
2020-11-11T14:53:24Z

Hi Andy,

> > This commit also fix a trivial syntax error.
>
> fix -> fixes
> syntax error -> spelling mistake

ok

> > -Example::
> > +The "gpio-line-names" declaration is a list of strings ("names"), which
> > +describes each line/pin of a GPIO controller/expander.
> > +This list, contained in a package, must be inserted inside the GPIO
> controller
> > +declaration of an ACPI table (typically inside the DSDT).
> > +The gpio-line-names list must respect the following rules (see also the
> > +examples):
>
> 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.

>
> Also no need to have each sentence to be started from a new line, it
> will be rendered as it has one white space in between.

ok

> > + other words, it is not mandatory to fill all the GPIO lines
> > + - empty names are allowed (two quotation marks "" correspond to an
> empty name)
>
> ``""`` 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?

> --
> With Best Regards,
> Andy Shevchenko

Regards,
Flavio