Subject: Re: [PATCH] tools: usb: p9_fwd: wrap USBG shell command examples in literal code blocks

From: Michael Grzeschik <[email-masked]>
Date: Sun, 8 Sep 2024 22:54:42 +0200

Thanks for taking care of this.

On Sun, Sep 08, 2024 at 06:34:23PM +0700, Bagas Sanjaya wrote:
>Stephen Rothwell reported htmldocs warning when merging usb tree:
>
>Documentation/filesystems/9p.rst:99: ERROR: Unexpected indentation.
>
>That's because Sphinx tries rendering p9_fwd.py output as a grid table
>instead.
>
>Wrap shell commands in "USBG Example" section in literal code blocks
>to fix above warning and to be in line with rest of commands in the doc.
>
>Reported-by: Stephen Rothwell <[email-masked]>
>Closes: https://lore.kernel.org/linux-next/[email-masked]/
>Fixes: 673f0c3ffc75 ("tools: usb: p9_fwd: add usb gadget packet forwarder script")
>Signed-off-by: Bagas Sanjaya <[email-masked]>

Acked-by: Michael Grzeschik <[email-masked]>

>---
> Documentation/filesystems/9p.rst | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
>diff --git a/Documentation/filesystems/9p.rst b/Documentation/filesystems/9p.rst
>index 2cc85f3e8659ff..514ed13a0122b0 100644
>--- a/Documentation/filesystems/9p.rst
>+++ b/Documentation/filesystems/9p.rst
>@@ -86,11 +86,11 @@ When using the usbg transport, for now there is no native usb host
> service capable to handle the requests from the gadget driver. For
> this we have to use the extra python tool p9_fwd.py from tools/usb.
>
>-Just start the 9pfs capable network server like diod/nfs-ganesha e.g.:
>+Just start the 9pfs capable network server like diod/nfs-ganesha e.g.::
>
>         $ diod -f -n -d 0 -S -l 0.0.0.0:9999 -e $PWD
>
>-Optionaly scan your bus if there are more then one usbg gadgets to find their path:
>+Optionaly scan your bus if there are more then one usbg gadgets to find their path::
>
>         $ python $kernel_dir/tools/usb/p9_fwd.py list
>
>@@ -99,7 +99,7 @@ Optionaly scan your bus if there are more then one usbg gadgets to find their pa
>           2 |   67 | unknown          | unknown          | 1d6b:0109 | 2-1.1.2
>           2 |   68 | unknown          | unknown          | 1d6b:0109 | 2-1.1.3
>
>-Then start the python transport:
>+Then start the python transport::
>
>         $ python $kernel_dir/tools/usb/p9_fwd.py --path 2-1.1.2 connect -p 9999
>
>
>base-commit: 9c0c11bb87b09a8b7cdc21ca1090e7b36abe9d09
>-- 
>An old man doll... just what I always wanted! - Clara
>
>

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |