Documentation: usb: gadget: Wrap remaining usage snippets in literal code block
Subsystems (2)
PATCH 1/1 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 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.
---
This patch is based on Uwe's numbered list indentation patch [1].
[1]: https://lore.kernel.org/linux-doc/[email protected]/
Documentation/usb/gadget_configfs.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/usb/gadget_configfs.rst +5 -5
@@ -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>
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 7 lines · 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.
Quoted 6 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 <[email protected]>
Looks good,
Best regards
Uwe