From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Bjorn Helgaas <helgaas@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Bjorn Helgaas <bhelgaas@google.com>,
Kishon Vijay Abraham I <kishon@ti.com>,
Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
linux-kernel@vger.kernel.org, linux-pci@vger.kernel.org
Subject: Re: [PATCH 26/34] docs: PCI: endpoint: pci-endpoint-cfs.rst: avoid using ReSt :doc:`foo` markup
Date: Fri, 11 Jun 2021 10:45:07 +0200 [thread overview]
Message-ID: <20210611104507.01bbd489@coco.lan> (raw)
In-Reply-To: <20210610234622.GA2795707@bjorn-Precision-5520>
Em Thu, 10 Jun 2021 18:46:22 -0500
Bjorn Helgaas <helgaas@kernel.org> escreveu:
> 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.
That came from an upstream discussion, mentioned on patch 00/34:
https://lore.kernel.org/linux-doc/871r9k6rmy.fsf@meer.lwn.net/
Basically, using Documentation/.../foo.rst allows some text editors
to navigate directly to the file. Also, there's a preference from
some maintainers to keep the ReST files as close as possible to plain
text.
> 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.
It is more a matter of preference. That's said, there is indeed
an issue with the current builder: when using SPHINXDIRS="book",
doc:`foo` references may not work well. For instance, if one is
building just the driver-api book, a reference like :doc:`../admin-guide/foo`
can't be solved and will produce a warning, plus a bad output.
By using Documentation/admin-guide/foo.rst, it will simply be
displayed as a text without producing any harm.
We discussed in the past about that, but we didn't reach to any
conclusion about the proper way to fix it.
> I do think the pathname in the new text is easier for plain-text
> readers to follow.
Yes.
>
> (What's the correct spelling of "ReSt", BTW? The cover letter has
> "ReST", this patch has "ReSt", wikipedia says "RST, ReST, or reST".)
ReSt was a typo.. sorry for that. I guess the proper way is ReST,
but several places use RST instead. For instance, the conversion
tool pandoc uses "rst" to refer to this format.
>
> But anyway,
>
> Acked-by: Bjorn Helgaas <bhelgaas@google.com>
Thanks!
Mauro
>
> > ---
> > 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
> >
Thanks,
Mauro
next prev parent reply other threads:[~2021-06-11 8:45 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-05 13:17 [PATCH 00/34] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-05 13:18 ` [PATCH 26/34] docs: PCI: endpoint: pci-endpoint-cfs.rst: avoid using ReSt :doc:`foo` markup Mauro Carvalho Chehab
2021-06-10 23:46 ` Bjorn Helgaas
2021-06-11 8:45 ` Mauro Carvalho Chehab [this message]
2021-06-05 13:18 ` [PATCH 27/34] docs: PCI: pci.rst: " Mauro Carvalho Chehab
2021-06-10 23:46 ` Bjorn Helgaas
2021-06-05 13:37 ` [PATCH 00/34] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-05 15:11 ` Nícolas F. R. A. Prado
2021-06-05 19:08 ` Mauro Carvalho Chehab
2021-06-06 22:52 ` Nícolas F. R. A. Prado
2021-06-07 7:34 ` Mauro Carvalho Chehab
2021-06-08 0:34 ` Nícolas F. R. A. Prado
2021-06-08 7:28 ` Mauro Carvalho Chehab
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=20210611104507.01bbd489@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=helgaas@kernel.org \
--cc=kishon@ti.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
/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).