| Message ID | 20250607224747.3653041-2-u.kleine-koenig@baylibre.com |
|---|---|
| State | New |
| Headers | show |
| Series | docs: usb: gadget: Reindent numbered list | expand |
On Sun, Jun 08, 2025 at 12:47:46AM +0200, Uwe Kleine-König wrote: > diff --git a/Documentation/usb/gadget_configfs.rst b/Documentation/usb/gadget_configfs.rst > index 868e118a2644..f069d2a0d092 100644 > --- a/Documentation/usb/gadget_configfs.rst > +++ b/Documentation/usb/gadget_configfs.rst > @@ -369,18 +369,18 @@ For more information on configfs please see > The concepts described above translate to USB gadgets like this: > > 1. A gadget has its config group, which has some attributes (idVendor, > -idProduct etc) and default sub-groups (configs, functions, strings). > -Writing to the attributes causes the information to be stored in > -appropriate locations. In the configs, functions and strings sub-groups > -a user can create their sub-groups to represent configurations, functions, > -and groups of strings in a given language. > + idProduct etc) and default sub-groups (configs, functions, strings). > + Writing to the attributes causes the information to be stored in appropriate > + locations. In the configs, functions and strings sub-groups a user can > + create their sub-groups to represent configurations, functions, and groups > + of strings in a given language. > > 2. The user creates configurations and functions, in the configurations > -creates symbolic links to functions. This information is used when the > -gadget's UDC attribute is written to, which means binding the gadget > -to the UDC. The code in drivers/usb/gadget/configfs.c iterates over > -all configurations, and in each configuration it iterates over all > -functions and binds them. This way the whole gadget is bound. > + creates symbolic links to functions. This information is used when the > + gadget's UDC attribute is written to, which means binding the gadget to the > + UDC. The code in drivers/usb/gadget/configfs.c iterates over all > + configurations, and in each configuration it iterates over all functions and > + binds them. This way the whole gadget is bound. > > 3. The file drivers/usb/gadget/configfs.c contains code for > > @@ -388,13 +388,12 @@ functions and binds them. This way the whole gadget is bound. > - gadget's default groups (configs, functions, strings) > - associating functions with configurations (symlinks) > > -4. Each USB function naturally has its own view of what it wants > -configured, so config_groups for particular functions are defined > -in the functions implementation files drivers/usb/gadget/f_*.c. > +4. Each USB function naturally has its own view of what it wants configured, so > + config_groups for particular functions are defined in the functions > + implementation files drivers/usb/gadget/f_*.c. > > 5. Function's code is written in such a way that it uses > - > -usb_get_function_instance(), which, in turn, calls request_module. > -So, provided that modprobe works, modules for particular functions > -are loaded automatically. Please note that the converse is not true: > -after a gadget is disabled and torn down, the modules remain loaded. > + usb_get_function_instance(), which, in turn, calls request_module. So, > + provided that modprobe works, modules for particular functions are loaded > + automatically. Please note that the converse is not true: after a gadget is > + disabled and torn down, the modules remain loaded. > Looks good, thanks! Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
diff --git a/Documentation/usb/gadget_configfs.rst b/Documentation/usb/gadget_configfs.rst index 868e118a2644..f069d2a0d092 100644 --- a/Documentation/usb/gadget_configfs.rst +++ b/Documentation/usb/gadget_configfs.rst @@ -369,18 +369,18 @@ For more information on configfs please see The concepts described above translate to USB gadgets like this: 1. A gadget has its config group, which has some attributes (idVendor, -idProduct etc) and default sub-groups (configs, functions, strings). -Writing to the attributes causes the information to be stored in -appropriate locations. In the configs, functions and strings sub-groups -a user can create their sub-groups to represent configurations, functions, -and groups of strings in a given language. + idProduct etc) and default sub-groups (configs, functions, strings). + Writing to the attributes causes the information to be stored in appropriate + locations. In the configs, functions and strings sub-groups a user can + create their sub-groups to represent configurations, functions, and groups + of strings in a given language. 2. The user creates configurations and functions, in the configurations -creates symbolic links to functions. This information is used when the -gadget's UDC attribute is written to, which means binding the gadget -to the UDC. The code in drivers/usb/gadget/configfs.c iterates over -all configurations, and in each configuration it iterates over all -functions and binds them. This way the whole gadget is bound. + creates symbolic links to functions. This information is used when the + gadget's UDC attribute is written to, which means binding the gadget to the + UDC. The code in drivers/usb/gadget/configfs.c iterates over all + configurations, and in each configuration it iterates over all functions and + binds them. This way the whole gadget is bound. 3. The file drivers/usb/gadget/configfs.c contains code for @@ -388,13 +388,12 @@ functions and binds them. This way the whole gadget is bound. - gadget's default groups (configs, functions, strings) - associating functions with configurations (symlinks) -4. Each USB function naturally has its own view of what it wants -configured, so config_groups for particular functions are defined -in the functions implementation files drivers/usb/gadget/f_*.c. +4. Each USB function naturally has its own view of what it wants configured, so + config_groups for particular functions are defined in the functions + implementation files drivers/usb/gadget/f_*.c. 5. Function's code is written in such a way that it uses - -usb_get_function_instance(), which, in turn, calls request_module. -So, provided that modprobe works, modules for particular functions -are loaded automatically. Please note that the converse is not true: -after a gadget is disabled and torn down, the modules remain loaded. + usb_get_function_instance(), which, in turn, calls request_module. So, + provided that modprobe works, modules for particular functions are loaded + automatically. Please note that the converse is not true: after a gadget is + disabled and torn down, the modules remain loaded.
Paragraphs that are part of a numbered list must be indented to render correctly in html. Do that right here. There are only whitespace changes in this patch. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com> --- Hello, not sure this is worth to be backported, so I didn't add a Fixes: line. If you really want, the commit that should have fixed that is probably d80b5005c5dd ("docs: usb: convert documents to ReST"). To see the wrong rendering, look at the numbered list at the end of https://docs.kernel.org/usb/gadget_configfs.html before this patch is applied. There only the paragraphs numbered 3 and 5 are ordered lists (with one item each 🙄). Best regards Uwe Documentation/usb/gadget_configfs.rst | 35 +++++++++++++-------------- 1 file changed, 17 insertions(+), 18 deletions(-) base-commit: e271ed52b344ac02d4581286961d0c40acc54c03