Commit 58992bf3 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Greg Kroah-Hartman
Browse files

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



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 15a7cf8c ("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: 5e654a46 ("Documentation/usb: gadget_configfs")
Fixes: d80b5005 ("docs: usb: convert documents to ReST")
Fixes: 15a7cf8c ("usb: gadget: configfs: Support arbitrary string descriptors")
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Acked-by: default avatarUwe Kleine-König <u.kleine-koenig@baylibre.com>
Link: https://lore.kernel.org/r/20250610031705.32774-2-bagasdotme@gmail.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 41edd08b

Documentation/usb/gadget_configfs.rst

+5 −5
Original line number Diff line number Diff line
@@ -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,7 +104,7 @@ 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>
@@ -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>