public inbox for linux-usb@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Justin Swartz <justin.swartz@risingedge.co.za>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-usb@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: usb: fix literal block marker in usbmon verification example
Date: Sun, 5 Jun 2022 16:40:02 +0700	[thread overview]
Message-ID: <dea883bb-8938-5b07-0a13-92e8029414e8@gmail.com> (raw)
In-Reply-To: <f2943c036e1dd403052dcbd09ac4eeae@risingedge.co.za>

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@gmail.com>

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

  reply	other threads:[~2022-06-05  9:40 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-04 15:54 [PATCH] docs: usb: fix literal block marker in usbmon verification example Justin Swartz
2022-06-05  8:39 ` Bagas Sanjaya
2022-06-05  8:58   ` Justin Swartz
2022-06-05  9:40     ` Bagas Sanjaya [this message]
2022-06-09 15:58 ` Jonathan Corbet

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=dea883bb-8938-5b07-0a13-92e8029414e8@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=justin.swartz@risingedge.co.za \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox