Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1530091 > unrolled thread

[PATCH v2 0/4] core-api ReST: assoc_array, atomic_ops, local_ops

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  [PATCH v2 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 11:10 +0100
    [PATCH v3 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
      [PATCH v3 4/4] firmware: remove warning at documentation generation time Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
        Re: [PATCH v3 4/4] firmware: remove warning at documentation  generation time Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-25 22:00 +0100
          Re: [PATCH v3 4/4] firmware: remove warning at documentation  generation time "Luis R. Rodriguez" <mcgrof@kernel.org> - 2016-12-01 17:20 +0100
            Re: [PATCH v3 4/4] firmware: remove warning at documentation  generation time Greg Kroah-Hartman <gregkh@linuxfoundation.org> - 2016-12-01 17:50 +0100
      [PATCH v3 3/4] Documentation/local_ops.txt: convert to ReST markup Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
        Re: [PATCH v3 3/4] Documentation/local_ops.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-25 22:20 +0100
      [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
        Re: [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-25 22:00 +0100
      Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-25 23:00 +0100
        Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup "S. Fricke" <silvio.fricke@gmail.com> - 2016-11-27 16:00 +0100
          Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-27 19:40 +0100
        Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Jonathan Corbet <corbet@lwn.net> - 2016-11-28 01:00 +0100
          Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 08:30 +0100
            Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Daniel Vetter <daniel@ffwll.ch> - 2016-11-28 09:50 +0100
              Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 11:30 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-28 12:10 +0100
                  Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 13:00 +0100
                    Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Daniel Vetter <daniel@ffwll.ch> - 2016-11-28 14:50 +0100
                      Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-28 16:20 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-28 12:20 +0100
                  Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 13:00 +0100
                    Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-28 13:40 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Daniel Vetter <daniel@ffwll.ch> - 2016-11-28 15:20 +0100
                  Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Jonathan Corbet <corbet@lwn.net> - 2016-11-28 15:30 +0100
      [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-28 18:40 +0100
        [PATCH v4 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-28 18:40 +0100
        Re: [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops,  local_ops Jonathan Corbet <corbet@lwn.net> - 2016-12-01 02:00 +0100
          Re: [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops, local_ops "Luis R. Rodriguez" <mcgrof@kernel.org> - 2016-12-01 17:00 +0100

Page 1 of 2  [1] 2  Next page →

#1530091 — [PATCH v2 0/4] core-api ReST: assoc_array, atomic_ops, local_ops

Hi,

Some more ReSTification of core-api's: assoc_array, atomic_ops and local_ops. A
fourth patch removes a warning about a bullet list without ending at
firmware_class.c

v1 -> v2
* use format-patch with a rename_threshold of 10%, no other changes

Thanks for review.

BR
Silvio

Silvio Fricke (4):
  Documentation/assoc_array.txt: convert to ReST markup
  Documentation/atomic_ops.txt: convert to ReST markup
  Documentation/local_ops.txt: convert to ReST markup
  firmware: remove warning at documentation generation time

 Documentation/assoc_array.txt => Documentation/core-api/assoc_array.rst | 617 ++++++++++++++++++++++++++++--------------------------------
 Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst   | 745 +++++++++++++++++++++++++++++++++++++-----------------------------------
 Documentation/core-api/index.rst                                        |   3 +-
 Documentation/local_ops.txt => Documentation/core-api/local_ops.rst     | 275 ++++++++++++++-------------
 Documentation/process/volatile-considered-harmful.rst                   |   3 +-
 drivers/base/firmware_class.c                                           |   6 +-
 6 files changed, 838 insertions(+), 811 deletions(-)

base-commit: 9c240d757658a3ae9968dd309e674c61f07c7f48
-- 
git-series 0.9.1

[toc] | [next] | [standalone]

#1530314 — [PATCH v3 0/4] core-api ReST: assoc_array, atomic_ops, local_ops

Hi,

Thanks Mauro and Jani for reviewing.

Some more ReSTification of core-api's: assoc_array, atomic_ops and local_ops. A
fourth patch removes a warning about a bullet list without ending at
firmware_class.c

v2 -> v3
* change ". ::" to "::"
* replace all "code-blocks" with "::"
* add two ".. notes" declaration in atomic_ops.rst

v1 -> v2
* use format-patch with a rename_threshold of 10%, no other changes

Thanks for review.

BR
Silvio

Silvio Fricke (4):
  Documentation/assoc_array.txt: convert to ReST markup
  Documentation/atomic_ops.txt: convert to ReST markup
  Documentation/local_ops.txt: convert to ReST markup
  firmware: remove warning at documentation generation time

 Documentation/assoc_array.txt => Documentation/core-api/assoc_array.rst | 639 ++++++++++++++++++++++++++++-------------------------------
 Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst   | 777 +++++++++++++++++++++++++++++++++++++-----------------------------------
 Documentation/core-api/index.rst                                        |   3 +-
 Documentation/local_ops.txt => Documentation/core-api/local_ops.rst     | 273 +++++++++++++------------
 Documentation/process/volatile-considered-harmful.rst                   |   3 +-
 drivers/base/firmware_class.c                                           |   6 +-
 6 files changed, 861 insertions(+), 840 deletions(-)

base-commit: 9c240d757658a3ae9968dd309e674c61f07c7f48
-- 
git-series 0.9.1

[toc] | [prev] | [next] | [standalone]

#1530316 — [PATCH v3 4/4] firmware: remove warning at documentation generation time

This patch removes following error at for `make htmldocs`. No functional
change.

	./drivers/base/firmware_class.c:1348: WARNING: Bullet list ends without a blank line; unexpected unindent.

Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
---
 drivers/base/firmware_class.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/base/firmware_class.c b/drivers/base/firmware_class.c
index 22d1760..37b0221 100644
--- a/drivers/base/firmware_class.c
+++ b/drivers/base/firmware_class.c
@@ -1345,9 +1345,9 @@ static void request_firmware_work_func(struct work_struct *work)
  *
  *	Asynchronous variant of request_firmware() for user contexts:
  *		- sleep for as small periods as possible since it may
- *		increase kernel boot time of built-in device drivers
- *		requesting firmware in their ->probe() methods, if
- *		@gfp is GFP_KERNEL.
+ *		  increase kernel boot time of built-in device drivers
+ *		  requesting firmware in their ->probe() methods, if
+ *		  @gfp is GFP_KERNEL.
  *
  *		- can't sleep at all if @gfp is GFP_ATOMIC.
  **/
-- 
git-series 0.9.1

[toc] | [prev] | [next] | [standalone]

#1530525 — Re: [PATCH v3 4/4] firmware: remove warning at documentation generation time

Em Fri, 25 Nov 2016 15:59:47 +0100
Silvio Fricke <silvio.fricke@gmail.com> escreveu:

> This patch removes following error at for `make htmldocs`. No functional
> change.
> 
> 	./drivers/base/firmware_class.c:1348: WARNING: Bullet list ends without a blank line; unexpected unindent.
> 
> Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>

Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> ---
>  drivers/base/firmware_class.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/base/firmware_class.c b/drivers/base/firmware_class.c
> index 22d1760..37b0221 100644
> --- a/drivers/base/firmware_class.c
> +++ b/drivers/base/firmware_class.c
> @@ -1345,9 +1345,9 @@ static void request_firmware_work_func(struct work_struct *work)
>   *
>   *	Asynchronous variant of request_firmware() for user contexts:
>   *		- sleep for as small periods as possible since it may
> - *		increase kernel boot time of built-in device drivers
> - *		requesting firmware in their ->probe() methods, if
> - *		@gfp is GFP_KERNEL.
> + *		  increase kernel boot time of built-in device drivers
> + *		  requesting firmware in their ->probe() methods, if
> + *		  @gfp is GFP_KERNEL.
>   *
>   *		- can't sleep at all if @gfp is GFP_ATOMIC.
>   **/



Thanks,
Mauro

[toc] | [prev] | [next] | [standalone]

#1534248 — Re: [PATCH v3 4/4] firmware: remove warning at documentation generation time

On Fri, Nov 25, 2016 at 06:50:32PM -0200, Mauro Carvalho Chehab wrote:
> Em Fri, 25 Nov 2016 15:59:47 +0100
> Silvio Fricke <silvio.fricke@gmail.com> escreveu:
> 
> > This patch removes following error at for `make htmldocs`. No functional
> > change.
> > 
> > 	./drivers/base/firmware_class.c:1348: WARNING: Bullet list ends without a blank line; unexpected unindent.
> > 
> > Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
> 
> Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Acked-by: Luis R. Rodriguez <mcgrof@kernel.org>

Jonathan,

firmware_class changes have been lately going through Greg's tree, he has a few
more pending changes on his driver-core-next branch for firmware_class but this
patch not create a conflict. It can go in first or later as such its
technically fine for it to go either through your tree or Greg's tree.

I'll let Greg decide. I've bounced him a copy of the patch.

  Luis

[toc] | [prev] | [next] | [standalone]

#1534279 — Re: [PATCH v3 4/4] firmware: remove warning at documentation generation time

On Thu, Dec 01, 2016 at 05:11:54PM +0100, Luis R. Rodriguez wrote:
> On Fri, Nov 25, 2016 at 06:50:32PM -0200, Mauro Carvalho Chehab wrote:
> > Em Fri, 25 Nov 2016 15:59:47 +0100
> > Silvio Fricke <silvio.fricke@gmail.com> escreveu:
> > 
> > > This patch removes following error at for `make htmldocs`. No functional
> > > change.
> > > 
> > > 	./drivers/base/firmware_class.c:1348: WARNING: Bullet list ends without a blank line; unexpected unindent.
> > > 
> > > Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
> > 
> > Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> 
> Acked-by: Luis R. Rodriguez <mcgrof@kernel.org>
> 
> Jonathan,
> 
> firmware_class changes have been lately going through Greg's tree, he has a few
> more pending changes on his driver-core-next branch for firmware_class but this
> patch not create a conflict. It can go in first or later as such its
> technically fine for it to go either through your tree or Greg's tree.
> 
> I'll let Greg decide. I've bounced him a copy of the patch.

I can just take this one in my tree as it's easy to merge as-is.

thanks,

greg k-h

[toc] | [prev] | [next] | [standalone]

#1530317 — [PATCH v3 3/4] Documentation/local_ops.txt: convert to ReST markup

... and move to core-api folder.

Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
---
 Documentation/core-api/index.rst                                    |   1 +-
 Documentation/local_ops.txt => Documentation/core-api/local_ops.rst | 273 +++----
 2 files changed, 145 insertions(+), 129 deletions(-)

diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index f3e5f5e..25b4e4a 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -9,6 +9,7 @@ Kernel and driver related documentation.
 
    assoc_array
    atomic_ops
+   local_ops
    workqueue
 
 .. only::  subproject
diff --git a/Documentation/local_ops.txt b/Documentation/core-api/local_ops.rst
similarity index 57%
rename from Documentation/local_ops.txt
rename to Documentation/core-api/local_ops.rst
index 407576a..1062ddb 100644
--- a/Documentation/local_ops.txt
+++ b/Documentation/core-api/local_ops.rst
@@ -1,191 +1,206 @@
-	     Semantics and Behavior of Local Atomic Operations
 
-			    Mathieu Desnoyers
+.. _local_ops:
 
+=================================================
+Semantics and Behavior of Local Atomic Operations
+=================================================
 
-	This document explains the purpose of the local atomic operations, how
+:Author: Mathieu Desnoyers
+
+
+This document explains the purpose of the local atomic operations, how
 to implement them for any given architecture and shows how they can be used
 properly. It also stresses on the precautions that must be taken when reading
 those local variables across CPUs when the order of memory writes matters.
 
-Note that local_t based operations are not recommended for general kernel use.
-Please use the this_cpu operations instead unless there is really a special purpose.
-Most uses of local_t in the kernel have been replaced by this_cpu operations.
-this_cpu operations combine the relocation with the local_t like semantics in
-a single instruction and yield more compact and faster executing code.
+.. note::
 
+    Note that ``local_t`` based operations are not recommended for general
+    kernel use. Please use the ``this_cpu`` operations instead unless there is
+    really a special purpose. Most uses of ``local_t`` in the kernel have been
+    replaced by ``this_cpu`` operations. ``this_cpu`` operations combine the
+    relocation with the ``local_t`` like semantics in a single instruction and
+    yield more compact and faster executing code.
 
-* Purpose of local atomic operations
+
+Purpose of local atomic operations
+==================================
 
 Local atomic operations are meant to provide fast and highly reentrant per CPU
 counters. They minimize the performance cost of standard atomic operations by
 removing the LOCK prefix and memory barriers normally required to synchronize
 across CPUs.
 
-Having fast per CPU atomic counters is interesting in many cases : it does not
+Having fast per CPU atomic counters is interesting in many cases: it does not
 require disabling interrupts to protect from interrupt handlers and it permits
 coherent counters in NMI handlers. It is especially useful for tracing purposes
 and for various performance monitoring counters.
 
 Local atomic operations only guarantee variable modification atomicity wrt the
 CPU which owns the data. Therefore, care must taken to make sure that only one
-CPU writes to the local_t data. This is done by using per cpu data and making
-sure that we modify it from within a preemption safe context. It is however
-permitted to read local_t data from any CPU : it will then appear to be written
-out of order wrt other memory writes by the owner CPU.
+CPU writes to the ``local_t`` data. This is done by using per cpu data and
+making sure that we modify it from within a preemption safe context. It is
+however permitted to read ``local_t`` data from any CPU: it will then appear to
+be written out of order wrt other memory writes by the owner CPU.
 
 
-* Implementation for a given architecture
+Implementation for a given architecture
+=======================================
 
-It can be done by slightly modifying the standard atomic operations : only
+It can be done by slightly modifying the standard atomic operations: only
 their UP variant must be kept. It typically means removing LOCK prefix (on
 i386 and x86_64) and any SMP synchronization barrier. If the architecture does
-not have a different behavior between SMP and UP, including asm-generic/local.h
-in your architecture's local.h is sufficient.
+not have a different behavior between SMP and UP, including
+``asm-generic/local.h`` in your architecture's ``local.h`` is sufficient.
 
-The local_t type is defined as an opaque signed long by embedding an
-atomic_long_t inside a structure. This is made so a cast from this type to a
-long fails. The definition looks like :
+The ``local_t`` type is defined as an opaque ``signed long`` by embedding an
+``atomic_long_t`` inside a structure. This is made so a cast from this type to
+a ``long`` fails. The definition looks like::
 
-typedef struct { atomic_long_t a; } local_t;
+    typedef struct { atomic_long_t a; } local_t;
 
 
-* Rules to follow when using local atomic operations
+Rules to follow when using local atomic operations
+==================================================
 
-- Variables touched by local ops must be per cpu variables.
-- _Only_ the CPU owner of these variables must write to them.
-- This CPU can use local ops from any context (process, irq, softirq, nmi, ...)
-  to update its local_t variables.
-- Preemption (or interrupts) must be disabled when using local ops in
-  process context to   make sure the process won't be migrated to a
+* Variables touched by local ops must be per cpu variables.
+* *Only* the CPU owner of these variables must write to them.
+* This CPU can use local ops from any context (process, irq, softirq, nmi, ...)
+  to update its ``local_t`` variables.
+* Preemption (or interrupts) must be disabled when using local ops in
+  process context to make sure the process won't be migrated to a
   different CPU between getting the per-cpu variable and doing the
   actual local op.
-- When using local ops in interrupt context, no special care must be
+* When using local ops in interrupt context, no special care must be
   taken on a mainline kernel, since they will run on the local CPU with
   preemption already disabled. I suggest, however, to explicitly
   disable preemption anyway to make sure it will still work correctly on
   -rt kernels.
-- Reading the local cpu variable will provide the current copy of the
+* Reading the local cpu variable will provide the current copy of the
   variable.
-- Reads of these variables can be done from any CPU, because updates to
-  "long", aligned, variables are always atomic. Since no memory
+* Reads of these variables can be done from any CPU, because updates to
+  "``long``", aligned, variables are always atomic. Since no memory
   synchronization is done by the writer CPU, an outdated copy of the
-  variable can be read when reading some _other_ cpu's variables.
+  variable can be read when reading some *other* cpu's variables.
+
 
+How to use local atomic operations
+==================================
 
-* How to use local atomic operations
+::
 
-#include <linux/percpu.h>
-#include <asm/local.h>
+    #include <linux/percpu.h>
+    #include <asm/local.h>
 
-static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
+    static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
 
 
-* Counting
+Counting
+========
 
 Counting is done on all the bits of a signed long.
 
-In preemptible context, use get_cpu_var() and put_cpu_var() around local atomic
-operations : it makes sure that preemption is disabled around write access to
-the per cpu variable. For instance :
+In preemptible context, use ``get_cpu_var()`` and ``put_cpu_var()`` around
+local atomic operations: it makes sure that preemption is disabled around write
+access to the per cpu variable. For instance::
 
-	local_inc(&get_cpu_var(counters));
-	put_cpu_var(counters);
+    local_inc(&get_cpu_var(counters));
+    put_cpu_var(counters);
 
 If you are already in a preemption-safe context, you can use
-this_cpu_ptr() instead.
+``this_cpu_ptr()`` instead::
 
-	local_inc(this_cpu_ptr(&counters));
+    local_inc(this_cpu_ptr(&counters));
 
 
 
-* Reading the counters
+Reading the counters
+====================
 
 Those local counters can be read from foreign CPUs to sum the count. Note that
 the data seen by local_read across CPUs must be considered to be out of order
-relatively to other memory writes happening on the CPU that owns the data.
+relatively to other memory writes happening on the CPU that owns the data::
 
-	long sum = 0;
-	for_each_online_cpu(cpu)
-		sum += local_read(&per_cpu(counters, cpu));
+    long sum = 0;
+    for_each_online_cpu(cpu)
+            sum += local_read(&per_cpu(counters, cpu));
 
 If you want to use a remote local_read to synchronize access to a resource
-between CPUs, explicit smp_wmb() and smp_rmb() memory barriers must be used
+between CPUs, explicit ``smp_wmb()`` and ``smp_rmb()`` memory barriers must be used
 respectively on the writer and the reader CPUs. It would be the case if you use
-the local_t variable as a counter of bytes written in a buffer : there should
-be a smp_wmb() between the buffer write and the counter increment and also a
-smp_rmb() between the counter read and the buffer read.
-
-
-Here is a sample module which implements a basic per cpu counter using local.h.
-
---- BEGIN ---
-/* test-local.c
- *
- * Sample module for local.h usage.
- */
-
-
-#include <asm/local.h>
-#include <linux/module.h>
-#include <linux/timer.h>
-
-static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
-
-static struct timer_list test_timer;
-
-/* IPI called on each CPU. */
-static void test_each(void *info)
-{
-	/* Increment the counter from a non preemptible context */
-	printk("Increment on cpu %d\n", smp_processor_id());
-	local_inc(this_cpu_ptr(&counters));
-
-	/* This is what incrementing the variable would look like within a
-	 * preemptible context (it disables preemption) :
-	 *
-	 * local_inc(&get_cpu_var(counters));
-	 * put_cpu_var(counters);
-	 */
-}
-
-static void do_test_timer(unsigned long data)
-{
-	int cpu;
-
-	/* Increment the counters */
-	on_each_cpu(test_each, NULL, 1);
-	/* Read all the counters */
-	printk("Counters read from CPU %d\n", smp_processor_id());
-	for_each_online_cpu(cpu) {
-		printk("Read : CPU %d, count %ld\n", cpu,
-			local_read(&per_cpu(counters, cpu)));
-	}
-	del_timer(&test_timer);
-	test_timer.expires = jiffies + 1000;
-	add_timer(&test_timer);
-}
-
-static int __init test_init(void)
-{
-	/* initialize the timer that will increment the counter */
-	init_timer(&test_timer);
-	test_timer.function = do_test_timer;
-	test_timer.expires = jiffies + 1;
-	add_timer(&test_timer);
-
-	return 0;
-}
-
-static void __exit test_exit(void)
-{
-	del_timer_sync(&test_timer);
-}
-
-module_init(test_init);
-module_exit(test_exit);
-
-MODULE_LICENSE("GPL");
-MODULE_AUTHOR("Mathieu Desnoyers");
-MODULE_DESCRIPTION("Local Atomic Ops");
---- END ---
+the ``local_t`` variable as a counter of bytes written in a buffer: there should
+be a ``smp_wmb()`` between the buffer write and the counter increment and also a
+``smp_rmb()`` between the counter read and the buffer read.
+
+
+Here is a sample module which implements a basic per cpu counter using
+``local.h``::
+
+    /* test-local.c
+     *
+     * Sample module for local.h usage.
+     */
+
+
+    #include <asm/local.h>
+    #include <linux/module.h>
+    #include <linux/timer.h>
+
+    static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
+
+    static struct timer_list test_timer;
+
+    /* IPI called on each CPU. */
+    static void test_each(void *info)
+    {
+            /* Increment the counter from a non preemptible context */
+            printk("Increment on cpu %d\n", smp_processor_id());
+            local_inc(this_cpu_ptr(&counters));
+
+            /* This is what incrementing the variable would look like within a
+             * preemptible context (it disables preemption) :
+             *
+             * local_inc(&get_cpu_var(counters));
+             * put_cpu_var(counters);
+             */
+    }
+
+    static void do_test_timer(unsigned long data)
+    {
+            int cpu;
+
+            /* Increment the counters */
+            on_each_cpu(test_each, NULL, 1);
+            /* Read all the counters */
+            printk("Counters read from CPU %d\n", smp_processor_id());
+            for_each_online_cpu(cpu) {
+                    printk("Read : CPU %d, count %ld\n", cpu,
+                            local_read(&per_cpu(counters, cpu)));
+            }
+            del_timer(&test_timer);
+            test_timer.expires = jiffies + 1000;
+            add_timer(&test_timer);
+    }
+
+    static int __init test_init(void)
+    {
+            /* initialize the timer that will increment the counter */
+            init_timer(&test_timer);
+            test_timer.function = do_test_timer;
+            test_timer.expires = jiffies + 1;
+            add_timer(&test_timer);
+
+            return 0;
+    }
+
+    static void __exit test_exit(void)
+    {
+            del_timer_sync(&test_timer);
+    }
+
+    module_init(test_init);
+    module_exit(test_exit);
+
+    MODULE_LICENSE("GPL");
+    MODULE_AUTHOR("Mathieu Desnoyers");
+    MODULE_DESCRIPTION("Local Atomic Ops");
-- 
git-series 0.9.1

[toc] | [prev] | [next] | [standalone]

#1530535 — Re: [PATCH v3 3/4] Documentation/local_ops.txt: convert to ReST markup

Em Fri, 25 Nov 2016 15:59:46 +0100
Silvio Fricke <silvio.fricke@gmail.com> escreveu:

> ... and move to core-api folder.
> 
> Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>

Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

> ---
>  Documentation/core-api/index.rst                                    |   1 +-
>  Documentation/local_ops.txt => Documentation/core-api/local_ops.rst | 273 +++----
>  2 files changed, 145 insertions(+), 129 deletions(-)
> 
> diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
> index f3e5f5e..25b4e4a 100644
> --- a/Documentation/core-api/index.rst
> +++ b/Documentation/core-api/index.rst
> @@ -9,6 +9,7 @@ Kernel and driver related documentation.
>  
>     assoc_array
>     atomic_ops
> +   local_ops
>     workqueue
>  
>  .. only::  subproject
> diff --git a/Documentation/local_ops.txt b/Documentation/core-api/local_ops.rst
> similarity index 57%
> rename from Documentation/local_ops.txt
> rename to Documentation/core-api/local_ops.rst
> index 407576a..1062ddb 100644
> --- a/Documentation/local_ops.txt
> +++ b/Documentation/core-api/local_ops.rst
> @@ -1,191 +1,206 @@
> -	     Semantics and Behavior of Local Atomic Operations
>  
> -			    Mathieu Desnoyers
> +.. _local_ops:
>  
> +=================================================
> +Semantics and Behavior of Local Atomic Operations
> +=================================================
>  
> -	This document explains the purpose of the local atomic operations, how
> +:Author: Mathieu Desnoyers
> +
> +
> +This document explains the purpose of the local atomic operations, how
>  to implement them for any given architecture and shows how they can be used
>  properly. It also stresses on the precautions that must be taken when reading
>  those local variables across CPUs when the order of memory writes matters.
>  
> -Note that local_t based operations are not recommended for general kernel use.
> -Please use the this_cpu operations instead unless there is really a special purpose.
> -Most uses of local_t in the kernel have been replaced by this_cpu operations.
> -this_cpu operations combine the relocation with the local_t like semantics in
> -a single instruction and yield more compact and faster executing code.
> +.. note::
>  
> +    Note that ``local_t`` based operations are not recommended for general
> +    kernel use. Please use the ``this_cpu`` operations instead unless there is
> +    really a special purpose. Most uses of ``local_t`` in the kernel have been
> +    replaced by ``this_cpu`` operations. ``this_cpu`` operations combine the
> +    relocation with the ``local_t`` like semantics in a single instruction and
> +    yield more compact and faster executing code.
>  
> -* Purpose of local atomic operations
> +
> +Purpose of local atomic operations
> +==================================
>  
>  Local atomic operations are meant to provide fast and highly reentrant per CPU
>  counters. They minimize the performance cost of standard atomic operations by
>  removing the LOCK prefix and memory barriers normally required to synchronize
>  across CPUs.
>  
> -Having fast per CPU atomic counters is interesting in many cases : it does not
> +Having fast per CPU atomic counters is interesting in many cases: it does not
>  require disabling interrupts to protect from interrupt handlers and it permits
>  coherent counters in NMI handlers. It is especially useful for tracing purposes
>  and for various performance monitoring counters.
>  
>  Local atomic operations only guarantee variable modification atomicity wrt the
>  CPU which owns the data. Therefore, care must taken to make sure that only one
> -CPU writes to the local_t data. This is done by using per cpu data and making
> -sure that we modify it from within a preemption safe context. It is however
> -permitted to read local_t data from any CPU : it will then appear to be written
> -out of order wrt other memory writes by the owner CPU.
> +CPU writes to the ``local_t`` data. This is done by using per cpu data and
> +making sure that we modify it from within a preemption safe context. It is
> +however permitted to read ``local_t`` data from any CPU: it will then appear to
> +be written out of order wrt other memory writes by the owner CPU.
>  
>  
> -* Implementation for a given architecture
> +Implementation for a given architecture
> +=======================================
>  
> -It can be done by slightly modifying the standard atomic operations : only
> +It can be done by slightly modifying the standard atomic operations: only
>  their UP variant must be kept. It typically means removing LOCK prefix (on
>  i386 and x86_64) and any SMP synchronization barrier. If the architecture does
> -not have a different behavior between SMP and UP, including asm-generic/local.h
> -in your architecture's local.h is sufficient.
> +not have a different behavior between SMP and UP, including
> +``asm-generic/local.h`` in your architecture's ``local.h`` is sufficient.
>  
> -The local_t type is defined as an opaque signed long by embedding an
> -atomic_long_t inside a structure. This is made so a cast from this type to a
> -long fails. The definition looks like :
> +The ``local_t`` type is defined as an opaque ``signed long`` by embedding an
> +``atomic_long_t`` inside a structure. This is made so a cast from this type to
> +a ``long`` fails. The definition looks like::
>  
> -typedef struct { atomic_long_t a; } local_t;
> +    typedef struct { atomic_long_t a; } local_t;
>  
>  
> -* Rules to follow when using local atomic operations
> +Rules to follow when using local atomic operations
> +==================================================
>  
> -- Variables touched by local ops must be per cpu variables.
> -- _Only_ the CPU owner of these variables must write to them.
> -- This CPU can use local ops from any context (process, irq, softirq, nmi, ...)
> -  to update its local_t variables.
> -- Preemption (or interrupts) must be disabled when using local ops in
> -  process context to   make sure the process won't be migrated to a
> +* Variables touched by local ops must be per cpu variables.
> +* *Only* the CPU owner of these variables must write to them.
> +* This CPU can use local ops from any context (process, irq, softirq, nmi, ...)
> +  to update its ``local_t`` variables.
> +* Preemption (or interrupts) must be disabled when using local ops in
> +  process context to make sure the process won't be migrated to a
>    different CPU between getting the per-cpu variable and doing the
>    actual local op.
> -- When using local ops in interrupt context, no special care must be
> +* When using local ops in interrupt context, no special care must be
>    taken on a mainline kernel, since they will run on the local CPU with
>    preemption already disabled. I suggest, however, to explicitly
>    disable preemption anyway to make sure it will still work correctly on
>    -rt kernels.
> -- Reading the local cpu variable will provide the current copy of the
> +* Reading the local cpu variable will provide the current copy of the
>    variable.
> -- Reads of these variables can be done from any CPU, because updates to
> -  "long", aligned, variables are always atomic. Since no memory
> +* Reads of these variables can be done from any CPU, because updates to
> +  "``long``", aligned, variables are always atomic. Since no memory
>    synchronization is done by the writer CPU, an outdated copy of the
> -  variable can be read when reading some _other_ cpu's variables.
> +  variable can be read when reading some *other* cpu's variables.
> +
>  
> +How to use local atomic operations
> +==================================
>  
> -* How to use local atomic operations
> +::
>  
> -#include <linux/percpu.h>
> -#include <asm/local.h>
> +    #include <linux/percpu.h>
> +    #include <asm/local.h>
>  
> -static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
> +    static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
>  
>  
> -* Counting
> +Counting
> +========
>  
>  Counting is done on all the bits of a signed long.
>  
> -In preemptible context, use get_cpu_var() and put_cpu_var() around local atomic
> -operations : it makes sure that preemption is disabled around write access to
> -the per cpu variable. For instance :
> +In preemptible context, use ``get_cpu_var()`` and ``put_cpu_var()`` around
> +local atomic operations: it makes sure that preemption is disabled around write
> +access to the per cpu variable. For instance::
>  
> -	local_inc(&get_cpu_var(counters));
> -	put_cpu_var(counters);
> +    local_inc(&get_cpu_var(counters));
> +    put_cpu_var(counters);
>  
>  If you are already in a preemption-safe context, you can use
> -this_cpu_ptr() instead.
> +``this_cpu_ptr()`` instead::
>  
> -	local_inc(this_cpu_ptr(&counters));
> +    local_inc(this_cpu_ptr(&counters));
>  
>  
>  
> -* Reading the counters
> +Reading the counters
> +====================
>  
>  Those local counters can be read from foreign CPUs to sum the count. Note that
>  the data seen by local_read across CPUs must be considered to be out of order
> -relatively to other memory writes happening on the CPU that owns the data.
> +relatively to other memory writes happening on the CPU that owns the data::
>  
> -	long sum = 0;
> -	for_each_online_cpu(cpu)
> -		sum += local_read(&per_cpu(counters, cpu));
> +    long sum = 0;
> +    for_each_online_cpu(cpu)
> +            sum += local_read(&per_cpu(counters, cpu));
>  
>  If you want to use a remote local_read to synchronize access to a resource
> -between CPUs, explicit smp_wmb() and smp_rmb() memory barriers must be used
> +between CPUs, explicit ``smp_wmb()`` and ``smp_rmb()`` memory barriers must be used
>  respectively on the writer and the reader CPUs. It would be the case if you use
> -the local_t variable as a counter of bytes written in a buffer : there should
> -be a smp_wmb() between the buffer write and the counter increment and also a
> -smp_rmb() between the counter read and the buffer read.
> -
> -
> -Here is a sample module which implements a basic per cpu counter using local.h.
> -
> ---- BEGIN ---
> -/* test-local.c
> - *
> - * Sample module for local.h usage.
> - */
> -
> -
> -#include <asm/local.h>
> -#include <linux/module.h>
> -#include <linux/timer.h>
> -
> -static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
> -
> -static struct timer_list test_timer;
> -
> -/* IPI called on each CPU. */
> -static void test_each(void *info)
> -{
> -	/* Increment the counter from a non preemptible context */
> -	printk("Increment on cpu %d\n", smp_processor_id());
> -	local_inc(this_cpu_ptr(&counters));
> -
> -	/* This is what incrementing the variable would look like within a
> -	 * preemptible context (it disables preemption) :
> -	 *
> -	 * local_inc(&get_cpu_var(counters));
> -	 * put_cpu_var(counters);
> -	 */
> -}
> -
> -static void do_test_timer(unsigned long data)
> -{
> -	int cpu;
> -
> -	/* Increment the counters */
> -	on_each_cpu(test_each, NULL, 1);
> -	/* Read all the counters */
> -	printk("Counters read from CPU %d\n", smp_processor_id());
> -	for_each_online_cpu(cpu) {
> -		printk("Read : CPU %d, count %ld\n", cpu,
> -			local_read(&per_cpu(counters, cpu)));
> -	}
> -	del_timer(&test_timer);
> -	test_timer.expires = jiffies + 1000;
> -	add_timer(&test_timer);
> -}
> -
> -static int __init test_init(void)
> -{
> -	/* initialize the timer that will increment the counter */
> -	init_timer(&test_timer);
> -	test_timer.function = do_test_timer;
> -	test_timer.expires = jiffies + 1;
> -	add_timer(&test_timer);
> -
> -	return 0;
> -}
> -
> -static void __exit test_exit(void)
> -{
> -	del_timer_sync(&test_timer);
> -}
> -
> -module_init(test_init);
> -module_exit(test_exit);
> -
> -MODULE_LICENSE("GPL");
> -MODULE_AUTHOR("Mathieu Desnoyers");
> -MODULE_DESCRIPTION("Local Atomic Ops");
> ---- END ---
> +the ``local_t`` variable as a counter of bytes written in a buffer: there should
> +be a ``smp_wmb()`` between the buffer write and the counter increment and also a
> +``smp_rmb()`` between the counter read and the buffer read.
> +
> +
> +Here is a sample module which implements a basic per cpu counter using
> +``local.h``::
> +
> +    /* test-local.c
> +     *
> +     * Sample module for local.h usage.
> +     */
> +
> +
> +    #include <asm/local.h>
> +    #include <linux/module.h>
> +    #include <linux/timer.h>
> +
> +    static DEFINE_PER_CPU(local_t, counters) = LOCAL_INIT(0);
> +
> +    static struct timer_list test_timer;
> +
> +    /* IPI called on each CPU. */
> +    static void test_each(void *info)
> +    {
> +            /* Increment the counter from a non preemptible context */
> +            printk("Increment on cpu %d\n", smp_processor_id());
> +            local_inc(this_cpu_ptr(&counters));
> +
> +            /* This is what incrementing the variable would look like within a
> +             * preemptible context (it disables preemption) :
> +             *
> +             * local_inc(&get_cpu_var(counters));
> +             * put_cpu_var(counters);
> +             */
> +    }
> +
> +    static void do_test_timer(unsigned long data)
> +    {
> +            int cpu;
> +
> +            /* Increment the counters */
> +            on_each_cpu(test_each, NULL, 1);
> +            /* Read all the counters */
> +            printk("Counters read from CPU %d\n", smp_processor_id());
> +            for_each_online_cpu(cpu) {
> +                    printk("Read : CPU %d, count %ld\n", cpu,
> +                            local_read(&per_cpu(counters, cpu)));
> +            }
> +            del_timer(&test_timer);
> +            test_timer.expires = jiffies + 1000;
> +            add_timer(&test_timer);
> +    }
> +
> +    static int __init test_init(void)
> +    {
> +            /* initialize the timer that will increment the counter */
> +            init_timer(&test_timer);
> +            test_timer.function = do_test_timer;
> +            test_timer.expires = jiffies + 1;
> +            add_timer(&test_timer);
> +
> +            return 0;
> +    }
> +
> +    static void __exit test_exit(void)
> +    {
> +            del_timer_sync(&test_timer);
> +    }
> +
> +    module_init(test_init);
> +    module_exit(test_exit);
> +
> +    MODULE_LICENSE("GPL");
> +    MODULE_AUTHOR("Mathieu Desnoyers");
> +    MODULE_DESCRIPTION("Local Atomic Ops");



Thanks,
Mauro

[toc] | [prev] | [next] | [standalone]

#1530324 — [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST markup

... and move to Documentation/core-api folder.

Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
---
 Documentation/assoc_array.txt => Documentation/core-api/assoc_array.rst | 639 ++++++++++++++++++++++++++++++++++--------------------------------------
 Documentation/core-api/index.rst                                        |   1 +-
 2 files changed, 309 insertions(+), 331 deletions(-)

diff --git a/Documentation/assoc_array.txt b/Documentation/core-api/assoc_array.rst
similarity index 46%
rename from Documentation/assoc_array.txt
rename to Documentation/core-api/assoc_array.rst
index 2f2c6cd..dcda7c6 100644
--- a/Documentation/assoc_array.txt
+++ b/Documentation/core-api/assoc_array.rst
@@ -1,67 +1,46 @@
-		   ========================================
-		   GENERIC ASSOCIATIVE ARRAY IMPLEMENTATION
-		   ========================================
+========================================
+Generic Associative Array Implementation
+========================================
 
-Contents:
-
- - Overview.
-
- - The public API.
-   - Edit script.
-   - Operations table.
-   - Manipulation functions.
-   - Access functions.
-   - Index key form.
-
- - Internal workings.
-   - Basic internal tree layout.
-   - Shortcuts.
-   - Splitting and collapsing nodes.
-   - Non-recursive iteration.
-   - Simultaneous alteration and iteration.
-
-
-========
-OVERVIEW
+Overview
 ========
 
 This associative array implementation is an object container with the following
 properties:
 
- (1) Objects are opaque pointers.  The implementation does not care where they
-     point (if anywhere) or what they point to (if anything).
-
-     [!] NOTE: Pointers to objects _must_ be zero in the least significant bit.
+1. Objects are opaque pointers.  The implementation does not care where they
+   point (if anywhere) or what they point to (if anything).
+.. note:: Pointers to objects _must_ be zero in the least significant bit.**
 
- (2) Objects do not need to contain linkage blocks for use by the array.  This
-     permits an object to be located in multiple arrays simultaneously.
-     Rather, the array is made up of metadata blocks that point to objects.
+2. Objects do not need to contain linkage blocks for use by the array.  This
+   permits an object to be located in multiple arrays simultaneously.
+   Rather, the array is made up of metadata blocks that point to objects.
 
- (3) Objects require index keys to locate them within the array.
+3. Objects require index keys to locate them within the array.
 
- (4) Index keys must be unique.  Inserting an object with the same key as one
-     already in the array will replace the old object.
+4. Index keys must be unique.  Inserting an object with the same key as one
+   already in the array will replace the old object.
 
- (5) Index keys can be of any length and can be of different lengths.
+5. Index keys can be of any length and can be of different lengths.
 
- (6) Index keys should encode the length early on, before any variation due to
-     length is seen.
+6. Index keys should encode the length early on, before any variation due to
+   length is seen.
 
- (7) Index keys can include a hash to scatter objects throughout the array.
+7. Index keys can include a hash to scatter objects throughout the array.
 
- (8) The array can iterated over.  The objects will not necessarily come out in
-     key order.
+8. The array can iterated over.  The objects will not necessarily come out in
+   key order.
 
- (9) The array can be iterated over whilst it is being modified, provided the
-     RCU readlock is being held by the iterator.  Note, however, under these
-     circumstances, some objects may be seen more than once.  If this is a
-     problem, the iterator should lock against modification.  Objects will not
-     be missed, however, unless deleted.
+9. The array can be iterated over whilst it is being modified, provided the
+   RCU readlock is being held by the iterator.  Note, however, under these
+   circumstances, some objects may be seen more than once.  If this is a
+   problem, the iterator should lock against modification.  Objects will not
+   be missed, however, unless deleted.
 
-(10) Objects in the array can be looked up by means of their index key.
+10. Objects in the array can be looked up by means of their index key.
 
-(11) Objects can be looked up whilst the array is being modified, provided the
-     RCU readlock is being held by the thread doing the look up.
+11. Objects can be looked up whilst the array is being modified, provided the
+    RCU readlock is being held by the thread doing the look up.
 
 The implementation uses a tree of 16-pointer nodes internally that are indexed
 on each level by nibbles from the index key in the same manner as in a radix
@@ -71,25 +50,26 @@ pack leaf object pointers into spare space in the node rather than making an
 extra branch until as such time an object needs to be added to a full node.
 
 
+The Public API
 ==============
-THE PUBLIC API
-==============
 
-The public API can be found in <linux/assoc_array.h>.  The associative array is
-rooted on the following structure:
+The public API can be found in ``<linux/assoc_array.h>``.  The associative
+array is rooted on the following structure::
+
+    struct assoc_array {
+            ...
+    };
 
-	struct assoc_array {
-		...
-	};
+The code is selected by enabling ``CONFIG_ASSOCIATIVE_ARRAY`` with::
 
-The code is selected by enabling CONFIG_ASSOCIATIVE_ARRAY.
+    ./script/config -e ASSOCIATIVE_ARRAY
 
 
-EDIT SCRIPT
+Edit Script
 -----------
 
 The insertion and deletion functions produce an 'edit script' that can later be
-applied to effect the changes without risking ENOMEM.  This retains the
+applied to effect the changes without risking ``ENOMEM``. This retains the
 preallocated metadata blocks that will be installed in the internal tree and
 keeps track of the metadata blocks that will be removed from the tree when the
 script is applied.
@@ -99,246 +79,245 @@ script has been applied so that they can be freed later.  The freeing is done
 after an RCU grace period has passed - thus allowing access functions to
 proceed under the RCU read lock.
 
-The script appears as outside of the API as a pointer of the type:
+The script appears as outside of the API as a pointer of the type::
 
-	struct assoc_array_edit;
+    struct assoc_array_edit;
 
 There are two functions for dealing with the script:
 
- (1) Apply an edit script.
+1. Apply an edit script::
 
-	void assoc_array_apply_edit(struct assoc_array_edit *edit);
+    void assoc_array_apply_edit(struct assoc_array_edit *edit);
 
-     This will perform the edit functions, interpolating various write barriers
-     to permit accesses under the RCU read lock to continue.  The edit script
-     will then be passed to call_rcu() to free it and any dead stuff it points
-     to.
+This will perform the edit functions, interpolating various write barriers
+to permit accesses under the RCU read lock to continue.  The edit script
+will then be passed to ``call_rcu()`` to free it and any dead stuff it points
+to.
 
- (2) Cancel an edit script.
+2. Cancel an edit script::
 
-	void assoc_array_cancel_edit(struct assoc_array_edit *edit);
+    void assoc_array_cancel_edit(struct assoc_array_edit *edit);
 
-     This frees the edit script and all preallocated memory immediately.  If
-     this was for insertion, the new object is _not_ released by this function,
-     but must rather be released by the caller.
+This frees the edit script and all preallocated memory immediately. If
+this was for insertion, the new object is _not_ released by this function,
+but must rather be released by the caller.
 
 These functions are guaranteed not to fail.
 
 
-OPERATIONS TABLE
+Operations Table
 ----------------
 
-Various functions take a table of operations:
+Various functions take a table of operations::
 
-	struct assoc_array_ops {
-		...
-	};
+    struct assoc_array_ops {
+            ...
+    };
 
 This points to a number of methods, all of which need to be provided:
 
- (1) Get a chunk of index key from caller data:
+1. Get a chunk of index key from caller data::
 
-	unsigned long (*get_key_chunk)(const void *index_key, int level);
+    unsigned long (*get_key_chunk)(const void *index_key, int level);
 
-     This should return a chunk of caller-supplied index key starting at the
-     *bit* position given by the level argument.  The level argument will be a
-     multiple of ASSOC_ARRAY_KEY_CHUNK_SIZE and the function should return
-     ASSOC_ARRAY_KEY_CHUNK_SIZE bits.  No error is possible.
+This should return a chunk of caller-supplied index key starting at the
+*bit* position given by the level argument.  The level argument will be a
+multiple of ``ASSOC_ARRAY_KEY_CHUNK_SIZE`` and the function should return
+``ASSOC_ARRAY_KEY_CHUNK_SIZE bits``.  No error is possible.
 
 
- (2) Get a chunk of an object's index key.
+2. Get a chunk of an object's index key::
 
-	unsigned long (*get_object_key_chunk)(const void *object, int level);
+    unsigned long (*get_object_key_chunk)(const void *object, int level);
 
-     As the previous function, but gets its data from an object in the array
-     rather than from a caller-supplied index key.
+As the previous function, but gets its data from an object in the array
+rather than from a caller-supplied index key.
 
 
- (3) See if this is the object we're looking for.
+3. See if this is the object we're looking for::
 
-	bool (*compare_object)(const void *object, const void *index_key);
+    bool (*compare_object)(const void *object, const void *index_key);
 
-     Compare the object against an index key and return true if it matches and
-     false if it doesn't.
+Compare the object against an index key and return ``true`` if it matches and
+``false`` if it doesn't.
 
 
- (4) Diff the index keys of two objects.
+4. Diff the index keys of two objects::
 
-	int (*diff_objects)(const void *object, const void *index_key);
+    int (*diff_objects)(const void *object, const void *index_key);
 
-     Return the bit position at which the index key of the specified object
-     differs from the given index key or -1 if they are the same.
+Return the bit position at which the index key of the specified object
+differs from the given index key or -1 if they are the same.
 
 
- (5) Free an object.
+5. Free an object::
 
-	void (*free_object)(void *object);
+    void (*free_object)(void *object);
 
-     Free the specified object.  Note that this may be called an RCU grace
-     period after assoc_array_apply_edit() was called, so synchronize_rcu() may
-     be necessary on module unloading.
+Free the specified object.  Note that this may be called an RCU grace period
+after ``assoc_array_apply_edit()`` was called, so ``synchronize_rcu()`` may be
+necessary on module unloading.
 
 
-MANIPULATION FUNCTIONS
+Manipulation Functions
 ----------------------
 
 There are a number of functions for manipulating an associative array:
 
- (1) Initialise an associative array.
+1. Initialise an associative array::
 
-	void assoc_array_init(struct assoc_array *array);
+    void assoc_array_init(struct assoc_array *array);
 
-     This initialises the base structure for an associative array.  It can't
-     fail.
+This initialises the base structure for an associative array.  It can't fail.
 
 
- (2) Insert/replace an object in an associative array.
+2. Insert/replace an object in an associative array::
 
-	struct assoc_array_edit *
-	assoc_array_insert(struct assoc_array *array,
-			   const struct assoc_array_ops *ops,
-			   const void *index_key,
-			   void *object);
+    struct assoc_array_edit *
+    assoc_array_insert(struct assoc_array *array,
+                       const struct assoc_array_ops *ops,
+                       const void *index_key,
+                       void *object);
 
-     This inserts the given object into the array.  Note that the least
-     significant bit of the pointer must be zero as it's used to type-mark
-     pointers internally.
+This inserts the given object into the array.  Note that the least
+significant bit of the pointer must be zero as it's used to type-mark
+pointers internally.
 
-     If an object already exists for that key then it will be replaced with the
-     new object and the old one will be freed automatically.
+If an object already exists for that key then it will be replaced with the
+new object and the old one will be freed automatically.
 
-     The index_key argument should hold index key information and is
-     passed to the methods in the ops table when they are called.
+The ``index_key`` argument should hold index key information and is
+passed to the methods in the ops table when they are called.
 
-     This function makes no alteration to the array itself, but rather returns
-     an edit script that must be applied.  -ENOMEM is returned in the case of
-     an out-of-memory error.
+This function makes no alteration to the array itself, but rather returns
+an edit script that must be applied.  ``-ENOMEM`` is returned in the case of
+an out-of-memory error.
 
-     The caller should lock exclusively against other modifiers of the array.
+The caller should lock exclusively against other modifiers of the array.
 
 
- (3) Delete an object from an associative array.
+3. Delete an object from an associative array::
 
-	struct assoc_array_edit *
-	assoc_array_delete(struct assoc_array *array,
-			   const struct assoc_array_ops *ops,
-			   const void *index_key);
+    struct assoc_array_edit *
+    assoc_array_delete(struct assoc_array *array,
+                       const struct assoc_array_ops *ops,
+                       const void *index_key);
 
-     This deletes an object that matches the specified data from the array.
+This deletes an object that matches the specified data from the array.
 
-     The index_key argument should hold index key information and is
-     passed to the methods in the ops table when they are called.
+The ``index_key`` argument should hold index key information and is
+passed to the methods in the ops table when they are called.
 
-     This function makes no alteration to the array itself, but rather returns
-     an edit script that must be applied.  -ENOMEM is returned in the case of
-     an out-of-memory error.  NULL will be returned if the specified object is
-     not found within the array.
+This function makes no alteration to the array itself, but rather returns
+an edit script that must be applied.  ``-ENOMEM`` is returned in the case of
+an out-of-memory error.  ``NULL`` will be returned if the specified object is
+not found within the array.
 
-     The caller should lock exclusively against other modifiers of the array.
+The caller should lock exclusively against other modifiers of the array.
 
 
- (4) Delete all objects from an associative array.
+4. Delete all objects from an associative array::
 
-	struct assoc_array_edit *
-	assoc_array_clear(struct assoc_array *array,
-			  const struct assoc_array_ops *ops);
+    struct assoc_array_edit *
+    assoc_array_clear(struct assoc_array *array,
+                      const struct assoc_array_ops *ops);
 
-     This deletes all the objects from an associative array and leaves it
-     completely empty.
+This deletes all the objects from an associative array and leaves it
+completely empty.
 
-     This function makes no alteration to the array itself, but rather returns
-     an edit script that must be applied.  -ENOMEM is returned in the case of
-     an out-of-memory error.
+This function makes no alteration to the array itself, but rather returns
+an edit script that must be applied.  ``-ENOMEM`` is returned in the case of
+an out-of-memory error.
 
-     The caller should lock exclusively against other modifiers of the array.
+The caller should lock exclusively against other modifiers of the array.
 
 
- (5) Destroy an associative array, deleting all objects.
+5. Destroy an associative array, deleting all objects::
 
-	void assoc_array_destroy(struct assoc_array *array,
-				 const struct assoc_array_ops *ops);
+    void assoc_array_destroy(struct assoc_array *array,
+                             const struct assoc_array_ops *ops);
 
-     This destroys the contents of the associative array and leaves it
-     completely empty.  It is not permitted for another thread to be traversing
-     the array under the RCU read lock at the same time as this function is
-     destroying it as no RCU deferral is performed on memory release -
-     something that would require memory to be allocated.
+This destroys the contents of the associative array and leaves it
+completely empty.  It is not permitted for another thread to be traversing
+the array under the RCU read lock at the same time as this function is
+destroying it as no RCU deferral is performed on memory release -
+something that would require memory to be allocated.
 
-     The caller should lock exclusively against other modifiers and accessors
-     of the array.
+The caller should lock exclusively against other modifiers and accessors
+of the array.
 
 
- (6) Garbage collect an associative array.
+6. Garbage collect an associative array::
 
-	int assoc_array_gc(struct assoc_array *array,
-			   const struct assoc_array_ops *ops,
-			   bool (*iterator)(void *object, void *iterator_data),
-			   void *iterator_data);
+    int assoc_array_gc(struct assoc_array *array,
+                       const struct assoc_array_ops *ops,
+                       bool (*iterator)(void *object, void *iterator_data),
+                       void *iterator_data);
 
-     This iterates over the objects in an associative array and passes each one
-     to iterator().  If iterator() returns true, the object is kept.  If it
-     returns false, the object will be freed.  If the iterator() function
-     returns true, it must perform any appropriate refcount incrementing on the
-     object before returning.
+This iterates over the objects in an associative array and passes each one to
+``iterator()``.  If ``iterator()`` returns ``true``, the object is kept.  If it
+returns ``false``, the object will be freed.  If the ``iterator()`` function
+returns ``true``, it must perform any appropriate refcount incrementing on the
+object before returning.
 
-     The internal tree will be packed down if possible as part of the iteration
-     to reduce the number of nodes in it.
+The internal tree will be packed down if possible as part of the iteration
+to reduce the number of nodes in it.
 
-     The iterator_data is passed directly to iterator() and is otherwise
-     ignored by the function.
+The ``iterator_data`` is passed directly to ``iterator()`` and is otherwise
+ignored by the function.
 
-     The function will return 0 if successful and -ENOMEM if there wasn't
-     enough memory.
+The function will return ``0`` if successful and ``-ENOMEM`` if there wasn't
+enough memory.
 
-     It is possible for other threads to iterate over or search the array under
-     the RCU read lock whilst this function is in progress.  The caller should
-     lock exclusively against other modifiers of the array.
+It is possible for other threads to iterate over or search the array under
+the RCU read lock whilst this function is in progress.  The caller should
+lock exclusively against other modifiers of the array.
 
 
-ACCESS FUNCTIONS
+Access Functions
 ----------------
 
 There are two functions for accessing an associative array:
 
- (1) Iterate over all the objects in an associative array.
+1. Iterate over all the objects in an associative array::
 
-	int assoc_array_iterate(const struct assoc_array *array,
-				int (*iterator)(const void *object,
-						void *iterator_data),
-				void *iterator_data);
+    int assoc_array_iterate(const struct assoc_array *array,
+                            int (*iterator)(const void *object,
+                                            void *iterator_data),
+                            void *iterator_data);
 
-     This passes each object in the array to the iterator callback function.
-     iterator_data is private data for that function.
+This passes each object in the array to the iterator callback function.
+``iterator_data`` is private data for that function.
 
-     This may be used on an array at the same time as the array is being
-     modified, provided the RCU read lock is held.  Under such circumstances,
-     it is possible for the iteration function to see some objects twice.  If
-     this is a problem, then modification should be locked against.  The
-     iteration algorithm should not, however, miss any objects.
+This may be used on an array at the same time as the array is being
+modified, provided the RCU read lock is held.  Under such circumstances,
+it is possible for the iteration function to see some objects twice.  If
+this is a problem, then modification should be locked against.  The
+iteration algorithm should not, however, miss any objects.
 
-     The function will return 0 if no objects were in the array or else it will
-     return the result of the last iterator function called.  Iteration stops
-     immediately if any call to the iteration function results in a non-zero
-     return.
+The function will return ``0`` if no objects were in the array or else it will
+return the result of the last iterator function called.  Iteration stops
+immediately if any call to the iteration function results in a non-zero
+return.
 
 
- (2) Find an object in an associative array.
+2. Find an object in an associative array::
 
-	void *assoc_array_find(const struct assoc_array *array,
-			       const struct assoc_array_ops *ops,
-			       const void *index_key);
+    void *assoc_array_find(const struct assoc_array *array,
+                           const struct assoc_array_ops *ops,
+                           const void *index_key);
 
-     This walks through the array's internal tree directly to the object
-     specified by the index key..
+This walks through the array's internal tree directly to the object
+specified by the index key..
 
-     This may be used on an array at the same time as the array is being
-     modified, provided the RCU read lock is held.
+This may be used on an array at the same time as the array is being
+modified, provided the RCU read lock is held.
 
-     The function will return the object if found (and set *_type to the object
-     type) or will return NULL if the object was not found.
+The function will return the object if found (and set ``*_type`` to the object
+type) or will return ``NULL`` if the object was not found.
 
 
-INDEX KEY FORM
+Index Key Form
 --------------
 
 The index key can be of any form, but since the algorithms aren't told how long
@@ -364,8 +343,7 @@ unlikely that more than one word of any particular index key will have to be
 used.
 
 
-=================
-INTERNAL WORKINGS
+Internal Workings
 =================
 
 The associative array data structure has an internal tree.  This tree is
@@ -373,82 +351,80 @@ constructed of two types of metadata blocks: nodes and shortcuts.
 
 A node is an array of slots.  Each slot can contain one of four things:
 
- (*) A NULL pointer, indicating that the slot is empty.
-
- (*) A pointer to an object (a leaf).
-
- (*) A pointer to a node at the next level.
-
- (*) A pointer to a shortcut.
+* A NULL pointer, indicating that the slot is empty.
+* A pointer to an object (a leaf).
+* A pointer to a node at the next level.
+* A pointer to a shortcut.
 
 
-BASIC INTERNAL TREE LAYOUT
+Basic Internal Tree Layout
 --------------------------
 
 Ignoring shortcuts for the moment, the nodes form a multilevel tree.  The index
 key space is strictly subdivided by the nodes in the tree and nodes occur on
-fixed levels.  For example:
-
- Level:	0		1		2		3
-	===============	===============	===============	===============
-							NODE D
-			NODE B		NODE C	+------>+---+
-		+------>+---+	+------>+---+	|	| 0 |
-	NODE A	|	| 0 |	|	| 0 |	|	+---+
-	+---+	|	+---+	|	+---+	|	:   :
-	| 0 |	|	:   :	|	:   :	|	+---+
-	+---+	|	+---+	|	+---+	|	| f |
-	| 1 |---+	| 3 |---+	| 7 |---+	+---+
-	+---+		+---+		+---+
-	:   :		:   :		| 8 |---+
-	+---+		+---+		+---+	|	NODE E
-	| e |---+	| f |		:   :   +------>+---+
-	+---+	|	+---+		+---+		| 0 |
-	| f |	|			| f |		+---+
-	+---+	|			+---+		:   :
-		|	NODE F				+---+
-		+------>+---+				| f |
-			| 0 |		NODE G		+---+
-			+---+	+------>+---+
-			:   :	|	| 0 |
-			+---+	|	+---+
-			| 6 |---+	:   :
-			+---+		+---+
-			:   :		| f |
-			+---+		+---+
-			| f |
-			+---+
+fixed levels.  For example::
+
+ Level: 0               1               2               3
+        =============== =============== =============== ===============
+                                                        NODE D
+                        NODE B          NODE C  +------>+---+
+                +------>+---+   +------>+---+   |       | 0 |
+        NODE A  |       | 0 |   |       | 0 |   |       +---+
+        +---+   |       +---+   |       +---+   |       :   :
+        | 0 |   |       :   :   |       :   :   |       +---+
+        +---+   |       +---+   |       +---+   |       | f |
+        | 1 |---+       | 3 |---+       | 7 |---+       +---+
+        +---+           +---+           +---+
+        :   :           :   :           | 8 |---+
+        +---+           +---+           +---+   |       NODE E
+        | e |---+       | f |           :   :   +------>+---+
+        +---+   |       +---+           +---+           | 0 |
+        | f |   |                       | f |           +---+
+        +---+   |                       +---+           :   :
+                |       NODE F                          +---+
+                +------>+---+                           | f |
+                        | 0 |           NODE G          +---+
+                        +---+   +------>+---+
+                        :   :   |       | 0 |
+                        +---+   |       +---+
+                        | 6 |---+       :   :
+                        +---+           +---+
+                        :   :           | f |
+                        +---+           +---+
+                        | f |
+                        +---+
 
 In the above example, there are 7 nodes (A-G), each with 16 slots (0-f).
-Assuming no other meta data nodes in the tree, the key space is divided thusly:
-
-	KEY PREFIX	NODE
-	==========	====
-	137*		D
-	138*		E
-	13[0-69-f]*	C
-	1[0-24-f]*	B
-	e6*		G
-	e[0-57-f]*	F
-	[02-df]*	A
+Assuming no other meta data nodes in the tree, the key space is divided
+thusly::
+
+    KEY PREFIX      NODE
+    ==========      ====
+    137*            D
+    138*            E
+    13[0-69-f]*     C
+    1[0-24-f]*      B
+    e6*             G
+    e[0-57-f]*      F
+    [02-df]*        A
 
 So, for instance, keys with the following example index keys will be found in
-the appropriate nodes:
-
-	INDEX KEY	PREFIX	NODE
-	===============	=======	====
-	13694892892489	13	C
-	13795289025897	137	D
-	13889dde88793	138	E
-	138bbb89003093	138	E
-	1394879524789	12	C
-	1458952489	1	B
-	9431809de993ba	-	A
-	b4542910809cd	-	A
-	e5284310def98	e	F
-	e68428974237	e6	G
-	e7fffcbd443	e	F
-	f3842239082	-	A
+the appropriate nodes::
+
+    INDEX KEY       PREFIX  NODE
+    =============== ======= ====
+    13694892892489  13      C
+    13795289025897  137     D
+    13889dde88793   138     E
+    138bbb89003093  138     E
+    1394879524789   12      C
+    1458952489      1       B
+    9431809de993ba  -       A
+    b4542910809cd   -       A
+    e5284310def98   e       F
+    e68428974237    e6      G
+    e7fffcbd443     e       F
+    f3842239082     -       A
 
 To save memory, if a node can hold all the leaves in its portion of keyspace,
 then the node will have all those leaves in it and will not have any metadata
@@ -462,23 +438,23 @@ metadata pointer.  If the metadata pointer is there, any leaf whose key matches
 the metadata key prefix must be in the subtree that the metadata pointer points
 to.
 
-In the above example list of index keys, node A will contain:
+In the above example list of index keys, node A will contain::
 
-	SLOT	CONTENT		INDEX KEY (PREFIX)
-	====	===============	==================
-	1	PTR TO NODE B	1*
-	any	LEAF		9431809de993ba
-	any	LEAF		b4542910809cd
-	e	PTR TO NODE F	e*
-	any	LEAF		f3842239082
+    SLOT    CONTENT         INDEX KEY (PREFIX)
+    ====    =============== ==================
+    1       PTR TO NODE B   1*
+    any     LEAF            9431809de993ba
+    any     LEAF            b4542910809cd
+    e       PTR TO NODE F   e*
+    any     LEAF            f3842239082
 
-and node B:
+and node B::
 
-	3	PTR TO NODE C	13*
-	any	LEAF		1458952489
+    3	PTR TO NODE C	13*
+    any	LEAF		1458952489
 
 
-SHORTCUTS
+Shortcuts
 ---------
 
 Shortcuts are metadata records that jump over a piece of keyspace.  A shortcut
@@ -486,12 +462,13 @@ is a replacement for a series of single-occupancy nodes ascending through the
 levels.  Shortcuts exist to save memory and to speed up traversal.
 
 It is possible for the root of the tree to be a shortcut - say, for example,
-the tree contains at least 17 nodes all with key prefix '1111'.  The insertion
-algorithm will insert a shortcut to skip over the '1111' keyspace in a single
-bound and get to the fourth level where these actually become different.
+the tree contains at least 17 nodes all with key prefix ``1111``.  The
+insertion algorithm will insert a shortcut to skip over the ``1111`` keyspace
+in a single bound and get to the fourth level where these actually become
+different.
 
 
-SPLITTING AND COLLAPSING NODES
+Splitting And Collapsing Nodes
 ------------------------------
 
 Each node has a maximum capacity of 16 leaves and metadata pointers.  If the
@@ -508,7 +485,7 @@ fewer, then the subtree will be collapsed down to a single node - and this will
 ripple towards the root if possible.
 
 
-NON-RECURSIVE ITERATION
+Non-Recursive Iteration
 -----------------------
 
 Each node and shortcut contains a back pointer to its parent and the number of
@@ -519,55 +496,55 @@ make sure progress is made without the need for a stack.
 The backpointers, however, make simultaneous alteration and iteration tricky.
 
 
-SIMULTANEOUS ALTERATION AND ITERATION
+Simultaneous Alteration And Iteration
 -------------------------------------
 
 There are a number of cases to consider:
 
- (1) Simple insert/replace.  This involves simply replacing a NULL or old
-     matching leaf pointer with the pointer to the new leaf after a barrier.
-     The metadata blocks don't change otherwise.  An old leaf won't be freed
-     until after the RCU grace period.
-
- (2) Simple delete.  This involves just clearing an old matching leaf.  The
-     metadata blocks don't change otherwise.  The old leaf won't be freed until
-     after the RCU grace period.
-
- (3) Insertion replacing part of a subtree that we haven't yet entered.  This
-     may involve replacement of part of that subtree - but that won't affect
-     the iteration as we won't have reached the pointer to it yet and the
-     ancestry blocks are not replaced (the layout of those does not change).
-
- (4) Insertion replacing nodes that we're actively processing.  This isn't a
-     problem as we've passed the anchoring pointer and won't switch onto the
-     new layout until we follow the back pointers - at which point we've
-     already examined the leaves in the replaced node (we iterate over all the
-     leaves in a node before following any of its metadata pointers).
-
-     We might, however, re-see some leaves that have been split out into a new
-     branch that's in a slot further along than we were at.
-
- (5) Insertion replacing nodes that we're processing a dependent branch of.
-     This won't affect us until we follow the back pointers.  Similar to (4).
-
- (6) Deletion collapsing a branch under us.  This doesn't affect us because the
-     back pointers will get us back to the parent of the new node before we
-     could see the new node.  The entire collapsed subtree is thrown away
-     unchanged - and will still be rooted on the same slot, so we shouldn't
-     process it a second time as we'll go back to slot + 1.
-
-Note:
-
- (*) Under some circumstances, we need to simultaneously change the parent
-     pointer and the parent slot pointer on a node (say, for example, we
-     inserted another node before it and moved it up a level).  We cannot do
-     this without locking against a read - so we have to replace that node too.
-
-     However, when we're changing a shortcut into a node this isn't a problem
-     as shortcuts only have one slot and so the parent slot number isn't used
-     when traversing backwards over one.  This means that it's okay to change
-     the slot number first - provided suitable barriers are used to make sure
-     the parent slot number is read after the back pointer.
+1. Simple insert/replace.  This involves simply replacing a NULL or old
+   matching leaf pointer with the pointer to the new leaf after a barrier.
+   The metadata blocks don't change otherwise.  An old leaf won't be freed
+   until after the RCU grace period.
+
+2. Simple delete.  This involves just clearing an old matching leaf.  The
+   metadata blocks don't change otherwise.  The old leaf won't be freed until
+   after the RCU grace period.
+
+3. Insertion replacing part of a subtree that we haven't yet entered.  This
+   may involve replacement of part of that subtree - but that won't affect
+   the iteration as we won't have reached the pointer to it yet and the
+   ancestry blocks are not replaced (the layout of those does not change).
+
+4. Insertion replacing nodes that we're actively processing.  This isn't a
+   problem as we've passed the anchoring pointer and won't switch onto the
+   new layout until we follow the back pointers - at which point we've
+   already examined the leaves in the replaced node (we iterate over all the
+   leaves in a node before following any of its metadata pointers).
+
+   We might, however, re-see some leaves that have been split out into a new
+   branch that's in a slot further along than we were at.
+
+5. Insertion replacing nodes that we're processing a dependent branch of.
+   This won't affect us until we follow the back pointers.  Similar to (4).
+
+6. Deletion collapsing a branch under us.  This doesn't affect us because the
+   back pointers will get us back to the parent of the new node before we
+   could see the new node.  The entire collapsed subtree is thrown away
+   unchanged - and will still be rooted on the same slot, so we shouldn't
+   process it a second time as we'll go back to slot + 1.
+
+.. note::
+
+   Under some circumstances, we need to simultaneously change the parent
+   pointer and the parent slot pointer on a node (say, for example, we
+   inserted another node before it and moved it up a level).  We cannot do
+   this without locking against a read - so we have to replace that node too.
+
+   However, when we're changing a shortcut into a node this isn't a problem
+   as shortcuts only have one slot and so the parent slot number isn't used
+   when traversing backwards over one.  This means that it's okay to change
+   the slot number first - provided suitable barriers are used to make sure
+   the parent slot number is read after the back pointer.
 
 Obsolete blocks and leaves are freed up after an RCU grace period has passed,
 so as long as anyone doing walking or iteration holds the RCU read lock, the
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index f7ef7fd..480d9a3 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -7,6 +7,7 @@ Kernel and driver related documentation.
 .. toctree::
    :maxdepth: 1
 
+   assoc_array
    workqueue
 
 .. only::  subproject
-- 
git-series 0.9.1

[toc] | [prev] | [next] | [standalone]

#1530527 — Re: [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST markup

Em Fri, 25 Nov 2016 15:59:44 +0100
Silvio Fricke <silvio.fricke@gmail.com> escreveu:

> ... and move to Documentation/core-api folder.
> 
> Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>

Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

> ---
>  Documentation/assoc_array.txt => Documentation/core-api/assoc_array.rst | 639 ++++++++++++++++++++++++++++++++++--------------------------------------
>  Documentation/core-api/index.rst                                        |   1 +-
>  2 files changed, 309 insertions(+), 331 deletions(-)
> 
> diff --git a/Documentation/assoc_array.txt b/Documentation/core-api/assoc_array.rst
> similarity index 46%
> rename from Documentation/assoc_array.txt
> rename to Documentation/core-api/assoc_array.rst
> index 2f2c6cd..dcda7c6 100644
> --- a/Documentation/assoc_array.txt
> +++ b/Documentation/core-api/assoc_array.rst
> @@ -1,67 +1,46 @@
> -		   ========================================
> -		   GENERIC ASSOCIATIVE ARRAY IMPLEMENTATION
> -		   ========================================
> +========================================
> +Generic Associative Array Implementation
> +========================================
>  
> -Contents:
> -
> - - Overview.
> -
> - - The public API.
> -   - Edit script.
> -   - Operations table.
> -   - Manipulation functions.
> -   - Access functions.
> -   - Index key form.
> -
> - - Internal workings.
> -   - Basic internal tree layout.
> -   - Shortcuts.
> -   - Splitting and collapsing nodes.
> -   - Non-recursive iteration.
> -   - Simultaneous alteration and iteration.
> -
> -
> -========
> -OVERVIEW
> +Overview
>  ========
>  
>  This associative array implementation is an object container with the following
>  properties:
>  
> - (1) Objects are opaque pointers.  The implementation does not care where they
> -     point (if anywhere) or what they point to (if anything).
> -
> -     [!] NOTE: Pointers to objects _must_ be zero in the least significant bit.
> +1. Objects are opaque pointers.  The implementation does not care where they
> +   point (if anywhere) or what they point to (if anything).
> +.. note:: Pointers to objects _must_ be zero in the least significant bit.**
>  
> - (2) Objects do not need to contain linkage blocks for use by the array.  This
> -     permits an object to be located in multiple arrays simultaneously.
> -     Rather, the array is made up of metadata blocks that point to objects.
> +2. Objects do not need to contain linkage blocks for use by the array.  This
> +   permits an object to be located in multiple arrays simultaneously.
> +   Rather, the array is made up of metadata blocks that point to objects.
>  
> - (3) Objects require index keys to locate them within the array.
> +3. Objects require index keys to locate them within the array.
>  
> - (4) Index keys must be unique.  Inserting an object with the same key as one
> -     already in the array will replace the old object.
> +4. Index keys must be unique.  Inserting an object with the same key as one
> +   already in the array will replace the old object.
>  
> - (5) Index keys can be of any length and can be of different lengths.
> +5. Index keys can be of any length and can be of different lengths.
>  
> - (6) Index keys should encode the length early on, before any variation due to
> -     length is seen.
> +6. Index keys should encode the length early on, before any variation due to
> +   length is seen.
>  
> - (7) Index keys can include a hash to scatter objects throughout the array.
> +7. Index keys can include a hash to scatter objects throughout the array.
>  
> - (8) The array can iterated over.  The objects will not necessarily come out in
> -     key order.
> +8. The array can iterated over.  The objects will not necessarily come out in
> +   key order.
>  
> - (9) The array can be iterated over whilst it is being modified, provided the
> -     RCU readlock is being held by the iterator.  Note, however, under these
> -     circumstances, some objects may be seen more than once.  If this is a
> -     problem, the iterator should lock against modification.  Objects will not
> -     be missed, however, unless deleted.
> +9. The array can be iterated over whilst it is being modified, provided the
> +   RCU readlock is being held by the iterator.  Note, however, under these
> +   circumstances, some objects may be seen more than once.  If this is a
> +   problem, the iterator should lock against modification.  Objects will not
> +   be missed, however, unless deleted.
>  
> -(10) Objects in the array can be looked up by means of their index key.
> +10. Objects in the array can be looked up by means of their index key.
>  
> -(11) Objects can be looked up whilst the array is being modified, provided the
> -     RCU readlock is being held by the thread doing the look up.
> +11. Objects can be looked up whilst the array is being modified, provided the
> +    RCU readlock is being held by the thread doing the look up.
>  
>  The implementation uses a tree of 16-pointer nodes internally that are indexed
>  on each level by nibbles from the index key in the same manner as in a radix
> @@ -71,25 +50,26 @@ pack leaf object pointers into spare space in the node rather than making an
>  extra branch until as such time an object needs to be added to a full node.
>  
>  
> +The Public API
>  ==============
> -THE PUBLIC API
> -==============
>  
> -The public API can be found in <linux/assoc_array.h>.  The associative array is
> -rooted on the following structure:
> +The public API can be found in ``<linux/assoc_array.h>``.  The associative
> +array is rooted on the following structure::
> +
> +    struct assoc_array {
> +            ...
> +    };
>  
> -	struct assoc_array {
> -		...
> -	};
> +The code is selected by enabling ``CONFIG_ASSOCIATIVE_ARRAY`` with::
>  
> -The code is selected by enabling CONFIG_ASSOCIATIVE_ARRAY.
> +    ./script/config -e ASSOCIATIVE_ARRAY
>  
>  
> -EDIT SCRIPT
> +Edit Script
>  -----------
>  
>  The insertion and deletion functions produce an 'edit script' that can later be
> -applied to effect the changes without risking ENOMEM.  This retains the
> +applied to effect the changes without risking ``ENOMEM``. This retains the
>  preallocated metadata blocks that will be installed in the internal tree and
>  keeps track of the metadata blocks that will be removed from the tree when the
>  script is applied.
> @@ -99,246 +79,245 @@ script has been applied so that they can be freed later.  The freeing is done
>  after an RCU grace period has passed - thus allowing access functions to
>  proceed under the RCU read lock.
>  
> -The script appears as outside of the API as a pointer of the type:
> +The script appears as outside of the API as a pointer of the type::
>  
> -	struct assoc_array_edit;
> +    struct assoc_array_edit;
>  
>  There are two functions for dealing with the script:
>  
> - (1) Apply an edit script.
> +1. Apply an edit script::
>  
> -	void assoc_array_apply_edit(struct assoc_array_edit *edit);
> +    void assoc_array_apply_edit(struct assoc_array_edit *edit);
>  
> -     This will perform the edit functions, interpolating various write barriers
> -     to permit accesses under the RCU read lock to continue.  The edit script
> -     will then be passed to call_rcu() to free it and any dead stuff it points
> -     to.
> +This will perform the edit functions, interpolating various write barriers
> +to permit accesses under the RCU read lock to continue.  The edit script
> +will then be passed to ``call_rcu()`` to free it and any dead stuff it points
> +to.
>  
> - (2) Cancel an edit script.
> +2. Cancel an edit script::
>  
> -	void assoc_array_cancel_edit(struct assoc_array_edit *edit);
> +    void assoc_array_cancel_edit(struct assoc_array_edit *edit);
>  
> -     This frees the edit script and all preallocated memory immediately.  If
> -     this was for insertion, the new object is _not_ released by this function,
> -     but must rather be released by the caller.
> +This frees the edit script and all preallocated memory immediately. If
> +this was for insertion, the new object is _not_ released by this function,
> +but must rather be released by the caller.
>  
>  These functions are guaranteed not to fail.
>  
>  
> -OPERATIONS TABLE
> +Operations Table
>  ----------------
>  
> -Various functions take a table of operations:
> +Various functions take a table of operations::
>  
> -	struct assoc_array_ops {
> -		...
> -	};
> +    struct assoc_array_ops {
> +            ...
> +    };
>  
>  This points to a number of methods, all of which need to be provided:
>  
> - (1) Get a chunk of index key from caller data:
> +1. Get a chunk of index key from caller data::
>  
> -	unsigned long (*get_key_chunk)(const void *index_key, int level);
> +    unsigned long (*get_key_chunk)(const void *index_key, int level);
>  
> -     This should return a chunk of caller-supplied index key starting at the
> -     *bit* position given by the level argument.  The level argument will be a
> -     multiple of ASSOC_ARRAY_KEY_CHUNK_SIZE and the function should return
> -     ASSOC_ARRAY_KEY_CHUNK_SIZE bits.  No error is possible.
> +This should return a chunk of caller-supplied index key starting at the
> +*bit* position given by the level argument.  The level argument will be a
> +multiple of ``ASSOC_ARRAY_KEY_CHUNK_SIZE`` and the function should return
> +``ASSOC_ARRAY_KEY_CHUNK_SIZE bits``.  No error is possible.
>  
>  
> - (2) Get a chunk of an object's index key.
> +2. Get a chunk of an object's index key::
>  
> -	unsigned long (*get_object_key_chunk)(const void *object, int level);
> +    unsigned long (*get_object_key_chunk)(const void *object, int level);
>  
> -     As the previous function, but gets its data from an object in the array
> -     rather than from a caller-supplied index key.
> +As the previous function, but gets its data from an object in the array
> +rather than from a caller-supplied index key.
>  
>  
> - (3) See if this is the object we're looking for.
> +3. See if this is the object we're looking for::
>  
> -	bool (*compare_object)(const void *object, const void *index_key);
> +    bool (*compare_object)(const void *object, const void *index_key);
>  
> -     Compare the object against an index key and return true if it matches and
> -     false if it doesn't.
> +Compare the object against an index key and return ``true`` if it matches and
> +``false`` if it doesn't.
>  
>  
> - (4) Diff the index keys of two objects.
> +4. Diff the index keys of two objects::
>  
> -	int (*diff_objects)(const void *object, const void *index_key);
> +    int (*diff_objects)(const void *object, const void *index_key);
>  
> -     Return the bit position at which the index key of the specified object
> -     differs from the given index key or -1 if they are the same.
> +Return the bit position at which the index key of the specified object
> +differs from the given index key or -1 if they are the same.
>  
>  
> - (5) Free an object.
> +5. Free an object::
>  
> -	void (*free_object)(void *object);
> +    void (*free_object)(void *object);
>  
> -     Free the specified object.  Note that this may be called an RCU grace
> -     period after assoc_array_apply_edit() was called, so synchronize_rcu() may
> -     be necessary on module unloading.
> +Free the specified object.  Note that this may be called an RCU grace period
> +after ``assoc_array_apply_edit()`` was called, so ``synchronize_rcu()`` may be
> +necessary on module unloading.
>  
>  
> -MANIPULATION FUNCTIONS
> +Manipulation Functions
>  ----------------------
>  
>  There are a number of functions for manipulating an associative array:
>  
> - (1) Initialise an associative array.
> +1. Initialise an associative array::
>  
> -	void assoc_array_init(struct assoc_array *array);
> +    void assoc_array_init(struct assoc_array *array);
>  
> -     This initialises the base structure for an associative array.  It can't
> -     fail.
> +This initialises the base structure for an associative array.  It can't fail.
>  
>  
> - (2) Insert/replace an object in an associative array.
> +2. Insert/replace an object in an associative array::
>  
> -	struct assoc_array_edit *
> -	assoc_array_insert(struct assoc_array *array,
> -			   const struct assoc_array_ops *ops,
> -			   const void *index_key,
> -			   void *object);
> +    struct assoc_array_edit *
> +    assoc_array_insert(struct assoc_array *array,
> +                       const struct assoc_array_ops *ops,
> +                       const void *index_key,
> +                       void *object);
>  
> -     This inserts the given object into the array.  Note that the least
> -     significant bit of the pointer must be zero as it's used to type-mark
> -     pointers internally.
> +This inserts the given object into the array.  Note that the least
> +significant bit of the pointer must be zero as it's used to type-mark
> +pointers internally.
>  
> -     If an object already exists for that key then it will be replaced with the
> -     new object and the old one will be freed automatically.
> +If an object already exists for that key then it will be replaced with the
> +new object and the old one will be freed automatically.
>  
> -     The index_key argument should hold index key information and is
> -     passed to the methods in the ops table when they are called.
> +The ``index_key`` argument should hold index key information and is
> +passed to the methods in the ops table when they are called.
>  
> -     This function makes no alteration to the array itself, but rather returns
> -     an edit script that must be applied.  -ENOMEM is returned in the case of
> -     an out-of-memory error.
> +This function makes no alteration to the array itself, but rather returns
> +an edit script that must be applied.  ``-ENOMEM`` is returned in the case of
> +an out-of-memory error.
>  
> -     The caller should lock exclusively against other modifiers of the array.
> +The caller should lock exclusively against other modifiers of the array.
>  
>  
> - (3) Delete an object from an associative array.
> +3. Delete an object from an associative array::
>  
> -	struct assoc_array_edit *
> -	assoc_array_delete(struct assoc_array *array,
> -			   const struct assoc_array_ops *ops,
> -			   const void *index_key);
> +    struct assoc_array_edit *
> +    assoc_array_delete(struct assoc_array *array,
> +                       const struct assoc_array_ops *ops,
> +                       const void *index_key);
>  
> -     This deletes an object that matches the specified data from the array.
> +This deletes an object that matches the specified data from the array.
>  
> -     The index_key argument should hold index key information and is
> -     passed to the methods in the ops table when they are called.
> +The ``index_key`` argument should hold index key information and is
> +passed to the methods in the ops table when they are called.
>  
> -     This function makes no alteration to the array itself, but rather returns
> -     an edit script that must be applied.  -ENOMEM is returned in the case of
> -     an out-of-memory error.  NULL will be returned if the specified object is
> -     not found within the array.
> +This function makes no alteration to the array itself, but rather returns
> +an edit script that must be applied.  ``-ENOMEM`` is returned in the case of
> +an out-of-memory error.  ``NULL`` will be returned if the specified object is
> +not found within the array.
>  
> -     The caller should lock exclusively against other modifiers of the array.
> +The caller should lock exclusively against other modifiers of the array.
>  
>  
> - (4) Delete all objects from an associative array.
> +4. Delete all objects from an associative array::
>  
> -	struct assoc_array_edit *
> -	assoc_array_clear(struct assoc_array *array,
> -			  const struct assoc_array_ops *ops);
> +    struct assoc_array_edit *
> +    assoc_array_clear(struct assoc_array *array,
> +                      const struct assoc_array_ops *ops);
>  
> -     This deletes all the objects from an associative array and leaves it
> -     completely empty.
> +This deletes all the objects from an associative array and leaves it
> +completely empty.
>  
> -     This function makes no alteration to the array itself, but rather returns
> -     an edit script that must be applied.  -ENOMEM is returned in the case of
> -     an out-of-memory error.
> +This function makes no alteration to the array itself, but rather returns
> +an edit script that must be applied.  ``-ENOMEM`` is returned in the case of
> +an out-of-memory error.
>  
> -     The caller should lock exclusively against other modifiers of the array.
> +The caller should lock exclusively against other modifiers of the array.
>  
>  
> - (5) Destroy an associative array, deleting all objects.
> +5. Destroy an associative array, deleting all objects::
>  
> -	void assoc_array_destroy(struct assoc_array *array,
> -				 const struct assoc_array_ops *ops);
> +    void assoc_array_destroy(struct assoc_array *array,
> +                             const struct assoc_array_ops *ops);
>  
> -     This destroys the contents of the associative array and leaves it
> -     completely empty.  It is not permitted for another thread to be traversing
> -     the array under the RCU read lock at the same time as this function is
> -     destroying it as no RCU deferral is performed on memory release -
> -     something that would require memory to be allocated.
> +This destroys the contents of the associative array and leaves it
> +completely empty.  It is not permitted for another thread to be traversing
> +the array under the RCU read lock at the same time as this function is
> +destroying it as no RCU deferral is performed on memory release -
> +something that would require memory to be allocated.
>  
> -     The caller should lock exclusively against other modifiers and accessors
> -     of the array.
> +The caller should lock exclusively against other modifiers and accessors
> +of the array.
>  
>  
> - (6) Garbage collect an associative array.
> +6. Garbage collect an associative array::
>  
> -	int assoc_array_gc(struct assoc_array *array,
> -			   const struct assoc_array_ops *ops,
> -			   bool (*iterator)(void *object, void *iterator_data),
> -			   void *iterator_data);
> +    int assoc_array_gc(struct assoc_array *array,
> +                       const struct assoc_array_ops *ops,
> +                       bool (*iterator)(void *object, void *iterator_data),
> +                       void *iterator_data);
>  
> -     This iterates over the objects in an associative array and passes each one
> -     to iterator().  If iterator() returns true, the object is kept.  If it
> -     returns false, the object will be freed.  If the iterator() function
> -     returns true, it must perform any appropriate refcount incrementing on the
> -     object before returning.
> +This iterates over the objects in an associative array and passes each one to
> +``iterator()``.  If ``iterator()`` returns ``true``, the object is kept.  If it
> +returns ``false``, the object will be freed.  If the ``iterator()`` function
> +returns ``true``, it must perform any appropriate refcount incrementing on the
> +object before returning.
>  
> -     The internal tree will be packed down if possible as part of the iteration
> -     to reduce the number of nodes in it.
> +The internal tree will be packed down if possible as part of the iteration
> +to reduce the number of nodes in it.
>  
> -     The iterator_data is passed directly to iterator() and is otherwise
> -     ignored by the function.
> +The ``iterator_data`` is passed directly to ``iterator()`` and is otherwise
> +ignored by the function.
>  
> -     The function will return 0 if successful and -ENOMEM if there wasn't
> -     enough memory.
> +The function will return ``0`` if successful and ``-ENOMEM`` if there wasn't
> +enough memory.
>  
> -     It is possible for other threads to iterate over or search the array under
> -     the RCU read lock whilst this function is in progress.  The caller should
> -     lock exclusively against other modifiers of the array.
> +It is possible for other threads to iterate over or search the array under
> +the RCU read lock whilst this function is in progress.  The caller should
> +lock exclusively against other modifiers of the array.
>  
>  
> -ACCESS FUNCTIONS
> +Access Functions
>  ----------------
>  
>  There are two functions for accessing an associative array:
>  
> - (1) Iterate over all the objects in an associative array.
> +1. Iterate over all the objects in an associative array::
>  
> -	int assoc_array_iterate(const struct assoc_array *array,
> -				int (*iterator)(const void *object,
> -						void *iterator_data),
> -				void *iterator_data);
> +    int assoc_array_iterate(const struct assoc_array *array,
> +                            int (*iterator)(const void *object,
> +                                            void *iterator_data),
> +                            void *iterator_data);
>  
> -     This passes each object in the array to the iterator callback function.
> -     iterator_data is private data for that function.
> +This passes each object in the array to the iterator callback function.
> +``iterator_data`` is private data for that function.
>  
> -     This may be used on an array at the same time as the array is being
> -     modified, provided the RCU read lock is held.  Under such circumstances,
> -     it is possible for the iteration function to see some objects twice.  If
> -     this is a problem, then modification should be locked against.  The
> -     iteration algorithm should not, however, miss any objects.
> +This may be used on an array at the same time as the array is being
> +modified, provided the RCU read lock is held.  Under such circumstances,
> +it is possible for the iteration function to see some objects twice.  If
> +this is a problem, then modification should be locked against.  The
> +iteration algorithm should not, however, miss any objects.
>  
> -     The function will return 0 if no objects were in the array or else it will
> -     return the result of the last iterator function called.  Iteration stops
> -     immediately if any call to the iteration function results in a non-zero
> -     return.
> +The function will return ``0`` if no objects were in the array or else it will
> +return the result of the last iterator function called.  Iteration stops
> +immediately if any call to the iteration function results in a non-zero
> +return.
>  
>  
> - (2) Find an object in an associative array.
> +2. Find an object in an associative array::
>  
> -	void *assoc_array_find(const struct assoc_array *array,
> -			       const struct assoc_array_ops *ops,
> -			       const void *index_key);
> +    void *assoc_array_find(const struct assoc_array *array,
> +                           const struct assoc_array_ops *ops,
> +                           const void *index_key);
>  
> -     This walks through the array's internal tree directly to the object
> -     specified by the index key..
> +This walks through the array's internal tree directly to the object
> +specified by the index key..
>  
> -     This may be used on an array at the same time as the array is being
> -     modified, provided the RCU read lock is held.
> +This may be used on an array at the same time as the array is being
> +modified, provided the RCU read lock is held.
>  
> -     The function will return the object if found (and set *_type to the object
> -     type) or will return NULL if the object was not found.
> +The function will return the object if found (and set ``*_type`` to the object
> +type) or will return ``NULL`` if the object was not found.
>  
>  
> -INDEX KEY FORM
> +Index Key Form
>  --------------
>  
>  The index key can be of any form, but since the algorithms aren't told how long
> @@ -364,8 +343,7 @@ unlikely that more than one word of any particular index key will have to be
>  used.
>  
>  
> -=================
> -INTERNAL WORKINGS
> +Internal Workings
>  =================
>  
>  The associative array data structure has an internal tree.  This tree is
> @@ -373,82 +351,80 @@ constructed of two types of metadata blocks: nodes and shortcuts.
>  
>  A node is an array of slots.  Each slot can contain one of four things:
>  
> - (*) A NULL pointer, indicating that the slot is empty.
> -
> - (*) A pointer to an object (a leaf).
> -
> - (*) A pointer to a node at the next level.
> -
> - (*) A pointer to a shortcut.
> +* A NULL pointer, indicating that the slot is empty.
> +* A pointer to an object (a leaf).
> +* A pointer to a node at the next level.
> +* A pointer to a shortcut.
>  
>  
> -BASIC INTERNAL TREE LAYOUT
> +Basic Internal Tree Layout
>  --------------------------
>  
>  Ignoring shortcuts for the moment, the nodes form a multilevel tree.  The index
>  key space is strictly subdivided by the nodes in the tree and nodes occur on
> -fixed levels.  For example:
> -
> - Level:	0		1		2		3
> -	===============	===============	===============	===============
> -							NODE D
> -			NODE B		NODE C	+------>+---+
> -		+------>+---+	+------>+---+	|	| 0 |
> -	NODE A	|	| 0 |	|	| 0 |	|	+---+
> -	+---+	|	+---+	|	+---+	|	:   :
> -	| 0 |	|	:   :	|	:   :	|	+---+
> -	+---+	|	+---+	|	+---+	|	| f |
> -	| 1 |---+	| 3 |---+	| 7 |---+	+---+
> -	+---+		+---+		+---+
> -	:   :		:   :		| 8 |---+
> -	+---+		+---+		+---+	|	NODE E
> -	| e |---+	| f |		:   :   +------>+---+
> -	+---+	|	+---+		+---+		| 0 |
> -	| f |	|			| f |		+---+
> -	+---+	|			+---+		:   :
> -		|	NODE F				+---+
> -		+------>+---+				| f |
> -			| 0 |		NODE G		+---+
> -			+---+	+------>+---+
> -			:   :	|	| 0 |
> -			+---+	|	+---+
> -			| 6 |---+	:   :
> -			+---+		+---+
> -			:   :		| f |
> -			+---+		+---+
> -			| f |
> -			+---+
> +fixed levels.  For example::
> +
> + Level: 0               1               2               3
> +        =============== =============== =============== ===============
> +                                                        NODE D
> +                        NODE B          NODE C  +------>+---+
> +                +------>+---+   +------>+---+   |       | 0 |
> +        NODE A  |       | 0 |   |       | 0 |   |       +---+
> +        +---+   |       +---+   |       +---+   |       :   :
> +        | 0 |   |       :   :   |       :   :   |       +---+
> +        +---+   |       +---+   |       +---+   |       | f |
> +        | 1 |---+       | 3 |---+       | 7 |---+       +---+
> +        +---+           +---+           +---+
> +        :   :           :   :           | 8 |---+
> +        +---+           +---+           +---+   |       NODE E
> +        | e |---+       | f |           :   :   +------>+---+
> +        +---+   |       +---+           +---+           | 0 |
> +        | f |   |                       | f |           +---+
> +        +---+   |                       +---+           :   :
> +                |       NODE F                          +---+
> +                +------>+---+                           | f |
> +                        | 0 |           NODE G          +---+
> +                        +---+   +------>+---+
> +                        :   :   |       | 0 |
> +                        +---+   |       +---+
> +                        | 6 |---+       :   :
> +                        +---+           +---+
> +                        :   :           | f |
> +                        +---+           +---+
> +                        | f |
> +                        +---+
>  
>  In the above example, there are 7 nodes (A-G), each with 16 slots (0-f).
> -Assuming no other meta data nodes in the tree, the key space is divided thusly:
> -
> -	KEY PREFIX	NODE
> -	==========	====
> -	137*		D
> -	138*		E
> -	13[0-69-f]*	C
> -	1[0-24-f]*	B
> -	e6*		G
> -	e[0-57-f]*	F
> -	[02-df]*	A
> +Assuming no other meta data nodes in the tree, the key space is divided
> +thusly::
> +
> +    KEY PREFIX      NODE
> +    ==========      ====
> +    137*            D
> +    138*            E
> +    13[0-69-f]*     C
> +    1[0-24-f]*      B
> +    e6*             G
> +    e[0-57-f]*      F
> +    [02-df]*        A
>  
>  So, for instance, keys with the following example index keys will be found in
> -the appropriate nodes:
> -
> -	INDEX KEY	PREFIX	NODE
> -	===============	=======	====
> -	13694892892489	13	C
> -	13795289025897	137	D
> -	13889dde88793	138	E
> -	138bbb89003093	138	E
> -	1394879524789	12	C
> -	1458952489	1	B
> -	9431809de993ba	-	A
> -	b4542910809cd	-	A
> -	e5284310def98	e	F
> -	e68428974237	e6	G
> -	e7fffcbd443	e	F
> -	f3842239082	-	A
> +the appropriate nodes::
> +
> +    INDEX KEY       PREFIX  NODE
> +    =============== ======= ====
> +    13694892892489  13      C
> +    13795289025897  137     D
> +    13889dde88793   138     E
> +    138bbb89003093  138     E
> +    1394879524789   12      C
> +    1458952489      1       B
> +    9431809de993ba  -       A
> +    b4542910809cd   -       A
> +    e5284310def98   e       F
> +    e68428974237    e6      G
> +    e7fffcbd443     e       F
> +    f3842239082     -       A
>  
>  To save memory, if a node can hold all the leaves in its portion of keyspace,
>  then the node will have all those leaves in it and will not have any metadata
> @@ -462,23 +438,23 @@ metadata pointer.  If the metadata pointer is there, any leaf whose key matches
>  the metadata key prefix must be in the subtree that the metadata pointer points
>  to.
>  
> -In the above example list of index keys, node A will contain:
> +In the above example list of index keys, node A will contain::
>  
> -	SLOT	CONTENT		INDEX KEY (PREFIX)
> -	====	===============	==================
> -	1	PTR TO NODE B	1*
> -	any	LEAF		9431809de993ba
> -	any	LEAF		b4542910809cd
> -	e	PTR TO NODE F	e*
> -	any	LEAF		f3842239082
> +    SLOT    CONTENT         INDEX KEY (PREFIX)
> +    ====    =============== ==================
> +    1       PTR TO NODE B   1*
> +    any     LEAF            9431809de993ba
> +    any     LEAF            b4542910809cd
> +    e       PTR TO NODE F   e*
> +    any     LEAF            f3842239082
>  
> -and node B:
> +and node B::
>  
> -	3	PTR TO NODE C	13*
> -	any	LEAF		1458952489
> +    3	PTR TO NODE C	13*
> +    any	LEAF		1458952489
>  
>  
> -SHORTCUTS
> +Shortcuts
>  ---------
>  
>  Shortcuts are metadata records that jump over a piece of keyspace.  A shortcut
> @@ -486,12 +462,13 @@ is a replacement for a series of single-occupancy nodes ascending through the
>  levels.  Shortcuts exist to save memory and to speed up traversal.
>  
>  It is possible for the root of the tree to be a shortcut - say, for example,
> -the tree contains at least 17 nodes all with key prefix '1111'.  The insertion
> -algorithm will insert a shortcut to skip over the '1111' keyspace in a single
> -bound and get to the fourth level where these actually become different.
> +the tree contains at least 17 nodes all with key prefix ``1111``.  The
> +insertion algorithm will insert a shortcut to skip over the ``1111`` keyspace
> +in a single bound and get to the fourth level where these actually become
> +different.
>  
>  
> -SPLITTING AND COLLAPSING NODES
> +Splitting And Collapsing Nodes
>  ------------------------------
>  
>  Each node has a maximum capacity of 16 leaves and metadata pointers.  If the
> @@ -508,7 +485,7 @@ fewer, then the subtree will be collapsed down to a single node - and this will
>  ripple towards the root if possible.
>  
>  
> -NON-RECURSIVE ITERATION
> +Non-Recursive Iteration
>  -----------------------
>  
>  Each node and shortcut contains a back pointer to its parent and the number of
> @@ -519,55 +496,55 @@ make sure progress is made without the need for a stack.
>  The backpointers, however, make simultaneous alteration and iteration tricky.
>  
>  
> -SIMULTANEOUS ALTERATION AND ITERATION
> +Simultaneous Alteration And Iteration
>  -------------------------------------
>  
>  There are a number of cases to consider:
>  
> - (1) Simple insert/replace.  This involves simply replacing a NULL or old
> -     matching leaf pointer with the pointer to the new leaf after a barrier.
> -     The metadata blocks don't change otherwise.  An old leaf won't be freed
> -     until after the RCU grace period.
> -
> - (2) Simple delete.  This involves just clearing an old matching leaf.  The
> -     metadata blocks don't change otherwise.  The old leaf won't be freed until
> -     after the RCU grace period.
> -
> - (3) Insertion replacing part of a subtree that we haven't yet entered.  This
> -     may involve replacement of part of that subtree - but that won't affect
> -     the iteration as we won't have reached the pointer to it yet and the
> -     ancestry blocks are not replaced (the layout of those does not change).
> -
> - (4) Insertion replacing nodes that we're actively processing.  This isn't a
> -     problem as we've passed the anchoring pointer and won't switch onto the
> -     new layout until we follow the back pointers - at which point we've
> -     already examined the leaves in the replaced node (we iterate over all the
> -     leaves in a node before following any of its metadata pointers).
> -
> -     We might, however, re-see some leaves that have been split out into a new
> -     branch that's in a slot further along than we were at.
> -
> - (5) Insertion replacing nodes that we're processing a dependent branch of.
> -     This won't affect us until we follow the back pointers.  Similar to (4).
> -
> - (6) Deletion collapsing a branch under us.  This doesn't affect us because the
> -     back pointers will get us back to the parent of the new node before we
> -     could see the new node.  The entire collapsed subtree is thrown away
> -     unchanged - and will still be rooted on the same slot, so we shouldn't
> -     process it a second time as we'll go back to slot + 1.
> -
> -Note:
> -
> - (*) Under some circumstances, we need to simultaneously change the parent
> -     pointer and the parent slot pointer on a node (say, for example, we
> -     inserted another node before it and moved it up a level).  We cannot do
> -     this without locking against a read - so we have to replace that node too.
> -
> -     However, when we're changing a shortcut into a node this isn't a problem
> -     as shortcuts only have one slot and so the parent slot number isn't used
> -     when traversing backwards over one.  This means that it's okay to change
> -     the slot number first - provided suitable barriers are used to make sure
> -     the parent slot number is read after the back pointer.
> +1. Simple insert/replace.  This involves simply replacing a NULL or old
> +   matching leaf pointer with the pointer to the new leaf after a barrier.
> +   The metadata blocks don't change otherwise.  An old leaf won't be freed
> +   until after the RCU grace period.
> +
> +2. Simple delete.  This involves just clearing an old matching leaf.  The
> +   metadata blocks don't change otherwise.  The old leaf won't be freed until
> +   after the RCU grace period.
> +
> +3. Insertion replacing part of a subtree that we haven't yet entered.  This
> +   may involve replacement of part of that subtree - but that won't affect
> +   the iteration as we won't have reached the pointer to it yet and the
> +   ancestry blocks are not replaced (the layout of those does not change).
> +
> +4. Insertion replacing nodes that we're actively processing.  This isn't a
> +   problem as we've passed the anchoring pointer and won't switch onto the
> +   new layout until we follow the back pointers - at which point we've
> +   already examined the leaves in the replaced node (we iterate over all the
> +   leaves in a node before following any of its metadata pointers).
> +
> +   We might, however, re-see some leaves that have been split out into a new
> +   branch that's in a slot further along than we were at.
> +
> +5. Insertion replacing nodes that we're processing a dependent branch of.
> +   This won't affect us until we follow the back pointers.  Similar to (4).
> +
> +6. Deletion collapsing a branch under us.  This doesn't affect us because the
> +   back pointers will get us back to the parent of the new node before we
> +   could see the new node.  The entire collapsed subtree is thrown away
> +   unchanged - and will still be rooted on the same slot, so we shouldn't
> +   process it a second time as we'll go back to slot + 1.
> +
> +.. note::
> +
> +   Under some circumstances, we need to simultaneously change the parent
> +   pointer and the parent slot pointer on a node (say, for example, we
> +   inserted another node before it and moved it up a level).  We cannot do
> +   this without locking against a read - so we have to replace that node too.
> +
> +   However, when we're changing a shortcut into a node this isn't a problem
> +   as shortcuts only have one slot and so the parent slot number isn't used
> +   when traversing backwards over one.  This means that it's okay to change
> +   the slot number first - provided suitable barriers are used to make sure
> +   the parent slot number is read after the back pointer.
>  
>  Obsolete blocks and leaves are freed up after an RCU grace period has passed,
>  so as long as anyone doing walking or iteration holds the RCU read lock, the
> diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
> index f7ef7fd..480d9a3 100644
> --- a/Documentation/core-api/index.rst
> +++ b/Documentation/core-api/index.rst
> @@ -7,6 +7,7 @@ Kernel and driver related documentation.
>  .. toctree::
>     :maxdepth: 1
>  
> +   assoc_array
>     workqueue
>  
>  .. only::  subproject



Thanks,
Mauro

[toc] | [prev] | [next] | [standalone]

#1530557 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Fri, Nov 25, 2016 at 03:59:45PM +0100, Silvio Fricke wrote:
> ... and move to core-api folder.
> 
> Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
> ---
>  Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | 777 +++++++++++++++++++++++++++++++++++++-----------------------------------
>  Documentation/core-api/index.rst                                      |   1 +-
>  Documentation/process/volatile-considered-harmful.rst                 |   3 +-
>  3 files changed, 404 insertions(+), 377 deletions(-)

Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
wouldn't want to edit a .rst file.

Then again, I probably won't actually get around to fixing this document
any time soon either.

But if and when I would get around to it, I'll have to change it back to
a regular .txt file.

[toc] | [prev] | [next] | [standalone]

#1530882 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Hi Peter,

> On Fri, Nov 25, 2016 at 03:59:45PM +0100, Silvio Fricke wrote:
> > ... and move to core-api folder.
> > 
> > Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
> > ---
> >  Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | 777 +++++++++++++++++++++++++++++++++++++-----------------------------------
> >  Documentation/core-api/index.rst                                      |   1 +-
> >  Documentation/process/volatile-considered-harmful.rst                 |   3 +-
> >  3 files changed, 404 insertions(+), 377 deletions(-)
> 
> Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
> wouldn't want to edit a .rst file.

What is the problem with this rst-file? atomic_ops.rst are not so different to
the txt variant.


I will drop this patch.

Best regards,
Silvio


-- 
-- S. Fricke ---------------------------------------- silvio@port1024.net --
   Diplom-Informatiker (FH)
   Linux-Development                         Matrix: @silvio:port1024.net   
----------------------------------------------------------------------------

[toc] | [prev] | [next] | [standalone]

#1530915 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Sun, 27 Nov 2016, "S. Fricke" <silvio.fricke@gmail.com> wrote:
> Hi Peter,
>
>> On Fri, Nov 25, 2016 at 03:59:45PM +0100, Silvio Fricke wrote:
>> > ... and move to core-api folder.
>> > 
>> > Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com>
>> > ---
>> >  Documentation/atomic_ops.txt => Documentation/core-api/atomic_ops.rst | 777 +++++++++++++++++++++++++++++++++++++-----------------------------------
>> >  Documentation/core-api/index.rst                                      |   1 +-
>> >  Documentation/process/volatile-considered-harmful.rst                 |   3 +-
>> >  3 files changed, 404 insertions(+), 377 deletions(-)
>> 
>> Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
>> wouldn't want to edit a .rst file.
>
> What is the problem with this rst-file? atomic_ops.rst are not so
> different to the txt variant.

There is nothing particularly wrong with the patch. Perhaps you could
leave the tabs in place instead of indenting with spaces in the code
blocks. It would result in a smaller diff. But other than that, it's
fine.

I'm sure Peter is capable of editing a file with a .rst extension, and
we can clean up any hickups afterwards if getting the formatting right
is insurmountable.

> I will drop this patch.

Please don't. Please let Jon be the judge of that.

Thanks,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]

#1530964 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Fri, 25 Nov 2016 22:58:14 +0100
Peter Zijlstra <peterz@infradead.org> wrote:

> Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
> wouldn't want to edit a .rst file.
> 
> Then again, I probably won't actually get around to fixing this document
> any time soon either.
> 
> But if and when I would get around to it, I'll have to change it back to
> a regular .txt file.

Peter, could you please describe what the trouble with RST is?  Most of
the files in Documentation/ are already almost in RST format; should we
change them to something else? :)

Silvio, one thing that might help would be to redo the patch with a
minimum of changes and, in particular, a minimum of unnecessary markup.
Yes, it's better to put literal strings in monospace, but we don't have
to, and getting rid of a lot of ``funny quotes`` makes the changes a lot
less intrusive.

jon

[toc] | [prev] | [next] | [standalone]

#1531075 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Sun, Nov 27, 2016 at 04:59:14PM -0700, Jonathan Corbet wrote:
> On Fri, 25 Nov 2016 22:58:14 +0100
> Peter Zijlstra <peterz@infradead.org> wrote:
> 
> > Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
> > wouldn't want to edit a .rst file.
> > 
> > Then again, I probably won't actually get around to fixing this document
> > any time soon either.
> > 
> > But if and when I would get around to it, I'll have to change it back to
> > a regular .txt file.
> 
> Peter, could you please describe what the trouble with RST is? 

Mostly that its not txt. I don't know what RST is, and I frankly don't
care. For me changing this is 'make work', and I really don't need that.

Changing this away from txt will simply make want to write documentation
less, because it means having to figure out wtf RST is first, which
means I'll simply won't do it.

> Most of
> the files in Documentation/ are already almost in RST format; should we
> change them to something else? :)

Why change them? What was wrong with txt to begin with?

[toc] | [prev] | [next] | [standalone]

#1531124 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 08:26:26AM +0100, Peter Zijlstra wrote:
> On Sun, Nov 27, 2016 at 04:59:14PM -0700, Jonathan Corbet wrote:
> > On Fri, 25 Nov 2016 22:58:14 +0100
> > Peter Zijlstra <peterz@infradead.org> wrote:
> > 
> > > Not a fan of this. The atomic_ops.txt file needs a lot of love, and I
> > > wouldn't want to edit a .rst file.
> > > 
> > > Then again, I probably won't actually get around to fixing this document
> > > any time soon either.
> > > 
> > > But if and when I would get around to it, I'll have to change it back to
> > > a regular .txt file.

I definitely don't want to make rst/sphinx a pain for anyone, so very much
welcome your feedback.

> > Peter, could you please describe what the trouble with RST is? 
> 
> Mostly that its not txt. I don't know what RST is, and I frankly don't
> care. For me changing this is 'make work', and I really don't need that.
> 
> Changing this away from txt will simply make want to write documentation
> less, because it means having to figure out wtf RST is first, which
> means I'll simply won't do it.

I don't think you have to care at all. We've converted thousands of pages
of entirely free-form .txt to .rst, and sphinx/rst happily parsed it all.
There's the occasional warning, and 0day will report them. But if you
don't want to care, then you can choose not to care at all here. The
checkpatch/warning police is already picking up on these, so they will get
fixed. And if that's too much, then you can also ignore those.
> > Most of
> > the files in Documentation/ are already almost in RST format; should we
> > change them to something else? :)
> 
> Why change them? What was wrong with txt to begin with?

In my opinion good docs matter, and one of the key things is to be able to
cross reference stuff. And I'd really like to be able to cross-reference
to all the core kernel stuff (locks, atomics, workers, timers, all of
these) from my driver/subsystem docs.

This isn't something you or I ever really will use, but in my experience
it is rather useful for people newly reading into a subsystem. And getting
new folks on board (at least in subsystems like DRM where we're
chronically understaffed for everything) matters.

Given that I hope the change in file-ending from .txt to .rst is ok with
you, and it won't stop you from updating the docs. If not that'd be bad,
since imo anything that makes it harder to type good docs is bad.

Another concern some core kernel folks raised is that the .rst markup was
too heavy-handed, and makes the text much harder to read. Christoph called
it "cat spew". That can be fixed with a much lighter-handed conversion
(and 2nd patch iteration was acceptable for Christoph). In this patch the
biggest part seems to be the indent shift on the code snippets, and it'd
be good to keep those to tell sphinx to fixed-width layout them. But a lot
of the other stuff really doesn't need to be if it bothers you.

Thanks, Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

[toc] | [prev] | [next] | [standalone]

#1531186 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote:

> > 
> > Why change them? What was wrong with txt to begin with?
> 
> In my opinion good docs matter, and one of the key things is to be able to
> cross reference stuff.

Well, good docs begin with useful content; and many docs lack that.
Fixing that would be a much more useful thing to do.

In any case, I've never had any problems with typing things like: "go
read: Documentation/file.txt for more information.".

Also, what text editor supports cross references at all then? With the
filename I can use 'gf' in vim to open it up in a new buffer and go read
that.

> Another concern some core kernel folks raised is that the .rst markup was
> too heavy-handed, and makes the text much harder to read. Christoph called
> it "cat spew". That can be fixed with a much lighter-handed conversion
> (and 2nd patch iteration was acceptable for Christoph).

Very much agreed, once a file is no longer readable with less or the
text editor of your choice, it as good doesn't exist at all. So I very
much worry about RST even supporting such heavy markup that the end
result is unreadable.

Basically, if a file isn't usable from within a 'normal' text editor, it
doesn't exist.

[toc] | [prev] | [next] | [standalone]

#1531211 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Em Mon, 28 Nov 2016 11:20:09 +0100
Peter Zijlstra <peterz@infradead.org> escreveu:

> On Mon, Nov 28, 2016 at 09:44:42AM +0100, Daniel Vetter wrote:
> 
> > > 
> > > Why change them? What was wrong with txt to begin with?  
> > 
> > In my opinion good docs matter, and one of the key things is to be able to
> > cross reference stuff.  
> 
> Well, good docs begin with useful content; and many docs lack that.
> Fixing that would be a much more useful thing to do.
> 
> In any case, I've never had any problems with typing things like: "go
> read: Documentation/file.txt for more information.".
> 
> Also, what text editor supports cross references at all then? With the
> filename I can use 'gf' in vim to open it up in a new buffer and go read
> that.
> 
> > Another concern some core kernel folks raised is that the .rst markup was
> > too heavy-handed, and makes the text much harder to read. Christoph called
> > it "cat spew". That can be fixed with a much lighter-handed conversion
> > (and 2nd patch iteration was acceptable for Christoph).  
> 
> Very much agreed, once a file is no longer readable with less or the
> text editor of your choice, it as good doesn't exist at all. So I very
> much worry about RST even supporting such heavy markup that the end
> result is unreadable.
> 
> Basically, if a file isn't usable from within a 'normal' text editor, it
> doesn't exist.

A file "converted" to ReST is still a text file. As Jani mentioned, you
can keep doing your normal edit on them as text files, without even noticing
that it follows the ReST notation.

On most cases, all it takes to convert a file to ReST is:

- adjust the chapter/section headers, as they all start on column 1,
  and all have a line below with a symbol (like "=", "-", "~", ...), E. g:

	Foo chapter
	===========

	bar section
	-----------

  It will automatically assign the first symbol to chapter, the
  next one to section and so on.

- use *foo* (for italics) or **foo** (for bold) instead of _foo_;

- if you need to use cross-references, use :ref:`name <id>`;

  The way I did cross-references on the documents I converted was to
  preserve the file name, plus adding a way for the ones reading the
  documentation in PDF or HTML to have the document cross-referenced.

  This way, we can still open the cross-referenced document with
  our favorite text editors, as the file name is there. E. g:

	:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`

- if it contains source examples or ascii artwork diagrams, use "::"
  on the previous line to create a literal block, e. g.:

	this is an example::

		// whatever I do here, Sphinx will display as-is
		foo(bar);

- adjust whitespaces/new lines where needed, as Sphinx identifies
  continuation lines if the text is at the same column as the
  previous line, and blank lines break paragraphs.

- if you have something that you want to use a monotonic font on
  PDF/LaTeX/HTML, use ``foo``.

- if you use special characters like '*' in the middle of the text
  (outsize a literal block), prepend with a \ in order to escape
  parsing it.

Silvio's patch was a little too intrusive, as it touched on block
indentation and whitespaces without needing. It also used monotonic
fonts for a lot more than it would be required. I'm pretty sure
his patch could be reworked to be a lot less intrusive.

Btw, a lot of editors recognize ReST files and are capable of
parsing the ReST tags while displaying the file, including vim
and emacs, using different colors and/or bold to display those tags.
So, even for text-editing, converting to ReST brings improvements.

Thanks,
Mauro

[toc] | [prev] | [next] | [standalone]

#1531243 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 09:08:55AM -0200, Mauro Carvalho Chehab wrote:
> - use *foo* (for italics) or **foo** (for bold) instead of _foo_;

That's daft, and also you're wrong. The normal convention is:

	/italic/
	*bold*
	_underlined_


> 	:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`

That seems to work, as in 'gf' doesn't get confused by the spurious
characters attached. Is there any way to enforce that?

> - if you have something that you want to use a monotonic font on
>   PDF/LaTeX/HTML, use ``foo``.

Bit weird, somewhere in the typewriter age they invented the " symbol so
we didn't have to type double quotes anymore.

> - if you use special characters like '*' in the middle of the text
>   (outsize a literal block), prepend with a \ in order to escape
>   parsing it.

That's a bit inconvenient I suppose.

> Btw, a lot of editors recognize ReST files and are capable of
> parsing the ReST tags while displaying the file, including vim
> and emacs, using different colors and/or bold to display those tags.
> So, even for text-editing, converting to ReST brings improvements.

Doesn't seem to really work though; if I open
Documentation/development-process/1.Intro.rst the :ref:s at the start of
the document don't work with the regular 'follow-ref' key combo of ^].

[toc] | [prev] | [next] | [standalone]

#1531312 — Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

On Mon, Nov 28, 2016 at 12:54:13PM +0100, Peter Zijlstra wrote:
> On Mon, Nov 28, 2016 at 09:08:55AM -0200, Mauro Carvalho Chehab wrote:
> > - use *foo* (for italics) or **foo** (for bold) instead of _foo_;
> 
> That's daft, and also you're wrong. The normal convention is:
> 
> 	/italic/
> 	*bold*
> 	_underlined_

I dont think anything is lost if we don't use the rst flavour but keep the
traditional one. The html output meant for newbies looks a bit more funny,
but if that means the old guard is more likely to type the docs then
that's more than worth it.

> > 	:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`
> 
> That seems to work, as in 'gf' doesn't get confused by the spurious
> characters attached. Is there any way to enforce that?
> 
> > - if you have something that you want to use a monotonic font on
> >   PDF/LaTeX/HTML, use ``foo``.
> 
> Bit weird, somewhere in the typewriter age they invented the " symbol so
> we didn't have to type double quotes anymore.

"Quote" just gives you a quote, not fixed-width. The `` noise is what
upset Christoph, and I think it's perfectly fine to not use them.

> > - if you use special characters like '*' in the middle of the text
> >   (outsize a literal block), prepend with a \ in order to escape
> >   parsing it.
> 
> That's a bit inconvenient I suppose.
> 
> > Btw, a lot of editors recognize ReST files and are capable of
> > parsing the ReST tags while displaying the file, including vim
> > and emacs, using different colors and/or bold to display those tags.
> > So, even for text-editing, converting to ReST brings improvements.
> 
> Doesn't seem to really work though; if I open
> Documentation/development-process/1.Intro.rst the :ref:s at the start of
> the document don't work with the regular 'follow-ref' key combo of ^].

For that we need to integrate some rst/sphinx ctags generator into the
kernel's ctags target. Not sure we want to do that (it might upset people
who want to follow to a C symbol with clashing naming), at least not by
default. But if this desired we can make it happen.
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

[toc] | [prev] | [next] | [standalone]

Page 1 of 2  [1] 2  Next page →

Back to top | Article view | linux.kernel

csiph-web