From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: <linux-doc@vger.kernel.org>, <linux-cxl@vger.kernel.org>,
<linux-next@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Alison Schofield <alison.schofield@intel.com>,
"Vishal Verma" <vishal.l.verma@intel.com>,
Ira Weiny <ira.weiny@intel.com>,
"Ben Widawsky" <bwidawsk@kernel.org>,
Dan Williams <dan.j.williams@intel.com>
Subject: Re: [PATCH 3/3] Documentation: cxl: remove dangling kernel-doc reference
Date: Thu, 4 Aug 2022 14:32:41 +0100 [thread overview]
Message-ID: <20220804143241.000065d7@huawei.com> (raw)
In-Reply-To: <20220804075448.98241-4-bagasdotme@gmail.com>
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
>
next prev parent reply other threads:[~2022-08-04 13:33 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-04 7:54 [PATCH 0/3] cxl: documentation fixes Bagas Sanjaya
2022-08-04 7:54 ` [PATCH 1/3] cxl/regions: add padding for cxl_rr_ep_add nested lists Bagas Sanjaya
2022-08-04 9:15 ` Jonathan Cameron
2022-08-04 7:54 ` [PATCH 2/3] cxl/region: describe targets and nr_targets members of cxl_region_params Bagas Sanjaya
2022-08-04 13:35 ` Jonathan Cameron
2022-08-04 7:54 ` [PATCH 3/3] Documentation: cxl: remove dangling kernel-doc reference Bagas Sanjaya
2022-08-04 13:32 ` Jonathan Cameron [this message]
2022-08-05 0:48 ` [PATCH 0/3] cxl: documentation fixes Dan Williams
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220804143241.000065d7@huawei.com \
--to=jonathan.cameron@huawei.com \
--cc=alison.schofield@intel.com \
--cc=bagasdotme@gmail.com \
--cc=bwidawsk@kernel.org \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=ira.weiny@intel.com \
--cc=linux-cxl@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=vishal.l.verma@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.