linux-kernel - Re: [PATCH 3/3] Documentation: cxl: remove dangling kernel-doc reference

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]

Date:   Thu, 4 Aug 2022 14:32:41 +0100
From:   Jonathan Cameron <Jonathan.Cameron@...wei.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
CC:     <linux-doc@...r.kernel.org>, <linux-cxl@...r.kernel.org>,
        <linux-next@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Alison Schofield <alison.schofield@...el.com>,
        "Vishal Verma" <vishal.l.verma@...el.com>,
        Ira Weiny <ira.weiny@...el.com>,
        "Ben Widawsky" <bwidawsk@...nel.org>,
        Dan Williams <dan.j.williams@...el.com>
Subject: Re: [PATCH 3/3] Documentation: cxl: remove dangling kernel-doc
 reference

On Thu,  4 Aug 2022 14:54:48 +0700
Bagas Sanjaya <bagasdotme@...il.com> wrote:

> Sphinx reported kernel-doc failure warning, pointing to non-existent
> drivers/cxl/region.h (which doesn't also exist throughout repo history):
> 
> WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-version 2.4.4 -no-doc-sections ./drivers/cxl/region.h' failed with return code 1
> 
> Above cause error message to be displayed on htmldocs output.
> 
> Delete the reference.
> 
> Fixes: 779dd20cfb56c5 ("cxl/region: Add region creation support")
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
Ah. That went in some refactoring along the way.

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@...wei.com>

> ---
>  Documentation/driver-api/cxl/memory-devices.rst | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/memory-devices.rst
> index 66ddc58a21b159..5149ecdc53c796 100644
> --- a/Documentation/driver-api/cxl/memory-devices.rst
> +++ b/Documentation/driver-api/cxl/memory-devices.rst
> @@ -364,9 +364,6 @@ CXL Core
>  
>  CXL Regions
>  -----------
> -.. kernel-doc:: drivers/cxl/region.h
> -   :identifiers:
> -
>  .. kernel-doc:: drivers/cxl/core/region.c
>     :doc: cxl core region
>