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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <a68fdcb7302c4db5b8cf88dec60f8172@asem.it>
Date:   Wed, 11 Nov 2020 15:34:27 +0000
From:   Flavio Suligoi <f.suligoi@...m.it>
To:     Andy Shevchenko <andy.shevchenko@...il.com>
CC:     Mika Westerberg <mika.westerberg@...ux.intel.com>,
        Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        "Rafael J . Wysocki" <rjw@...ysocki.net>,
        Len Brown <lenb@...nel.org>,
        "open list:GPIO SUBSYSTEM" <linux-gpio@...r.kernel.org>,
        ACPI Devel Maling List <linux-acpi@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: RE: [PATCH v1] Documentation: ACPI: explain how to use
 gpio-line-names

> > > 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