Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20201111130435.432982-1-f.suligoi@asem.it> <CAHp75VeccWtKRQkQE0XyyDZVvkD3QrBig2yU6=pz3KEG-bCKjA@mail.gmail.com>
 <93941f3b0142473399bfdd18608a4056@asem.it>
In-Reply-To: <93941f3b0142473399bfdd18608a4056@asem.it>
From:   Andy Shevchenko <andy.shevchenko@gmail.com>
Date:   Wed, 11 Nov 2020 16:57:53 +0200
Message-ID: <CAHp75Vdhd2Swu5qiYszgBG4pfB8LG=jxgi=YMHNviogWQR_oJw@mail.gmail.com>
Subject: Re: [PATCH v1] Documentation: ACPI: explain how to use gpio-line-names
To:     Flavio Suligoi <f.suligoi@asem.it>
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>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Nov 11, 2020 at 4:53 PM Flavio Suligoi <f.suligoi@asem.it> wrote:

...

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

...

> > ``""`` 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.

-- 
With Best Regards,
Andy Shevchenko