mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-28 15:13:55 +08:00
4f8af077a0
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: |
||
|---|---|---|
| .. | ||
| Design | ||
| arrayRCU.rst | ||
| checklist.rst | ||
| index.rst | ||
| listRCU.rst | ||
| lockdep-splat.rst | ||
| lockdep.rst | ||
| NMI-RCU.rst | ||
| rcu_dereference.rst | ||
| rcu.rst | ||
| rcubarrier.rst | ||
| rculist_nulls.rst | ||
| rcuref.rst | ||
| RTFP.txt | ||
| stallwarn.rst | ||
| torture.rst | ||
| UP.rst | ||
| whatisRCU.rst | ||