[PATCH] Documentation: usb: gadget: Wrap remaining usage snippets in literal code block

[PATCH] Documentation: usb: gadget: Wrap remaining usage snippets in literal code block

[Bagas Sanjaya]

Several configfs usage snippets forget to be formatted as literal code
blocks. These were outputted in htmldocs output as normal paragraph
instead. In particular, snippet for custom string descriptors as added
in 15a7cf8caabee4 ("usb: gadget: configfs: Support arbitrary string
descriptors") is shown as single combined paragraph, rather than two
command lines.

Wrap them like the rest of snippets.

Fixes: 5e654a4655c3 ("Documentation/usb: gadget_configfs")
Fixes: d80b5005c5dd ("docs: usb: convert documents to ReST")
Fixes: 15a7cf8caabe ("usb: gadget: configfs: Support arbitrary string descriptors")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
This patch is based on Uwe's numbered list indentation patch [1].

[1]: https://lore.kernel.org/linux-doc/20250607224747.3653041-2-u.kleine-koenig@baylibre.com/

Cc: Andrzej Pietrasiewicz <andrzejtp2010@gmail.com>
Cc: Felipe Balbi <balbi@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

 Documentation/usb/gadget_configfs.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/usb/gadget_configfs.rst b/Documentation/usb/gadget_configfs.rst
index f069d2a0d09251..ada57c0e34aa8a 100644
--- a/Documentation/usb/gadget_configfs.rst
+++ b/Documentation/usb/gadget_configfs.rst
@@ -92,7 +92,7 @@ Then the strings can be specified::
 
 Further custom string descriptors can be created as directories within the
 language's directory, with the string text being written to the "s" attribute
-within the string's directory:
+within the string's directory::
 
 	$ mkdir strings/0x409/xu.0
 	$ echo <string text> > strings/0x409/xu.0/s
@@ -104,9 +104,9 @@ string descriptors to associate those strings with class descriptors.
 ------------------------------
 
 Each gadget will consist of a number of configurations, their corresponding
-directories must be created:
+directories must be created::
 
-$ mkdir configs/<name>.<number>
+        $ mkdir configs/<name>.<number>
 
 where <name> can be any string which is legal in a filesystem and the
 <number> is the configuration's number, e.g.::
@@ -246,7 +246,7 @@ a symlink to a function being removed from the configuration, e.g.::
 	...
 	...
 
-Remove strings directories in configurations:
+Remove strings directories in configurations::
 
 	$ rmdir configs/<config name>.<number>/strings/<lang>
 
@@ -270,7 +270,7 @@ e.g.::
 	...
 	...
 
-Remove functions (function modules are not unloaded, though):
+Remove functions (function modules are not unloaded, though)::
 
 	$ rmdir functions/<name>.<instance name>
 
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: usb: gadget: Wrap remaining usage snippets in literal code block

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 857 bytes --]

On Tue, Jun 10, 2025 at 10:17:06AM +0700, Bagas Sanjaya wrote:
> Several configfs usage snippets forget to be formatted as literal code
> blocks. These were outputted in htmldocs output as normal paragraph
> instead. In particular, snippet for custom string descriptors as added
> in 15a7cf8caabee4 ("usb: gadget: configfs: Support arbitrary string
> descriptors") is shown as single combined paragraph, rather than two
> command lines.
> 
> Wrap them like the rest of snippets.
> 
> Fixes: 5e654a4655c3 ("Documentation/usb: gadget_configfs")
> Fixes: d80b5005c5dd ("docs: usb: convert documents to ReST")
> Fixes: 15a7cf8caabe ("usb: gadget: configfs: Support arbitrary string descriptors")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Looks good,

Acked-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com>

Best regards
Uwe

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]