linux-kernel - Re: [PATCH v2 24/24] counters: docs: add a missing include

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: <982ecabd-330d-7ef9-9287-0eda5ba399b3@linuxfoundation.org>
Date:   Wed, 14 Oct 2020 19:06:52 -0600
From:   Shuah Khan <skhan@...uxfoundation.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        "Matthew Wilcox (Oracle)" <willy@...radead.org>,
        Ricardo Cañuelo <ricardo.canuelo@...labora.com>,
        Arnd Bergmann <arnd@...db.de>,
        Daniel Jordan <daniel.m.jordan@...cle.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Herbert Xu <herbert@...dor.apana.org.au>,
        Kees Cook <keescook@...omium.org>,
        Masahiro Yamada <masahiroy@...nel.org>,
        linux-kernel@...r.kernel.org,
        Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH v2 24/24] counters: docs: add a missing include

On 10/13/20 6:14 AM, Mauro Carvalho Chehab wrote:
> Changeset 37a0dbf631f6 ("counters: Introduce counter_atomic* counters")
> 
> Is causing two new warnings:
> 
> 	.../Documentation/core-api/counters.rst:8: WARNING: Undefined substitution referenced: "copy".
> 	.../Documentation/core-api/counters.rst:9: WARNING: Undefined substitution referenced: "copy".
> 
> Because it forgot to include isonum.txt, which defines |copy|
> macro.
> 
> While here, also add it to core-api index file, in order to
> solve this warning:
> 
> 	.../Documentation/core-api/counters.rst: WARNING: document isn't included in any toctree
> 
> Fixes: 37a0dbf631f6 ("counters: Introduce counter_atomic* counters")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>   Documentation/core-api/counters.rst | 1 +
>   Documentation/core-api/index.rst    | 1 +
>   2 files changed, 2 insertions(+)
> 
> diff --git a/Documentation/core-api/counters.rst b/Documentation/core-api/counters.rst
> index 642d907f4d3a..2821aebf3f45 100644
> --- a/Documentation/core-api/counters.rst
> +++ b/Documentation/core-api/counters.rst
> @@ -1,4 +1,5 @@
>   .. SPDX-License-Identifier: GPL-2.0
> +.. include:: <isonum.txt>
>   
>   ======================
>   Simple atomic counters
> diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
> index 69171b1799f2..cf9cd44c1191 100644
> --- a/Documentation/core-api/index.rst
> +++ b/Documentation/core-api/index.rst
> @@ -43,6 +43,7 @@ Library functionality that is used throughout the kernel.
>      this_cpu_ops
>      timekeeping
>      errseq
> +   counters
>   
>   Concurrency primitives
>   ======================
> 

Thank you for the patch. I will add this to my patch series.

thanks,
-- Shuah