Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Subject: Re: [PATCH 7/9] docs: Remove unknown 'hint' directive
To:     Markus Heiser <markus.heiser@darmarit.de>,
        "Tobin C. Harding" <tobin@kernel.org>,
        Jonathan Corbet <corbet@lwn.net>
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20190307211153.28400-1-tobin@kernel.org>
 <20190307211153.28400-8-tobin@kernel.org>
 <77efd92e-f882-bb32-e58c-6836e4307744@infradead.org>
 <2e8c4224-181e-e107-51b9-86d2f1d41309@darmarit.de>
 <4b41199e-6b4c-d78d-9f3e-044d2ee599b5@infradead.org>
From:   Randy Dunlap <rdunlap@infradead.org>
Message-ID: <8ca3ea67-c4aa-dc06-fb21-0c5c58a09669@infradead.org>
Date:   Fri, 8 Mar 2019 08:35:17 -0800
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101
 Thunderbird/60.5.1
MIME-Version: 1.0
In-Reply-To: <4b41199e-6b4c-d78d-9f3e-044d2ee599b5@infradead.org>
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On 3/8/19 8:04 AM, Randy Dunlap wrote:
> On 3/8/19 12:27 AM, Markus Heiser wrote:
>>
>> Am 08.03.19 um 04:51 schrieb Randy Dunlap:
>>> On 3/7/19 1:11 PM, Tobin C. Harding wrote:
>>>> Current RST file contains an unknown directive causing Sphinx to emit
>>>>
>>>>     ERROR: Unexpected indentation.
>>>>
>>>> Use normal language construct instead.
>>>>
>>>> Signed-off-by: Tobin C. Harding <tobin@kernel.org>
>>>
>>> This is a good idea.  My previous patch eliminated the warning but the
>>> ..hint is not presented very well in the generated output.  :)
>>>
>>> Thanks.
>>>
>>>> ---
>>>>   Documentation/driver-api/dmaengine/dmatest.rst | 4 ++--
>>>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/Documentation/driver-api/dmaengine/dmatest.rst b/Documentation/driver-api/dmaengine/dmatest.rst
>>>> index 8d81f1a7169b..25eecd2769b0 100644
>>>> --- a/Documentation/driver-api/dmaengine/dmatest.rst
>>>> +++ b/Documentation/driver-api/dmaengine/dmatest.rst
>>>> @@ -59,8 +59,8 @@ parameter, that specific channel is requested using the dmaengine and a thread
>>>>   is created with the existing parameters. This thread is set as pending
>>>>   and will be executed once run is set to 1. Any parameters set after the thread
>>>>   is created are not applied.
>>
>>
>> Here a blank line is missed. Thats while '.. hint:' directive is not detected
>> well.  Without the blank line the '.. hint:` string is a part of the section
>> above.
> 
> I added a blank line and the ..hint still is not handled in any special
> manner.  That's why I prefer Tobin's patch.

Nak.  :(
I had looked at the wrong output file.
With my "blank line patch" applied, the ..hint directive does work,
so only the blank line is needed, as Markus said.


>>>> -.. hint::
>>>> -  available channel list could be extracted by running the following command::
>>>> +
>>>> +Hint: available channel list could be extracted by running the following command::
>>>>         % ls -1 /sys/class/dma/
>>
>>   -- Markus --
>>
> 
> 


-- 
~Randy