From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Robin Murphy <robin.murphy@arm.com>,
Tomasz Figa <tfiga@chromium.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 08/29] docs: core-api: avoid using ReST :doc:`foo` markup
Date: Wed, 16 Jun 2021 08:27:23 +0200 [thread overview]
Message-ID: <d967d490b6655735b7df292f88859b5a1b07d0d7.1623824363.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1623824363.git.mchehab+huawei@kernel.org>
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>
---
Documentation/core-api/bus-virt-phys-mapping.rst | 2 +-
Documentation/core-api/dma-api.rst | 5 +++--
Documentation/core-api/dma-isa-lpc.rst | 2 +-
Documentation/core-api/index.rst | 4 ++--
4 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/Documentation/core-api/bus-virt-phys-mapping.rst b/Documentation/core-api/bus-virt-phys-mapping.rst
index c7bc99cd2e21..c72b24a7d52c 100644
--- a/Documentation/core-api/bus-virt-phys-mapping.rst
+++ b/Documentation/core-api/bus-virt-phys-mapping.rst
@@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers
The virt_to_bus() and bus_to_virt() functions have been
superseded by the functionality provided by the PCI DMA interface
- (see :doc:`/core-api/dma-api-howto`). They continue
+ (see Documentation/core-api/dma-api-howto.rst). They continue
to be documented below for historical purposes, but new code
must not use them. --davidm 00/12/12
diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst
index 00a1d4fa3f9e..6d6d0edd2d27 100644
--- a/Documentation/core-api/dma-api.rst
+++ b/Documentation/core-api/dma-api.rst
@@ -5,7 +5,7 @@ Dynamic DMA mapping using the generic device
:Author: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
This document describes the DMA API. For a more gentle introduction
-of the API (and actual examples), see :doc:`/core-api/dma-api-howto`.
+of the API (and actual examples), see Documentation/core-api/dma-api-howto.rst.
This API is split into two pieces. Part I describes the basic API.
Part II describes extensions for supporting non-consistent memory
@@ -479,7 +479,8 @@ without the _attrs suffixes, except that they pass an optional
dma_attrs.
The interpretation of DMA attributes is architecture-specific, and
-each attribute should be documented in :doc:`/core-api/dma-attributes`.
+each attribute should be documented in
+Documentation/core-api/dma-attributes.rst.
If dma_attrs are 0, the semantics of each of these functions
is identical to those of the corresponding function
diff --git a/Documentation/core-api/dma-isa-lpc.rst b/Documentation/core-api/dma-isa-lpc.rst
index e59a3d35a93d..17b193603f0a 100644
--- a/Documentation/core-api/dma-isa-lpc.rst
+++ b/Documentation/core-api/dma-isa-lpc.rst
@@ -17,7 +17,7 @@ To do ISA style DMA you need to include two headers::
#include <asm/dma.h>
The first is the generic DMA API used to convert virtual addresses to
-bus addresses (see :doc:`/core-api/dma-api` for details).
+bus addresses (see Documentation/core-api/dma-api.rst for details).
The second contains the routines specific to ISA DMA transfers. Since
this is not present on all platforms make sure you construct your
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index f1c9d20bd42d..5de2c7a4b1b3 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -48,7 +48,7 @@ Concurrency primitives
======================
How Linux keeps everything from happening at the same time. See
-:doc:`/locking/index` for more related documentation.
+Documentation/locking/index.rst for more related documentation.
.. toctree::
:maxdepth: 1
@@ -77,7 +77,7 @@ Memory management
=================
How to allocate and use memory in the kernel. Note that there is a lot
-more memory-management documentation in :doc:`/vm/index`.
+more memory-management documentation in Documentation/vm/index.rst.
.. toctree::
:maxdepth: 1
--
2.31.1
next prev parent reply other threads:[~2021-06-16 6:28 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-16 6:27 [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 01/29] docs: devices.rst: better reference documentation docs Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 02/29] docs: dev-tools: kunit: don't use a table for docs name Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 03/29] docs: admin-guide: pm: avoid using ReST :doc:`foo` markup Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 04/29] docs: admin-guide: hw-vuln: " Mauro Carvalho Chehab
2021-06-16 18:21 ` mark gross
2021-06-16 20:21 ` Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 05/29] docs: admin-guide: sysctl: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 06/29] docs: block: biodoc.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 07/29] docs: bpf: bpf_lsm.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` Mauro Carvalho Chehab [this message]
2021-06-16 6:27 ` [PATCH v2 09/29] docs: dev-tools: testing-overview.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 10/29] docs: dev-tools: kunit: " Mauro Carvalho Chehab
2021-06-25 21:27 ` Brendan Higgins
2021-06-25 22:12 ` Jonathan Corbet
2021-06-16 6:27 ` [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 22:08 ` Rob Herring
2021-06-17 6:38 ` Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 12/29] docs: doc-guide: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 13/29] docs: driver-api: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 14/29] docs: driver-api: gpio: using-gpio.rst: " Mauro Carvalho Chehab
2021-06-25 10:37 ` Bartosz Golaszewski
2021-06-16 6:27 ` [PATCH v2 15/29] docs: driver-api: surface_aggregator: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 16/29] docs: driver-api: usb: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 17/29] docs: firmware-guide: acpi: " Mauro Carvalho Chehab
2021-06-16 6:55 ` Sakari Ailus
2021-06-16 6:27 ` [PATCH v2 18/29] docs: i2c: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 19/29] docs: kernel-hacking: hacking.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 20/29] docs: networking: devlink: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 21/29] docs: PCI: endpoint: pci-endpoint-cfs.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 22/29] docs: PCI: pci.rst: " Mauro Carvalho Chehab
2021-06-16 14:17 ` Bjorn Helgaas
2021-06-16 6:27 ` [PATCH v2 23/29] docs: process: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 24/29] docs: security: landlock.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 25/29] docs: trace: coresight: coresight.rst: " Mauro Carvalho Chehab
2021-06-17 15:03 ` Mathieu Poirier
2021-06-16 6:27 ` [PATCH v2 26/29] docs: trace: ftrace.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 27/29] docs: userspace-api: landlock.rst: " Mauro Carvalho Chehab
2021-06-23 12:26 ` Mickaël Salaün
2021-06-16 6:27 ` [PATCH v2 28/29] docs: virt: kvm: s390-pv-boot.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 29/29] docs: x86: " Mauro Carvalho Chehab
2021-06-17 19:34 ` [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Jonathan Corbet
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=d967d490b6655735b7df292f88859b5a1b07d0d7.1623824363.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=daniel@iogearbox.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=robin.murphy@arm.com \
--cc=tfiga@chromium.org \
/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;
as well as URLs for NNTP newsgroup(s).