| Message ID | 20220604155431.23246-1-justin.swartz@risingedge.co.za |
|---|---|
| State | New |
| Headers | show |
| Series | docs: usb: fix literal block marker in usbmon verification example | expand |
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? iff --git a/Documentation/usb/usbmon.rst b/Documentation/usb/usbmon.rst > index b0bd51080..6d5ec1e62 100644 > --- a/Documentation/usb/usbmon.rst > +++ b/Documentation/usb/usbmon.rst > @@ -42,7 +42,7 @@ if usbmon is built into the kernel:: > # modprobe usbmon > # > > -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. Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
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>
Justin Swartz <justin.swartz@risingedge.co.za> writes: > The "Verify that bus sockets are present" example was not properly > formatted due to a typo in the literal block marker. > > Signed-off-by: Justin Swartz <justin.swartz@risingedge.co.za> > --- > Documentation/usb/usbmon.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/usb/usbmon.rst b/Documentation/usb/usbmon.rst > index b0bd51080..6d5ec1e62 100644 > --- a/Documentation/usb/usbmon.rst > +++ b/Documentation/usb/usbmon.rst > @@ -42,7 +42,7 @@ if usbmon is built into the kernel:: > # modprobe usbmon > # > > -Verify that bus sockets are present: > +Verify that bus sockets are present:: > Applied, thanks. jon
diff --git a/Documentation/usb/usbmon.rst b/Documentation/usb/usbmon.rst index b0bd51080..6d5ec1e62 100644 --- a/Documentation/usb/usbmon.rst +++ b/Documentation/usb/usbmon.rst @@ -42,7 +42,7 @@ if usbmon is built into the kernel:: # modprobe usbmon # -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
The "Verify that bus sockets are present" example was not properly formatted due to a typo in the literal block marker. Signed-off-by: Justin Swartz <justin.swartz@risingedge.co.za> --- Documentation/usb/usbmon.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)