public inbox for linux-usb@vger.kernel.org
 help / color / mirror / Atom feed
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] usb: Restore the reference to ch9.h
Date: Sat, 24 Apr 2021 12:48:23 -0300	[thread overview]
Message-ID: <20210424154823.2489144-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 ch9.h does not have any comments anymore, just remove the kernel-doc
entries entirely.

Fixes: caa93d9bd2d7 ("usb: Fix up movement of USB core kerneldoc location")
Reported-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Fabio Estevam <festevam@gmail.com>
---
This one applies against usb-next.

 Documentation/driver-api/usb/usb.rst | 14 ++++----------
 1 file changed, 4 insertions(+), 10 deletions(-)

diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
index 543e70434da2..251cab7cacd7 100644
--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -109,16 +109,10 @@ 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.
-
-.. kernel-doc:: drivers/usb/common/common.c
-   :export:
-
-.. kernel-doc:: drivers/usb/common/debug.c
-   :export:
+In ``<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.
 
 Host-Side Data Types and Macros
 ===============================
-- 
2.25.1


             reply	other threads:[~2021-04-24 15:48 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-24 15:48 Fabio Estevam [this message]
2021-04-24 16:10 ` [PATCH] usb: Restore the reference to ch9.h Alan Stern

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=20210424154823.2489144-1-festevam@gmail.com \
    --to=festevam@gmail.com \
    --cc=chunfeng.yun@mediatek.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    --cc=stern@rowland.harvard.edu \
    /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