diff mbox series

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

Message ID 20220804075448.98241-4-bagasdotme@gmail.com
State Accepted
Commit 8732947b75a826519ef33b92dbebaa3fa83e5e0b
Headers show
Series cxl: documentation fixes | expand

Commit Message

Bagas Sanjaya Aug. 4, 2022, 7:54 a.m. UTC
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@gmail.com>
---
 Documentation/driver-api/cxl/memory-devices.rst | 3 ---
 1 file changed, 3 deletions(-)

Comments

Jonathan Cameron Aug. 4, 2022, 1:32 p.m. UTC | #1
On Thu,  4 Aug 2022 14:54:48 +0700
Bagas Sanjaya <bagasdotme@gmail.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@gmail.com>
Ah. That went in some refactoring along the way.

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.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
>
diff mbox series

Patch

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