linux-kernel - Re: [PATCH 7/9] docs: Remove unknown 'hint' directive

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <2e8c4224-181e-e107-51b9-86d2f1d41309@darmarit.de>
Date:   Fri, 8 Mar 2019 09:27:26 +0100
From:   Markus Heiser <markus.heiser@...marit.de>
To:     Randy Dunlap <rdunlap@...radead.org>,
        "Tobin C. Harding" <tobin@...nel.org>,
        Jonathan Corbet <corbet@....net>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 7/9] docs: Remove unknown 'hint' directive


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

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