Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: core-api: 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/d967d490b6655735b7df292f88859b5a1b07d0d7.1623824363.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
authored by
Mauro Carvalho Chehab
and committed by
Jonathan Corbet
a822b2ee
6aadf740
+7
-6
+1
-1
Documentation/core-api/bus-virt-phys-mapping.rst
+1
-1
Documentation/core-api/bus-virt-phys-mapping.rst
···
8
8
9
9
The virt_to_bus() and bus_to_virt() functions have been
10
10
superseded by the functionality provided by the PCI DMA interface
11
-
(see :doc:`/core-api/dma-api-howto`). They continue
11
+
(see Documentation/core-api/dma-api-howto.rst). They continue
12
12
to be documented below for historical purposes, but new code
13
13
must not use them. --davidm 00/12/12
14
14
+3
-2
Documentation/core-api/dma-api.rst
+3
-2
Documentation/core-api/dma-api.rst
···
5
5
:Author: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
6
6
7
7
This document describes the DMA API. For a more gentle introduction
8
-
of the API (and actual examples), see :doc:`/core-api/dma-api-howto`.
8
+
of the API (and actual examples), see Documentation/core-api/dma-api-howto.rst.
9
9
10
10
This API is split into two pieces. Part I describes the basic API.
11
11
Part II describes extensions for supporting non-consistent memory
···
479
479
dma_attrs.
480
480
481
481
The interpretation of DMA attributes is architecture-specific, and
482
-
each attribute should be documented in :doc:`/core-api/dma-attributes`.
482
+
each attribute should be documented in
483
+
Documentation/core-api/dma-attributes.rst.
483
484
484
485
If dma_attrs are 0, the semantics of each of these functions
485
486
is identical to those of the corresponding function
+1
-1
Documentation/core-api/dma-isa-lpc.rst
+1
-1
Documentation/core-api/dma-isa-lpc.rst
···
17
17
#include <asm/dma.h>
18
18
19
19
The first is the generic DMA API used to convert virtual addresses to
20
-
bus addresses (see :doc:`/core-api/dma-api` for details).
20
+
bus addresses (see Documentation/core-api/dma-api.rst for details).
21
21
22
22
The second contains the routines specific to ISA DMA transfers. Since
23
23
this is not present on all platforms make sure you construct your
+2
-2
Documentation/core-api/index.rst
+2
-2
Documentation/core-api/index.rst
···
48
48
======================
49
49
50
50
How Linux keeps everything from happening at the same time. See
51
-
:doc:`/locking/index` for more related documentation.
51
+
Documentation/locking/index.rst for more related documentation.
52
52
53
53
.. toctree::
54
54
:maxdepth: 1
···
77
77
=================
78
78
79
79
How to allocate and use memory in the kernel. Note that there is a lot
80
-
more memory-management documentation in :doc:`/vm/index`.
80
+
more memory-management documentation in Documentation/vm/index.rst.
81
81
82
82
.. toctree::
83
83
:maxdepth: 1