linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: "Uwe Kleine-König" <u.kleine-koenig@baylibre.com>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Jonathan Corbet" <corbet@lwn.net>
Cc: linux-usb@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: usb: gadget: Reindent numbered list
Date: Tue, 10 Jun 2025 07:57:03 +0700	[thread overview]
Message-ID: <aEeC33xHpqh2qoEw@archie.me> (raw)
In-Reply-To: <20250607224747.3653041-2-u.kleine-koenig@baylibre.com>

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

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>

-- 
An old man doll... just what I always wanted! - Clara

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

      reply	other threads:[~2025-06-10  0:57 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-07 22:47 [PATCH] docs: usb: gadget: Reindent numbered list Uwe Kleine-König
2025-06-10  0:57 ` Bagas Sanjaya [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aEeC33xHpqh2qoEw@archie.me \
    --to=bagasdotme@gmail.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=u.kleine-koenig@baylibre.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).