From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Daniel Vetter <daniel@ffwll.ch>, David Airlie <airlied@linux.ie>,
Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
Maxime Ripard <mripard@kernel.org>,
Thomas Zimmermann <tzimmermann@suse.de>,
dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
Subject: [PATCH v3 26/32] gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups
Date: Tue, 27 Oct 2020 10:51:30 +0100 [thread overview]
Message-ID: <bd070923591ae54f9587e7407b6291ac116952b2.1603791716.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1603791716.git.mchehab+huawei@kernel.org>
As reported by kernel-doc:
./drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c:1: warning: no structured comments found
./drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c:1: warning: no structured comments found
Those files only contain
/**
* DOC:
*/
markups, but they're included twice there: one to parse
such markup, and another one to parse internal functions.
In the case of amdgpu_xgmi.c, as it has just one such
markup, we can simply include the file once, and let it
parse the entire file without passing arguments to kernel-doc.
This should place everything altogether.
For amdgpu_ras.c, however, we need to remove the kernel-doc
with just internal. This should be re-introduced if this
file ever gets new non-DOC markups.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/gpu/amdgpu.rst | 7 -------
1 file changed, 7 deletions(-)
diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst
index 1f9ea8221f80..2062a6023678 100644
--- a/Documentation/gpu/amdgpu.rst
+++ b/Documentation/gpu/amdgpu.rst
@@ -83,10 +83,6 @@ AMDGPU XGMI Support
===================
.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
- :doc: AMDGPU XGMI Support
-
-.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
- :internal:
AMDGPU RAS Support
==================
@@ -124,9 +120,6 @@ RAS VRAM Bad Pages sysfs Interface
.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
:doc: AMDGPU RAS sysfs gpu_vram_bad_pages Interface
-.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
- :internal:
-
Sample Code
-----------
Sample code for testing error injection can be found here:
--
2.26.2
next prev parent reply other threads:[~2020-10-27 10:01 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-27 9:51 [PATCH v3 00/32] Documentation build fixes against v5.10-rc1 Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 01/32] scripts: kernel-doc: use :c:union when needed Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 02/32] sphinx: conf.py: properly handle Sphinx 4.0 Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 03/32] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 04/32] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 05/32] docs: kasan.rst: add two missing blank lines Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 06/32] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 07/32] docs: hwmon: mp2975.rst: address some html build warnings Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 08/32] docs: userspace-api: add iommu.rst to the index file Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 09/32] blk-mq: docs: add kernel-doc description for a new struct member Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 10/32] drm: kernel-doc: document drm_dp_set_subconnector_property() params Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 11/32] drm/dp: fix kernel-doc warnings at drm_dp_helper.c Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 12/32] drm/dp: fix a kernel-doc issue at drm_edid.c Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 13/32] mm: pagemap.h: fix two kernel-doc markups Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 14/32] net: phy: remove kernel-doc duplication Mauro Carvalho Chehab
2020-10-27 12:41 ` Andrew Lunn
2020-10-27 9:51 ` [PATCH v3 15/32] crypto: sun8x-ce*: update entries to its documentation Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 16/32] ice: docs fix a devlink info that broke a table Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 17/32] MAINTAINERS: fix broken doc refs due to yaml conversion Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 18/32] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 19/32] locking/refcount: move kernel-doc markups to the proper place Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 20/32] IB/srpt: docs: add a description for cq_size member Mauro Carvalho Chehab
2020-10-28 3:48 ` Bart Van Assche
2020-10-27 9:51 ` [PATCH v3 21/32] docs: fs: api-summary.rst: get rid of kernel-doc include Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 22/32] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 23/32] jbd2: fix a kernel-doc markup Mauro Carvalho Chehab
2020-10-27 21:26 ` Theodore Y. Ts'o
2020-10-27 9:51 ` [PATCH v3 24/32] drm: drm_edid: remove a duplicated kernel-doc declaration Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 25/32] drm: kernel-doc: add description for a new function parameter Mauro Carvalho Chehab
2020-10-27 10:04 ` Gerd Hoffmann
2020-10-27 9:51 ` Mauro Carvalho Chehab [this message]
2020-10-27 9:51 ` [PATCH v3 27/32] drm: kernel-doc: drm_dp_helper.h: fix a typo Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 28/32] drm: amdgpu_dm: " Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 29/32] selftests: kselftest_harness.h: fix kernel-doc markups Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 30/32] amdgpu: fix a few kernel-doc markup issues Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 31/32] drm: drm_print.h: fix kernel-doc markups Mauro Carvalho Chehab
2020-10-27 10:22 ` Daniel Vetter
2020-10-27 9:51 ` [PATCH v3 32/32] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-10-28 17:46 ` [PATCH v3 00/32] Documentation build fixes against v5.10-rc1 Jonathan Corbet
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=bd070923591ae54f9587e7407b6291ac116952b2.1603791716.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=airlied@linux.ie \
--cc=corbet@lwn.net \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mripard@kernel.org \
--cc=tzimmermann@suse.de \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).