linux-stable/Documentation/RCU
Nícolas F. R. A. Prado 4f8af077a0 docs: Fix reST markup when linking to sections
During the process of converting the documentation to reST, some links
were converted using the following wrong syntax (and sometimes using %20
instead of spaces):

   `Display text <#section-name-in-html>`__

This syntax isn't valid according to the docutils' spec [1], but more
importantly, it is specific to HTML, since it uses '#' to link to an
HTML anchor.

The right syntax would instead use a docutils hyperlink reference as the
embedded URI to point to the section [2], that is:

   `Display text <Section Name_>`__

This syntax works in both HTML and PDF.

The LaTeX toolchain doesn't mind the HTML anchor syntax when generating
the pdf documentation (make pdfdocs), that is, the build succeeds but
the links don't work, but that syntax causes errors when trying to build
using the not-yet-merged rst2pdf:

   ValueError: format not resolved, probably missing URL scheme or undefined destination target for 'Forcing%20Quiescent%20States'

So, use the correct syntax in order to have it work in all different
output formats.

[1]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#reference-names
[2]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#embedded-uris-and-aliases

Fixes: ccc9971e21 ("docs: rcu: convert some articles from html to ReST")
Fixes: c8cce10a62 ("docs: Fix the reference labels in Locking.rst")
Fixes: e548cdeffc ("docs-rst: convert kernel-locking to ReST")
Fixes: 7ddedebb03 ("ALSA: doc: ReSTize writing-an-alsa-driver document")
Signed-off-by: Nícolas F. R. A. Prado <nfraprado@protonmail.com>
Reviewed-by: Takashi Iwai <tiwai@suse.de>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/20201228144537.135353-1-nfraprado@protonmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-12-31 15:44:47 -07:00
..
Design docs: Fix reST markup when linking to sections 2020-12-31 15:44:47 -07:00
arrayRCU.rst doc: Convert arrayRCU.txt to arrayRCU.rst 2019-12-10 18:51:19 -08:00
checklist.rst doc: Present the role of READ_ONCE() 2020-11-02 17:07:15 -08:00
index.rst docs: RCU: Convert stallwarn.txt to ReST 2020-06-29 11:58:11 -07:00
listRCU.rst doc/RCU/listRCU: Update example function name 2020-02-27 07:03:13 -08:00
lockdep-splat.rst docs: RCU: Convert lockdep-splat.txt to ReST 2020-06-29 11:58:10 -07:00
lockdep.rst docs: Fix function name trailing double-()s 2020-08-24 17:19:07 -06:00
NMI-RCU.rst doc: Converted NMI-RCU.txt to NMI-RCU.rst. 2019-12-10 18:51:52 -08:00
rcu.rst doc/RCU/rcu: Use https instead of http if possible 2020-02-27 07:03:13 -08:00
rcu_dereference.rst doc: Present the role of READ_ONCE() 2020-11-02 17:07:15 -08:00
rcubarrier.rst doc: Convert to rcubarrier.txt to ReST 2019-12-10 18:51:53 -08:00
rculist_nulls.rst docs: RCU: Don't duplicate chapter names in rculist_nulls.rst 2020-06-29 11:58:11 -07:00
rcuref.rst docs: RCU: Convert rcuref.txt to ReST 2020-06-29 11:58:11 -07:00
RTFP.txt
stallwarn.rst doc: Timer problems can cause RCU CPU stall warnings 2020-06-29 11:58:11 -07:00
torture.rst docs: RCU: Convert torture.txt to ReST 2020-06-29 11:58:11 -07:00
UP.rst doc: RCU callback locks need only _bh, not necessarily _irq 2019-06-28 09:10:40 -06:00
whatisRCU.rst docs/rcu: Update the call_rcu() API 2020-11-06 17:02:43 -08:00