linux-kernel - Re: [PATCH v2 02/24] tools: docs: memory-model: fix references for some files

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20201013163354.GO3249@paulmck-ThinkPad-P72>
Date:   Tue, 13 Oct 2020 09:33:54 -0700
From:   "Paul E. McKenney" <paulmck@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Akira Yokosawa <akiyks@...il.com>,
        Alan Stern <stern@...land.harvard.edu>,
        Andrea Parri <parri.andrea@...il.com>,
        Boqun Feng <boqun.feng@...il.com>,
        Daniel Lustig <dlustig@...dia.com>,
        David Howells <dhowells@...hat.com>,
        Jade Alglave <j.alglave@....ac.uk>,
        Joel Fernandes <joel@...lfernandes.org>,
        Luc Maranget <luc.maranget@...ia.fr>,
        Nicholas Piggin <npiggin@...il.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Will Deacon <will@...nel.org>, linux-arch@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 02/24] tools: docs: memory-model: fix references for
 some files

On Tue, Oct 13, 2020 at 02:14:29PM +0200, Mauro Carvalho Chehab wrote:
> - The sysfs.txt file was converted to ReST and renamed;
> - The control-dependencies.txt is not at
>   Documentation/control-dependencies.txt. As it is at the
>   same dir as the README file, which mentions it, just
>   remove Documentation/.
> 
> With that, ./scripts/documentation-file-ref-check script
> is now happy again for files under tools/.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Queued for review and testing, likely target v5.11.

							Thanx, Paul

> ---
>  tools/memory-model/Documentation/README       | 2 +-
>  tools/memory-model/Documentation/ordering.txt | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
> index 16177aaa9752..004969992bac 100644
> --- a/tools/memory-model/Documentation/README
> +++ b/tools/memory-model/Documentation/README
> @@ -55,7 +55,7 @@ README
>  Documentation/cheatsheet.txt
>  	Quick-reference guide to the Linux-kernel memory model.
>  
> -Documentation/control-dependencies.txt
> +control-dependencies.txt
>  	A guide to preventing compiler optimizations from destroying
>  	your control dependencies.
>  
> diff --git a/tools/memory-model/Documentation/ordering.txt b/tools/memory-model/Documentation/ordering.txt
> index 3d020bed8585..629b19ae64a6 100644
> --- a/tools/memory-model/Documentation/ordering.txt
> +++ b/tools/memory-model/Documentation/ordering.txt
> @@ -346,7 +346,7 @@ o	Accessing RCU-protected pointers via rcu_dereference()
>  
>  	If there is any significant processing of the pointer value
>  	between the rcu_dereference() that returned it and a later
> -	dereference(), please read Documentation/RCU/rcu_dereference.txt.
> +	dereference(), please read Documentation/RCU/rcu_dereference.rst.
>  
>  It can also be quite helpful to review uses in the Linux kernel.
>  
> -- 
> 2.26.2
>