Re: [PATCH 7/9] docs: Remove unknown 'hint' directive
From: Randy Dunlap
Date: Fri Mar 08 2019 - 11:04:43 EST
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@xxxxxxxxxx>
>> This is a good idea.Â My previous patch eliminated the warning but the
>> ..hint is not presented very well in the generated output.Â :)
>>> Â 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
I added a blank line and the ..hint still is not handled in any special
manner. That's why I prefer Tobin's patch.
>>> -.. 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 --