| Message ID | 8697cf945390f6b45fefb4c5fe22ed1c8070e32e.1623824363.git.mchehab+huawei@kernel.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Delegated to: | Bjorn Helgaas |
| Headers | show |
| Series | docs: avoid using ReST :doc:`foo` tag | expand |
On Wed, Jun 16, 2021 at 08:27:37AM +0200, Mauro Carvalho Chehab wrote: > 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> Acked-by: Bjorn Helgaas <bhelgaas@google.com> I do still think it would be nice to have a hint in the commit log about *why* we're doing this. > --- > Documentation/PCI/pci.rst | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst > index 814b40f8360b..fa651e25d98c 100644 > --- a/Documentation/PCI/pci.rst > +++ b/Documentation/PCI/pci.rst > @@ -265,7 +265,7 @@ Set the DMA mask size > --------------------- > .. note:: > If anything below doesn't make sense, please refer to > - :doc:`/core-api/dma-api`. This section is just a reminder that > + Documentation/core-api/dma-api.rst. This section is just a reminder that > drivers need to indicate DMA capabilities of the device and is not > an authoritative source for DMA interfaces. > > @@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are > Setup shared control data > ------------------------- > Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) > -memory. See :doc:`/core-api/dma-api` for a full description of > +memory. See Documentation/core-api/dma-api.rst for a full description of > the DMA APIs. This section is just a reminder that it needs to be done > before enabling DMA on the device. > > @@ -421,7 +421,7 @@ owners if there is one. > > Then clean up "consistent" buffers which contain the control data. > > -See :doc:`/core-api/dma-api` for details on unmapping interfaces. > +See Documentation/core-api/dma-api.rst for details on unmapping interfaces. > > > Unregister from other subsystems > -- > 2.31.1 >
diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst index 814b40f8360b..fa651e25d98c 100644 --- a/Documentation/PCI/pci.rst +++ b/Documentation/PCI/pci.rst @@ -265,7 +265,7 @@ Set the DMA mask size --------------------- .. note:: If anything below doesn't make sense, please refer to - :doc:`/core-api/dma-api`. This section is just a reminder that + Documentation/core-api/dma-api.rst. This section is just a reminder that drivers need to indicate DMA capabilities of the device and is not an authoritative source for DMA interfaces. @@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are Setup shared control data ------------------------- Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) -memory. See :doc:`/core-api/dma-api` for a full description of +memory. See Documentation/core-api/dma-api.rst for a full description of the DMA APIs. This section is just a reminder that it needs to be done before enabling DMA on the device. @@ -421,7 +421,7 @@ owners if there is one. Then clean up "consistent" buffers which contain the control data. -See :doc:`/core-api/dma-api` for details on unmapping interfaces. +See Documentation/core-api/dma-api.rst for details on unmapping interfaces. Unregister from other subsystems
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/PCI/pci.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)