From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: unlisted-recipients:; (no To-header on input)
Cc: "Mauro Carvalho Chehab" <mchehab@kernel.org>,
"Christian König" <christian.koenig@amd.com>,
"Jani Nikula" <jani.nikula@linux.intel.com>,
"Lucas De Marchi" <lucas.demarchi@intel.com>,
"Rodrigo Vivi" <rodrigo.vivi@intel.com>,
"Thomas Hellström" <thomas.hellstrom@linux.intel.com>,
"Daniel Vetter" <daniel@ffwll.ch>,
"David Airlie" <airlied@linux.ie>,
"Joonas Lahtinen" <joonas.lahtinen@linux.intel.com>,
"Maarten Lankhorst" <maarten.lankhorst@linux.intel.com>,
"Matthew Auld" <matthew.auld@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 17/32] drm/i915: i915_gem_wait.c: fix a kernel-doc markup
Date: Mon, 11 Jul 2022 21:25:02 +0100 [thread overview]
Message-ID: <54d781157866d7dc4f656b50500f228dca4070ed.1657565224.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1657565224.git.mchehab@kernel.org>
The return codes for i915_gem_wait_ioctl() have identation issues,
and will be displayed on a very confusing way. Use lists to improve
its output.
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/gem/i915_gem_wait.c | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/drivers/gpu/drm/i915/gem/i915_gem_wait.c b/drivers/gpu/drm/i915/gem/i915_gem_wait.c
index bdba05492582..7b4e216a295b 100644
--- a/drivers/gpu/drm/i915/gem/i915_gem_wait.c
+++ b/drivers/gpu/drm/i915/gem/i915_gem_wait.c
@@ -176,23 +176,25 @@ static unsigned long to_wait_timeout(s64 timeout_ns)
* @data: ioctl data blob
* @file: drm file pointer
*
- * Returns 0 if successful, else an error is returned with the remaining time in
- * the timeout parameter.
- * -ETIME: object is still busy after timeout
- * -ERESTARTSYS: signal interrupted the wait
- * -ENONENT: object doesn't exist
- * Also possible, but rare:
- * -EAGAIN: incomplete, restart syscall
- * -ENOMEM: damn
- * -ENODEV: Internal IRQ fail
- * -E?: The add request failed
- *
* The wait ioctl with a timeout of 0 reimplements the busy ioctl. With any
* non-zero timeout parameter the wait ioctl will wait for the given number of
* nanoseconds on an object becoming unbusy. Since the wait itself does so
* without holding struct_mutex the object may become re-busied before this
* function completes. A similar but shorter * race condition exists in the busy
* ioctl
+ *
+ * Returns:
+ * 0 if successful, else an error is returned with the remaining time in
+ * the timeout parameter.
+ * * -ETIME: object is still busy after timeout
+ * * -ERESTARTSYS: signal interrupted the wait
+ * * -ENONENT: object doesn't exist
+ *
+ * Also possible, but rare:
+ * * -EAGAIN: incomplete, restart syscall
+ * * -ENOMEM: damn
+ * * -ENODEV: Internal IRQ fail
+ * * -E?: The add request failed
*/
int
i915_gem_wait_ioctl(struct drm_device *dev, void *data, struct drm_file *file)
--
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 ` Mauro Carvalho Chehab [this message]
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 ` [PATCH 23/32] drm/i915: i915_gem.c fix a kernel-doc issue Mauro Carvalho Chehab
2022-07-11 20:25 ` [PATCH 24/32] drm/i915: i915_scatterlist.h: fix some kernel-doc markups 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=54d781157866d7dc4f656b50500f228dca4070ed.1657565224.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=airlied@linux.ie \
--cc=christian.koenig@amd.com \
--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=maarten.lankhorst@linux.intel.com \
--cc=matthew.auld@intel.com \
--cc=rodrigo.vivi@intel.com \
--cc=thomas.hellstrom@linux.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®