All of lore.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
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
Subject: Re: [PATCH 7/9] docs: Remove unknown 'hint' directive
Date: Fri, 8 Mar 2019 08:35:17 -0800	[thread overview]
Message-ID: <8ca3ea67-c4aa-dc06-fb21-0c5c58a09669@infradead.org> (raw)
In-Reply-To: <4b41199e-6b4c-d78d-9f3e-044d2ee599b5@infradead.org>

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

  reply	other threads:[~2019-03-08 16:35 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-07 21:11 [PATCH 0/9] docs: Fix various build warnings/errors Tobin C. Harding
2019-03-07 21:11 ` [PATCH 1/9] docs: Fix spelling mistake Tobin C. Harding
2019-03-07 21:11 ` [PATCH 2/9] docs: Add colon clearing sphinx warning Tobin C. Harding
2019-03-07 21:11 ` [PATCH 3/9] docs: Remove unnecessary reference link title Tobin C. Harding
2019-03-07 21:11 ` [PATCH 4/9] docs: Use reference to link to rst file Tobin C. Harding
2019-03-07 21:11 ` [PATCH 5/9] docs: Replace backtick with apostrophe Tobin C. Harding
2019-03-08  3:35   ` Randy Dunlap
2019-03-07 21:11 ` [PATCH 6/9] docs: Use correct list markup character Tobin C. Harding
2019-03-08  3:40   ` Randy Dunlap
2019-03-08  4:58     ` Tobin C. Harding
2019-03-07 21:11 ` [PATCH 7/9] docs: Remove unknown 'hint' directive Tobin C. Harding
2019-03-08  3:51   ` Randy Dunlap
2019-03-08  8:27     ` Markus Heiser
2019-03-08 16:04       ` Randy Dunlap
2019-03-08 16:35         ` Randy Dunlap [this message]
2019-03-07 21:11 ` [PATCH 8/9] docs: Fix Title underline too short warning Tobin C. Harding
2019-03-08  3:42   ` Randy Dunlap
2019-03-08  4:57     ` Tobin C. Harding
2019-03-07 21:11 ` [PATCH 9/9] docs: Add blank line after SPDX licence identifier Tobin C. Harding
2019-03-08  3:43   ` Randy Dunlap
2019-03-08  8:40 ` [PATCH 0/9] docs: Fix various build warnings/errors Markus Heiser
2019-03-08 20:16   ` Tobin C. Harding
2019-03-09  9:20     ` Markus Heiser
2019-03-25 16:33 ` Jonathan Corbet
2019-03-25 21:59   ` Tobin C. Harding

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8ca3ea67-c4aa-dc06-fb21-0c5c58a09669@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=tobin@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.