From: Fabio Estevam <festevam@gmail•com>
To: gregkh@linuxfoundation•org
Cc: chunfeng.yun@mediatek•com, sfr@canb•auug.org.au,
stern@rowland•harvard.edu, linux-usb@vger•kernel.org,
linux-next@vger•kernel.org, corbet@lwn•net,
linux-doc@vger•kernel.org, Fabio Estevam <festevam@gmail•com>
Subject: [PATCH v4] usb: Restore the reference to ch9.h
Date: Sun, 25 Apr 2021 12:32:53 -0300 [thread overview]
Message-ID: <20210425153253.2542816-1-festevam@gmail.com> (raw)
Keep the textual reference to ch9.h as it was prior to commit
caa93d9bd2d7 ("usb: Fix up movement of USB core kerneldoc location").
As linux/usb/ch9.h does not contain comments anymore, explain
that drivers/usb/common/common.c includes such header and provides
declarations of a few utilities routines for manipulating the data types
from ch9.h. Also mention that drivers/usb/common/debug.c contains
some functions for creating debug output.
Fixes: caa93d9bd2d7 ("usb: Fix up movement of USB core kerneldoc location")
Reported-by: Alan Stern <stern@rowland•harvard.edu>
Suggested-by: Alan Stern <stern@rowland•harvard.edu>
Acked-by: Alan Stern <stern@rowland•harvard.edu>
Signed-off-by: Fabio Estevam <festevam@gmail•com>
---
Changes since v3:
- Use ``include/linux/usb/ch9.h`` for consistency (Alan)
- Add Alan's Acked-by
Documentation/driver-api/usb/usb.rst | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
index 543e70434da2..820e867af45a 100644
--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -109,16 +109,19 @@ well as to make sure they aren't relying on some HCD-specific behavior.
USB-Standard Types
==================
-In ``drivers/usb/common/common.c`` and ``drivers/usb/common/debug.c`` you
-will find the USB data types defined in chapter 9 of the USB specification.
-These data types are used throughout USB, and in APIs including this host
-side API, gadget APIs, usb character devices and debugfs interfaces.
+In ``include/uapi/linux/usb/ch9.h`` you will find the USB data types defined
+in chapter 9 of the USB specification. These data types are used throughout
+USB, and in APIs including this host side API, gadget APIs, usb character
+devices and debugfs interfaces. That file is itself included by
+``include/linux/usb/ch9.h``, which also contains declarations of a few
+utility routines for manipulating these data types; the implementations
+are in ``drivers/usb/common/common.c``.
.. kernel-doc:: drivers/usb/common/common.c
:export:
-.. kernel-doc:: drivers/usb/common/debug.c
- :export:
+In addition, some functions useful for creating debugging output are
+defined in ``drivers/usb/common/debug.c``.
Host-Side Data Types and Macros
===============================
--
2.25.1
reply other threads:[~2021-04-25 15:33 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20210425153253.2542816-1-festevam@gmail.com \
--to=festevam@gmail$(echo .)com \
--cc=chunfeng.yun@mediatek$(echo .)com \
--cc=corbet@lwn$(echo .)net \
--cc=gregkh@linuxfoundation$(echo .)org \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-next@vger$(echo .)kernel.org \
--cc=linux-usb@vger$(echo .)kernel.org \
--cc=sfr@canb$(echo .)auug.org.au \
--cc=stern@rowland$(echo .)harvard.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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