linux-kernel - Re: [PATCH] docs: usb: fix literal block marker in usbmon verification example

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: <dea883bb-8938-5b07-0a13-92e8029414e8@gmail.com>
Date:   Sun, 5 Jun 2022 16:40:02 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Justin Swartz <justin.swartz@...ingedge.co.za>
Cc:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jonathan Corbet <corbet@....net>, linux-usb@...r.kernel.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: usb: fix literal block marker in usbmon
 verification example

On 6/5/22 15:58, Justin Swartz wrote:
> On 2022-06-05 10:39, Bagas Sanjaya wrote:
>> On 6/4/22 22:54, Justin Swartz wrote:
>>> The "Verify that bus sockets are present" example was not properly
>>> formatted due to a typo in the literal block marker.
>>>
>>
>> Missing second colon?
> 
> That is correct.
> 
> 
>>> -Verify that bus sockets are present:
>>> +Verify that bus sockets are present::
>>>
>>>      # ls /sys/kernel/debug/usb/usbmon
>>>      0s  0u  1s  1t  1u  2s  2t  2u  3s  3t  3u  4s  4t  4u
>>
>> Otherwise, the literal block rendered correctly.
> 
> The block is not rendered correctly without the second colon.
> See: https://docs.kernel.org/usb/usbmon.html

Thanks for the explanation.

I mean that for the literal block part, it renders correctly with
the second colon (which this patch is about), so the documentation
error is fixed (although not reported by Sphinx when performing
htmldocs build).

So for this patch, I gave
Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>

-- 
An old man doll... just what I always wanted! - Clara