Skip to content

Commit ab8e8da

Browse files
mchehabJonathan Corbet
authored andcommitted
docs: driver-api: usb: avoid using ReST :doc:foo markup
The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/2cd2dc3e6bacde587aeb09a3951594cfb0102014.1623824363.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
1 parent bbbaf22 commit ab8e8da

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

  • Documentation/driver-api/usb

Documentation/driver-api/usb/dma.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ API overview
1010

1111
The big picture is that USB drivers can continue to ignore most DMA issues,
1212
though they still must provide DMA-ready buffers (see
13-
:doc:`/core-api/dma-api-howto`). That's how they've worked through
13+
Documentation/core-api/dma-api-howto.rst). That's how they've worked through
1414
the 2.4 (and earlier) kernels, or they can now be DMA-aware.
1515

1616
DMA-aware usb drivers:
@@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties.
6060
force a consistent memory access ordering by using memory barriers. It's
6161
not using a streaming DMA mapping, so it's good for small transfers on
6262
systems where the I/O would otherwise thrash an IOMMU mapping. (See
63-
:doc:`/core-api/dma-api-howto` for definitions of "coherent" and
63+
Documentation/core-api/dma-api-howto.rst for definitions of "coherent" and
6464
"streaming" DMA mappings.)
6565

6666
Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
@@ -91,7 +91,7 @@ Working with existing buffers
9191
Existing buffers aren't usable for DMA without first being mapped into the
9292
DMA address space of the device. However, most buffers passed to your
9393
driver can safely be used with such DMA mapping. (See the first section
94-
of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?")
94+
of Documentation/core-api/dma-api-howto.rst, titled "What memory is DMA-able?")
9595

9696
- When you're using scatterlists, you can map everything at once. On some
9797
systems, this kicks in an IOMMU and turns the scatterlists into single

0 commit comments

Comments
 (0)