Re: [Linux-kernel-mentees] [PATCH] Doc: Improve format for whatisRCU.rst

Phong Tran
2019-11-05T21:53:12Z

On 11/5/19 11:59 PM, Amol Grover wrote:
> On Sat, Nov 02, 2019 at 06:55:17PM +0700, Phong Tran wrote:
>> Adding crossreference target for some headers, answer of quizzes
>>
>> Signed-off-by: Phong Tran <tranmanphong@gmail.com>
>> ---
>> Documentation/RCU/whatisRCU.rst | 73 +++++++++++++++++++++++----------
>> 1 file changed, 52 insertions(+), 21 deletions(-)
>>
>> diff --git a/Documentation/RCU/whatisRCU.rst b/Documentation/RCU/whatisRCU.rst
>> index 70d0e4c21917..ae40c8bcc56c 100644
>> --- a/Documentation/RCU/whatisRCU.rst
>> +++ b/Documentation/RCU/whatisRCU.rst
>> @@ -1,4 +1,4 @@
>> -.. _rcu_doc:
>> +.. _whatisrcu_doc:
>>
>> What is RCU? -- "Read, Copy, Update"
>> ======================================
>> @@ -27,14 +27,21 @@ the experience has been that different people must take different paths
>> to arrive at an understanding of RCU. This document provides several
>> different paths, as follows:
>>
>> -1. RCU OVERVIEW
>> -2. WHAT IS RCU'S CORE API?
>> -3. WHAT ARE SOME EXAMPLE USES OF CORE RCU API?
>> -4. WHAT IF MY UPDATING THREAD CANNOT BLOCK?
>> -5. WHAT ARE SOME SIMPLE IMPLEMENTATIONS OF RCU?
>> -6. ANALOGY WITH READER-WRITER LOCKING
>> -7. FULL LIST OF RCU APIs
>> -8. ANSWERS TO QUICK QUIZZES
>> +:ref:`1. RCU OVERVIEW <1_whatisRCU>`
>> +
>> +:ref:`2. WHAT IS RCU'S CORE API? <2_whatisRCU>`
>> +
>> +:ref:`3. WHAT ARE SOME EXAMPLE USES OF CORE RCU API? <3_whatisRCU>`
>> +
>> +:ref:`4. WHAT IF MY UPDATING THREAD CANNOT BLOCK? <4_whatisRCU>`
>> +
>> +:ref:`5. WHAT ARE SOME SIMPLE IMPLEMENTATIONS OF RCU? <5_whatisRCU>`
>> +
>> +:ref:`6. ANALOGY WITH READER-WRITER LOCKING <6_whatisRCU>`
>> +
>> +:ref:`7. FULL LIST OF RCU APIs <7_whatisRCU>`
>> +
>> +:ref:`8. ANSWERS TO QUICK QUIZZES <8_whatisRCU>`
>>
>> People who prefer starting with a conceptual overview should focus on
>> Section 1, though most readers will profit by reading this section at
>> @@ -52,6 +59,7 @@ everything, feel free to read the whole thing -- but if you are really
>> that type of person, you have perused the source code and will therefore
>> never need this document anyway. ;-)
>>
>> +.. _1_whatisRCU:
>>
>> 1. RCU OVERVIEW
>> ----------------
>> @@ -120,6 +128,7 @@ So how the heck can a reclaimer tell when a reader is done, given
>> that readers are not doing any sort of synchronization operations???
>> Read on to learn about how RCU's API makes this easy.
>>
>> +.. _2_whatisRCU:
>>
>> 2. WHAT IS RCU'S CORE API?
>> ---------------------------
>> @@ -381,13 +390,15 @@ c. RCU applied to scheduler and interrupt/NMI-handler tasks.
>> Again, most uses will be of (a). The (b) and (c) cases are important
>> for specialized uses, but are relatively uncommon.
>
> Hey,
>
> The changes looks good overall, however a few areas would
> look even better after a bit of formatting.
>
> The API methods text under this section could be converted
> to sub-headings (^^^) for improved readability.
>
> rcu_dereference() sub-section under `Section 2` has 2
> footnotes which could be linked using
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#footnotes
>

Okay, sent out the patch with the suggestions.

https://lkml.org/lkml/2019/11/5/996

Regards,
Phong.