From: Flavio Suligoi <f.suligoi@asem.it>
To: Andy Shevchenko <andy.shevchenko@gmail.com>
Cc: Mika Westerberg <mika.westerberg@linux.intel.com>,
Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
"Rafael J . Wysocki" <rjw@rjwysocki.net>,
Len Brown <lenb@kernel.org>,
"open list:GPIO SUBSYSTEM" <linux-gpio@vger.kernel.org>,
ACPI Devel Maling List <linux-acpi@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: RE: [PATCH v1] Documentation: ACPI: explain how to use gpio-line-names
Date: Wed, 11 Nov 2020 14:53:13 +0000 [thread overview]
Message-ID: <93941f3b0142473399bfdd18608a4056@asem.it> (raw)
In-Reply-To: <CAHp75VeccWtKRQkQE0XyyDZVvkD3QrBig2yU6=pz3KEG-bCKjA@mail.gmail.com>
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
next prev parent reply other threads:[~2020-11-11 14:53 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-11 13:04 [PATCH v1] Documentation: ACPI: explain how to use gpio-line-names Flavio Suligoi
2020-11-11 13:59 ` Andy Shevchenko
2020-11-11 14:53 ` Flavio Suligoi [this message]
2020-11-11 14:57 ` Andy Shevchenko
2020-11-11 15:34 ` Flavio Suligoi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=93941f3b0142473399bfdd18608a4056@asem.it \
--to=f.suligoi@asem.it \
--cc=andriy.shevchenko@linux.intel.com \
--cc=andy.shevchenko@gmail.com \
--cc=lenb@kernel.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mika.westerberg@linux.intel.com \
--cc=rjw@rjwysocki.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).