Commit 07335c16 authored by Joel Fernandes (Google)'s avatar Joel Fernandes (Google) Committed by Paul E. McKenney

docs: rcu: Correct links referring to titles

Mauro's auto conversion broken these links, fix them.
Signed-off-by: default avatarJoel Fernandes (Google) <joel@joelfernandes.org>
Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
parent ccc9971e
...@@ -230,15 +230,14 @@ Tree RCU Grace Period Memory Ordering Components ...@@ -230,15 +230,14 @@ Tree RCU Grace Period Memory Ordering Components
Tree RCU's grace-period memory-ordering guarantee is provided by a Tree RCU's grace-period memory-ordering guarantee is provided by a
number of RCU components: number of RCU components:
#. `Callback Registry <#Callback%20Registry>`__ #. `Callback Registry`_
#. `Grace-Period Initialization <#Grace-Period%20Initialization>`__ #. `Grace-Period Initialization`_
#. `Self-Reported Quiescent #. `Self-Reported Quiescent States`_
States <#Self-Reported%20Quiescent%20States>`__ #. `Dynamic Tick Interface`_
#. `Dynamic Tick Interface <#Dynamic%20Tick%20Interface>`__ #. `CPU-Hotplug Interface`_
#. `CPU-Hotplug Interface <#CPU-Hotplug%20Interface>`__ #. `Forcing Quiescent States`_
#. `Forcing Quiescent States <Forcing%20Quiescent%20States>`__ #. `Grace-Period Cleanup`_
#. `Grace-Period Cleanup <Grace-Period%20Cleanup>`__ #. `Callback Invocation`_
#. `Callback Invocation <Callback%20Invocation>`__
Each of the following section looks at the corresponding component in Each of the following section looks at the corresponding component in
detail. detail.
......
...@@ -36,16 +36,14 @@ technologies in interesting new ways. ...@@ -36,16 +36,14 @@ technologies in interesting new ways.
All that aside, here are the categories of currently known RCU All that aside, here are the categories of currently known RCU
requirements: requirements:
#. `Fundamental Requirements <#Fundamental%20Requirements>`__ #. `Fundamental Requirements`_
#. `Fundamental Non-Requirements <#Fundamental%20Non-Requirements>`__ #. `Fundamental Non-Requirements`_
#. `Parallelism Facts of Life <#Parallelism%20Facts%20of%20Life>`__ #. `Parallelism Facts of Life`_
#. `Quality-of-Implementation #. `Quality-of-Implementation Requirements`_
Requirements <#Quality-of-Implementation%20Requirements>`__ #. `Linux Kernel Complications`_
#. `Linux Kernel Complications <#Linux%20Kernel%20Complications>`__ #. `Software-Engineering Requirements`_
#. `Software-Engineering #. `Other RCU Flavors`_
Requirements <#Software-Engineering%20Requirements>`__ #. `Possible Future Changes`_
#. `Other RCU Flavors <#Other%20RCU%20Flavors>`__
#. `Possible Future Changes <#Possible%20Future%20Changes>`__
This is followed by a `summary <#Summary>`__, however, the answers to This is followed by a `summary <#Summary>`__, however, the answers to
each quick quiz immediately follows the quiz. Select the big white space each quick quiz immediately follows the quiz. Select the big white space
...@@ -57,13 +55,11 @@ Fundamental Requirements ...@@ -57,13 +55,11 @@ Fundamental Requirements
RCU's fundamental requirements are the closest thing RCU has to hard RCU's fundamental requirements are the closest thing RCU has to hard
mathematical requirements. These are: mathematical requirements. These are:
#. `Grace-Period Guarantee <#Grace-Period%20Guarantee>`__ #. `Grace-Period Guarantee`_
#. `Publish-Subscribe Guarantee <#Publish-Subscribe%20Guarantee>`__ #. `Publish/Subscribe Guarantee`_
#. `Memory-Barrier Guarantees <#Memory-Barrier%20Guarantees>`__ #. `Memory-Barrier Guarantees`_
#. `RCU Primitives Guaranteed to Execute #. `RCU Primitives Guaranteed to Execute Unconditionally`_
Unconditionally <#RCU%20Primitives%20Guaranteed%20to%20Execute%20Unconditionally>`__ #. `Guaranteed Read-to-Write Upgrade`_
#. `Guaranteed Read-to-Write
Upgrade <#Guaranteed%20Read-to-Write%20Upgrade>`__
Grace-Period Guarantee Grace-Period Guarantee
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
...@@ -689,16 +685,11 @@ infinitely long, however, the following sections list a few ...@@ -689,16 +685,11 @@ infinitely long, however, the following sections list a few
non-guarantees that have caused confusion. Except where otherwise noted, non-guarantees that have caused confusion. Except where otherwise noted,
these non-guarantees were premeditated. these non-guarantees were premeditated.
#. `Readers Impose Minimal #. `Readers Impose Minimal Ordering`_
Ordering <#Readers%20Impose%20Minimal%20Ordering>`__ #. `Readers Do Not Exclude Updaters`_
#. `Readers Do Not Exclude #. `Updaters Only Wait For Old Readers`_
Updaters <#Readers%20Do%20Not%20Exclude%20Updaters>`__ #. `Grace Periods Don't Partition Read-Side Critical Sections`_
#. `Updaters Only Wait For Old #. `Read-Side Critical Sections Don't Partition Grace Periods`_
Readers <#Updaters%20Only%20Wait%20For%20Old%20Readers>`__
#. `Grace Periods Don't Partition Read-Side Critical
Sections <#Grace%20Periods%20Don't%20Partition%20Read-Side%20Critical%20Sections>`__
#. `Read-Side Critical Sections Don't Partition Grace
Periods <#Read-Side%20Critical%20Sections%20Don't%20Partition%20Grace%20Periods>`__
Readers Impose Minimal Ordering Readers Impose Minimal Ordering
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...@@ -1056,11 +1047,11 @@ it would likely be subject to limitations that would make it ...@@ -1056,11 +1047,11 @@ it would likely be subject to limitations that would make it
inappropriate for industrial-strength production use. Classes of inappropriate for industrial-strength production use. Classes of
quality-of-implementation requirements are as follows: quality-of-implementation requirements are as follows:
#. `Specialization <#Specialization>`__ #. `Specialization`_
#. `Performance and Scalability <#Performance%20and%20Scalability>`__ #. `Performance and Scalability`_
#. `Forward Progress <#Forward%20Progress>`__ #. `Forward Progress`_
#. `Composability <#Composability>`__ #. `Composability`_
#. `Corner Cases <#Corner%20Cases>`__ #. `Corner Cases`_
These classes is covered in the following sections. These classes is covered in the following sections.
...@@ -1692,21 +1683,18 @@ The Linux kernel provides an interesting environment for all kinds of ...@@ -1692,21 +1683,18 @@ The Linux kernel provides an interesting environment for all kinds of
software, including RCU. Some of the relevant points of interest are as software, including RCU. Some of the relevant points of interest are as
follows: follows:
#. `Configuration <#Configuration>`__. #. `Configuration`_
#. `Firmware Interface <#Firmware%20Interface>`__. #. `Firmware Interface`_
#. `Early Boot <#Early%20Boot>`__. #. `Early Boot`_
#. `Interrupts and non-maskable interrupts #. `Interrupts and NMIs`_
(NMIs) <#Interrupts%20and%20NMIs>`__. #. `Loadable Modules`_
#. `Loadable Modules <#Loadable%20Modules>`__. #. `Hotplug CPU`_
#. `Hotplug CPU <#Hotplug%20CPU>`__. #. `Scheduler and RCU`_
#. `Scheduler and RCU <#Scheduler%20and%20RCU>`__. #. `Tracing and RCU`_
#. `Tracing and RCU <#Tracing%20and%20RCU>`__. #. `Energy Efficiency`_
#. `Energy Efficiency <#Energy%20Efficiency>`__. #. `Scheduling-Clock Interrupts and RCU`_
#. `Scheduling-Clock Interrupts and #. `Memory Efficiency`_
RCU <#Scheduling-Clock%20Interrupts%20and%20RCU>`__. #. `Performance, Scalability, Response Time, and Reliability`_
#. `Memory Efficiency <#Memory%20Efficiency>`__.
#. `Performance, Scalability, Response Time, and
Reliability <#Performance,%20Scalability,%20Response%20Time,%20and%20Reliability>`__.
This list is probably incomplete, but it does give a feel for the most This list is probably incomplete, but it does give a feel for the most
notable Linux-kernel complications. Each of the following sections notable Linux-kernel complications. Each of the following sections
...@@ -2344,10 +2332,10 @@ implementations, non-preemptible and preemptible. The other four flavors ...@@ -2344,10 +2332,10 @@ implementations, non-preemptible and preemptible. The other four flavors
are listed below, with requirements for each described in a separate are listed below, with requirements for each described in a separate
section. section.
#. `Bottom-Half Flavor (Historical) <#Bottom-Half%20Flavor>`__ #. `Bottom-Half Flavor (Historical)`_
#. `Sched Flavor (Historical) <#Sched%20Flavor>`__ #. `Sched Flavor (Historical)`_
#. `Sleepable RCU <#Sleepable%20RCU>`__ #. `Sleepable RCU`_
#. `Tasks RCU <#Tasks%20RCU>`__ #. `Tasks RCU`_
Bottom-Half Flavor (Historical) Bottom-Half Flavor (Historical)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment