Re: [PATCH 07/18] docs: core-api: add circular-buffers documentation

[Andrea Parri]

On Mon, May 07, 2018 at 06:35:43AM -0300, Mauro Carvalho Chehab wrote:
> The circular-buffers.txt is already in ReST format. So, move it to the
> core-api guide, where it belongs.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>
> ---
>  Documentation/00-INDEX                                          | 2 --
>  .../{circular-buffers.txt => core-api/circular-buffers.rst}     | 0
>  Documentation/core-api/index.rst                                | 1 +
>  Documentation/memory-barriers.txt                               | 2 +-
>  Documentation/translations/ko_KR/memory-barriers.txt            | 2 +-
>  5 files changed, 3 insertions(+), 4 deletions(-)
>  rename Documentation/{circular-buffers.txt => core-api/circular-buffers.rst} (100%)

Similarly:

./include/linux/circ_buf.h: * See Documentation/circular-buffers.txt for more information.
./drivers/lightnvm/pblk-rb.c: * (Documentation/circular-buffers.txt)
./drivers/media/dvb-core/dvb_ringbuffer.c:	 * for memory barriers also see Documentation/circular-buffers.txt

  Andrea


> 
> diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
> index c6b81ef9827b..a9dd1384d8e3 100644
> --- a/Documentation/00-INDEX
> +++ b/Documentation/00-INDEX
> @@ -80,8 +80,6 @@ cdrom/
>  	- directory with information on the CD-ROM drivers that Linux has.
>  cgroup-v1/
>  	- cgroups v1 features, including cpusets and memory controller.
> -circular-buffers.txt
> -	- how to make use of the existing circular buffer infrastructure
>  clk.txt
>  	- info on the common clock framework
>  cma/
> diff --git a/Documentation/circular-buffers.txt b/Documentation/core-api/circular-buffers.rst
> similarity index 100%
> rename from Documentation/circular-buffers.txt
> rename to Documentation/core-api/circular-buffers.rst
> diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
> index d4d71ee564ae..3864de589126 100644
> --- a/Documentation/core-api/index.rst
> +++ b/Documentation/core-api/index.rst
> @@ -26,6 +26,7 @@ Core utilities
>     genalloc
>     errseq
>     printk-formats
> +   circular-buffers
>  
>  Interfaces for kernel debugging
>  ===============================
> diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
> index 983249906fc6..33b8bc9573f8 100644
> --- a/Documentation/memory-barriers.txt
> +++ b/Documentation/memory-barriers.txt
> @@ -3083,7 +3083,7 @@ CIRCULAR BUFFERS
>  Memory barriers can be used to implement circular buffering without the need
>  of a lock to serialise the producer with the consumer.  See:
>  
> -	Documentation/circular-buffers.txt
> +	Documentation/core-api/circular-buffers.rst
>  
>  for details.
>  
> diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt
> index 081937577c1a..2ec5fe0c9cf4 100644
> --- a/Documentation/translations/ko_KR/memory-barriers.txt
> +++ b/Documentation/translations/ko_KR/memory-barriers.txt
> @@ -3023,7 +3023,7 @@ smp_mb() ê ìëë virt_mb() ë ììíì íëë.
>  ëêíì ëì ììíì ìê êííëëì ììë ì ììëë.  ë ììí ëìì
>  ìíì ëìì ìêíìì:
>  
> -	Documentation/circular-buffers.txt
> +	Documentation/core-api/circular-buffers.rst
>  
>  
>  =========
> -- 
> 2.17.0
>