From: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>,
Jonathan Corbet <corbet@lwn.net>, David Airlie <airlied@linux.ie>,
dri-devel@lists.freedesktop.org,
Lucas De Marchi <lucas.demarchi@intel.com>,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
Maxime Ripard <mripard@kernel.org>,
Rodrigo Vivi <rodrigo.vivi@intel.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
intel-gfx@lists.freedesktop.org
Subject: [Intel-gfx] [PATCH 28/32] docs: gpu: i915.rst: GuC: add more kernel-doc markups
Date: Mon, 11 Jul 2022 21:25:13 +0100 [thread overview]
Message-ID: <a22fbe2ea7ca57099f2aadf29fbce6b896fc53c5.1657565224.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1657565224.git.mchehab@kernel.org>
There are several documented GuC kAPI that aren't currently part
of the docs. Add them, as this allows identifying issues with
badly-formatted tags.
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/32] at: https://lore.kernel.org/all/cover.1657565224.git.mchehab@kernel.org/
Documentation/gpu/i915.rst | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index afd8c0e3c689..70f2f4826eba 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -596,6 +596,28 @@ GuC
.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc.h
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_slpc_abi.h
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_ads.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_ct.h
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_ct.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_hwconfig.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_log.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_slpc.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc_fw.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc.c
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw.h
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_uc_fw.c
+
GuC Firmware Layout
~~~~~~~~~~~~~~~~~~~
--
2.36.1
next prev parent reply other threads:[~2022-07-11 20:26 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-11 20:24 [Intel-gfx] [PATCH 00/32] drm/i915: fix kernel-doc issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 01/32] drm/i915: fix kernel-doc trivial warnings on i915/*.[ch] files Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 02/32] drm/i915: display: fix kernel-doc markup warnings Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 03/32] drm/i915: gt: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 04/32] drm/i915: gvt: fix kernel-doc trivial warnings Mauro Carvalho Chehab
2022-07-12 5:00 ` Zhenyu Wang
2022-07-11 20:24 ` [Intel-gfx] [PATCH 05/32] drm/i915: gem: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 06/32] drm/i915: intel_wakeref.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 07/32] drm/i915: i915_gem_ttm: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 08/32] drm/i915: i915_gem_ttm_pm.c: fix kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 09/32] drm/i915: gem: add missing trivial function parameters Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 10/32] drm/i915: i915_gpu_error.c: document dump_flags Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 11/32] drm/i915: document kernel-doc trivial issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 12/32] drm/i915: intel_dp_link_training.c: fix kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 13/32] drm/i915: intel_fb: fix a kernel-doc issue with Sphinx Mauro Carvalho Chehab
2022-07-11 20:24 ` [Intel-gfx] [PATCH 14/32] drm/i915: skl_scaler: fix return value kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 15/32] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 16/32] drm/i915: i915_gem_region.h: fix i915_gem_apply_to_region_ops doc Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 17/32] drm/i915: i915_gem_wait.c: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 18/32] drm/i915: fix i915_gem_ttm_move.c DOC: markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 19/32] drm/i915: stop using kernel-doc markups for something else Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 20/32] drm/i915: dvo_ch7xxx.c: use SPDX header Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 21/32] drm/i915: dvo_sil164.c: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 22/32] drm/i915: i915_vma_resource.c: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 23/32] drm/i915: i915_gem.c fix a kernel-doc issue Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 24/32] drm/i915: i915_scatterlist.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 25/32] drm/i915: i915_deps: use a shorter title markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 26/32] docs: gpu: i915.rst: display: add kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 27/32] docs: gpu: i915.rst: gt: add more " Mauro Carvalho Chehab
2022-07-11 20:25 ` Mauro Carvalho Chehab [this message]
2022-07-11 20:25 ` [Intel-gfx] [PATCH 29/32] docs: gpu: i915.rst: GVT: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 30/32] docs: gpu: i915.rst: PM: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 31/32] docs: gpu: i915.rst: GEM/TTM: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [Intel-gfx] [PATCH 32/32] docs: gpu: i915.rst: add the remaining kernel-doc markup files Mauro Carvalho Chehab
2022-07-11 20:58 ` [Intel-gfx] ✗ Fi.CI.CHECKPATCH: warning for drm/i915: fix kernel-doc issues Patchwork
2022-07-11 20:58 ` [Intel-gfx] ✗ Fi.CI.SPARSE: " Patchwork
2022-07-11 21:18 ` [Intel-gfx] ✓ Fi.CI.BAT: success " Patchwork
2022-07-11 23:40 ` [Intel-gfx] ✓ Fi.CI.IGT: " Patchwork
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=a22fbe2ea7ca57099f2aadf29fbce6b896fc53c5.1657565224.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=airlied@linux.ie \
--cc=corbet@lwn.net \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lucas.demarchi@intel.com \
--cc=mripard@kernel.org \
--cc=rodrigo.vivi@intel.com \
--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