| Date | Thu, 10 Jun 2021 18:46:22 -0500 | From | Bjorn Helgaas <> | Subject | Re: [PATCH 26/34] docs: PCI: endpoint: pci-endpoint-cfs.rst: avoid using ReSt :doc:`foo` markup |
| |
On Sat, Jun 05, 2021 at 03:18:25PM +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>
It'd be nice to know why we're doing this and what the benefit is.
Maybe if you know more about ReSt, it's obvious that using :doc:`foo` is wrong and produces the wrong output or something. But I don't know.
I do think the pathname in the new text is easier for plain-text readers to follow.
(What's the correct spelling of "ReSt", BTW? The cover letter has "ReST", this patch has "ReSt", wikipedia says "RST, ReST, or reST".)
But anyway,
Acked-by: Bjorn Helgaas <bhelgaas@google.com>
> --- > Documentation/PCI/endpoint/pci-endpoint-cfs.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/PCI/endpoint/pci-endpoint-cfs.rst b/Documentation/PCI/endpoint/pci-endpoint-cfs.rst > index 696f8eeb4738..db609b97ad58 100644 > --- a/Documentation/PCI/endpoint/pci-endpoint-cfs.rst > +++ b/Documentation/PCI/endpoint/pci-endpoint-cfs.rst > @@ -125,4 +125,4 @@ all the EPF devices are created and linked with the EPC device. > | interrupt_pin > | function > > -[1] :doc:`pci-endpoint` > +[1] Documentation/PCI/endpoint/pci-endpoint.rst > -- > 2.31.1 >
|