From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: unlisted-recipients:; (no To-header on input)
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
"Jani Nikula" <jani.nikula@linux.intel.com>,
"Lucas De Marchi" <lucas.demarchi@intel.com>,
"Rodrigo Vivi" <rodrigo.vivi@intel.com>,
Daniel Vetter <daniel@ffwll.ch>, David Airlie <airlied@linux.ie>,
Joonas Lahtinen <joonas.lahtinen@linux.intel.com>,
Tvrtko Ursulin <tvrtko.ursulin@linux.intel.com>,
dri-devel@lists.freedesktop.org, intel-gfx@lists.freedesktop.org,
linux-kernel@vger.kernel.org
Subject: [PATCH 23/32] drm/i915: i915_gem.c fix a kernel-doc issue
Date: Mon, 11 Jul 2022 21:25:08 +0100 [thread overview]
Message-ID: <037b710c2a65c4b3da5b0b9bb947f740bf08c12e.1657565224.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1657565224.git.mchehab@kernel.org>
Prevent this Sphinx warning:
Documentation/foo/i915:728: ./drivers/gpu/drm/i915/i915_gem.c:447: WARNING: Inline emphasis start-string without end-string.
By using @data to identify the data field, as expected by kernel-doc.
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/
drivers/gpu/drm/i915/i915_gem.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/gpu/drm/i915/i915_gem.c b/drivers/gpu/drm/i915/i915_gem.c
index f01f0896ff5c..0bc895c6a1fc 100644
--- a/drivers/gpu/drm/i915/i915_gem.c
+++ b/drivers/gpu/drm/i915/i915_gem.c
@@ -444,7 +444,7 @@ i915_gem_gtt_pread(struct drm_i915_gem_object *obj,
* @data: ioctl data blob
* @file: drm file pointer
*
- * On error, the contents of *data are undefined.
+ * On error, the contents of @data is undefined.
*/
int
i915_gem_pread_ioctl(struct drm_device *dev, void *data,
--
2.36.1
next prev parent reply other threads:[~2022-07-11 20:26 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-11 20:24 [PATCH 00/32] drm/i915: fix kernel-doc issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 01/32] drm/i915: fix kernel-doc trivial warnings on i915/*.[ch] files Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 02/32] drm/i915: display: fix kernel-doc markup warnings Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 03/32] drm/i915: gt: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [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 ` [PATCH 05/32] drm/i915: gem: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 06/32] drm/i915: intel_wakeref.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 07/32] drm/i915: i915_gem_ttm: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 08/32] drm/i915: i915_gem_ttm_pm.c: fix kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 09/32] drm/i915: gem: add missing trivial function parameters Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 10/32] drm/i915: i915_gpu_error.c: document dump_flags Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 11/32] drm/i915: document kernel-doc trivial issues Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 12/32] drm/i915: intel_dp_link_training.c: fix kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 13/32] drm/i915: intel_fb: fix a kernel-doc issue with Sphinx Mauro Carvalho Chehab
2022-07-11 20:24 ` [PATCH 14/32] drm/i915: skl_scaler: fix return value kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 15/32] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc Mauro Carvalho Chehab
2022-07-11 20:25 ` [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 ` [PATCH 17/32] drm/i915: i915_gem_wait.c: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 18/32] drm/i915: fix i915_gem_ttm_move.c DOC: markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 19/32] drm/i915: stop using kernel-doc markups for something else Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 20/32] drm/i915: dvo_ch7xxx.c: use SPDX header Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 21/32] drm/i915: dvo_sil164.c: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 22/32] drm/i915: i915_vma_resource.c: fix some kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:25 ` Mauro Carvalho Chehab [this message]
2022-07-11 20:25 ` [PATCH 24/32] drm/i915: i915_scatterlist.h: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 25/32] drm/i915: i915_deps: use a shorter title markup Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 26/32] docs: gpu: i915.rst: display: add kernel-doc markups Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 27/32] docs: gpu: i915.rst: gt: add more " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 28/32] docs: gpu: i915.rst: GuC: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 29/32] docs: gpu: i915.rst: GVT: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 30/32] docs: gpu: i915.rst: PM: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 31/32] docs: gpu: i915.rst: GEM/TTM: " Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 32/32] docs: gpu: i915.rst: add the remaining kernel-doc markup files Mauro Carvalho Chehab
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=037b710c2a65c4b3da5b0b9bb947f740bf08c12e.1657565224.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=airlied@linux.ie \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jani.nikula@linux.intel.com \
--cc=joonas.lahtinen@linux.intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lucas.demarchi@intel.com \
--cc=rodrigo.vivi@intel.com \
--cc=tvrtko.ursulin@linux.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®