All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	John Youn <johnyoun@synopsys.com>,
	linux-usb@vger.kernel.org, linux-rpi-kernel@lists.infradead.org,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Oliver Neukum <oneukum@suse.com>
Subject: [PATCH v2 17/22] usb.rst: get rid of some Sphinx errors
Date: Thu, 30 Mar 2017 07:45:51 -0300	[thread overview]
Message-ID: <4c7320e40a69aba397010582e744cf9f53f8ce51.1490870599.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <3068fc7fac09293300b9c59ece0adb985232de12.1490870599.git.mchehab@s-opensource.com>
In-Reply-To: <3068fc7fac09293300b9c59ece0adb985232de12.1490870599.git.mchehab@s-opensource.com>

Get rid of those warnings:

    Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_type".
    Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_dir".
    Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_recip".
    Documentation/driver-api/usb/usb.rst:679: ERROR: Unknown target name: "usbdevfs_urb_type".

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/driver-api/usb/usb.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst
index d15ab8ae5239..5ebaf669704c 100644
--- a/Documentation/driver-api/usb/usb.rst
+++ b/Documentation/driver-api/usb/usb.rst
@@ -615,8 +615,8 @@ USBDEVFS_CONTROL
     The first eight bytes of this structure are the contents of the
     SETUP packet to be sent to the device; see the USB 2.0 specification
     for details. The bRequestType value is composed by combining a
-    USB_TYPE_\* value, a USB_DIR_\* value, and a USB_RECIP_\*
-    value (from *<linux/usb.h>*). If wLength is nonzero, it describes
+    ``USB_TYPE_*`` value, a ``USB_DIR_*`` value, and a ``USB_RECIP_*``
+    value (from ``linux/usb.h``). If wLength is nonzero, it describes
     the length of the data buffer, which is either written to the device
     (USB_DIR_OUT) or read from the device (USB_DIR_IN).
 
@@ -678,7 +678,7 @@ the blocking is separate.
 
 These requests are packaged into a structure that resembles the URB used
 by kernel device drivers. (No POSIX Async I/O support here, sorry.) It
-identifies the endpoint type (USBDEVFS_URB_TYPE_\*), endpoint
+identifies the endpoint type (``USBDEVFS_URB_TYPE_*``), endpoint
 (number, masked with USB_DIR_IN as appropriate), buffer and length,
 and a user "context" value serving to uniquely identify each request.
 (It's usually a pointer to per-request data.) Flags can modify requests
-- 
2.9.3

  parent reply	other threads:[~2017-03-30 10:46 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-30 10:45 [PATCH v2 01/22] tmplcvt: make the tool more robust Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 02/22] driver-api/basics.rst: add device table header Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 03/22] docs-rst: convert usb docbooks to ReST Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 04/22] usb.rst: Enrich its ReST representation Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 05/22] gadget.rst: Enrich its ReST representation and add kernel-doc tag Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 06/22] writing_usb_driver.rst: Enrich its ReST representation Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 07/22] writing_musb_glue_layer.rst: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 08/22] usb/anchors.txt: convert to ReST and add to driver-api book Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 09/22] usb/bulk-streams.txt: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 10/22] usb/callbacks.txt: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 11/22] usb/power-management.txt: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 12/22] usb/dma.txt: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 13/22] error-codes.rst: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 14/22] usb/hotplug.txt: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 15/22] usb/persist.txt: " Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 16/22] usb/URB.txt: convert to ReST and update it Mauro Carvalho Chehab
2017-03-30 10:45 ` Mauro Carvalho Chehab [this message]
2017-03-30 10:45 ` [PATCH v2 18/22] usb: get rid of some ReST doc build errors Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 19/22] usb: composite.h: fix two warnings when building docs Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 20/22] usb: gadget.h: be consistent at kernel doc macros Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 21/22] docs-rst: fix usb cross-references Mauro Carvalho Chehab
2017-03-30 10:45   ` Mauro Carvalho Chehab
2017-03-30 10:45 ` [PATCH v2 22/22] usb: document that URB transfer_buffer should be aligned Mauro Carvalho Chehab
2017-03-30 10:58 ` [PATCH v2 01/22] tmplcvt: make the tool more robust Mauro Carvalho Chehab
2017-03-30 11:45 ` Jani Nikula
2017-04-02 21:32 ` Jonathan Corbet
2017-04-05 13:07   ` Mauro Carvalho Chehab

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=4c7320e40a69aba397010582e744cf9f53f8ce51.1490870599.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=johnyoun@synopsys.com \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-rpi-kernel@lists.infradead.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=mchehab@kernel.org \
    --cc=oneukum@suse.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.