diff mbox series

drm/gem: Fix sphinx warnings

Message ID 20190424204916.222155-1-sean@poorly.run (mailing list archive)
State New, archived
Headers show
Series drm/gem: Fix sphinx warnings | expand

Commit Message

Sean Paul April 24, 2019, 8:49 p.m. UTC 
From: Sean Paul <seanpaul@chromium.org>

Sphinx really wants colons after arguments :/

Fixes the following warnings:
drm_gem.c:1384: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add'
drm_gem.c:1384: warning: Function parameter or member 'fence' not described in 'drm_gem_fence_array_add'
drm_gem.c:1435: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add_implicit'
drm_gem.c:1435: warning: Function parameter or member 'obj' not described in 'drm_gem_fence_array_add_implicit'
drm_gem.c:1435: warning: Function parameter or member 'write' not described in 'drm_gem_fence_array_add_implicit'

Fixes: 5d5a179d3e90 ("drm: Add helpers for setting up an array of dma_fence dependencies.")
Cc: Eric Anholt <eric@anholt.net>
Cc: Qiang Yu <yuq825@gmail.com> (v1)
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <maxime.ripard@bootlin.com>
Cc: Sean Paul <sean@poorly.run>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Sean Paul <seanpaul@chromium.org>
---
 drivers/gpu/drm/drm_gem.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Eric Anholt April 24, 2019, 9:59 p.m. UTC | #1 
Sean Paul <sean@poorly.run> writes:

> From: Sean Paul <seanpaul@chromium.org>
>
> Sphinx really wants colons after arguments :/
>
> Fixes the following warnings:
> drm_gem.c:1384: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add'
> drm_gem.c:1384: warning: Function parameter or member 'fence' not described in 'drm_gem_fence_array_add'
> drm_gem.c:1435: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add_implicit'
> drm_gem.c:1435: warning: Function parameter or member 'obj' not described in 'drm_gem_fence_array_add_implicit'
> drm_gem.c:1435: warning: Function parameter or member 'write' not described in 'drm_gem_fence_array_add_implicit'

Hopefully some day we can move to gitlab and have CI and make sure we
don't screw this stuff up ever again.

Reviewed-by: Eric Anholt <eric@anholt.net>
Daniel Vetter April 25, 2019, 6:35 a.m. UTC | #2 
On Wed, Apr 24, 2019 at 02:59:00PM -0700, Eric Anholt wrote:
> Sean Paul <sean@poorly.run> writes:
> 
> > From: Sean Paul <seanpaul@chromium.org>
> >
> > Sphinx really wants colons after arguments :/
> >
> > Fixes the following warnings:
> > drm_gem.c:1384: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add'
> > drm_gem.c:1384: warning: Function parameter or member 'fence' not described in 'drm_gem_fence_array_add'
> > drm_gem.c:1435: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add_implicit'
> > drm_gem.c:1435: warning: Function parameter or member 'obj' not described in 'drm_gem_fence_array_add_implicit'
> > drm_gem.c:1435: warning: Function parameter or member 'write' not described in 'drm_gem_fence_array_add_implicit'
> 
> Hopefully some day we can move to gitlab and have CI and make sure we
> don't screw this stuff up ever again.

0day is supposed to catch new htmldocs errors meanwhile, but I get a
feeling it's totally overloaded and so always a bit too late :-/ Or people
just ignore 0day mails, dunno ...
-Daniel

> 
> Reviewed-by: Eric Anholt <eric@anholt.net>
Sean Paul April 25, 2019, 2:16 p.m. UTC | #3 
On Wed, Apr 24, 2019 at 02:59:00PM -0700, Eric Anholt wrote:
> Sean Paul <sean@poorly.run> writes:
> 
> > From: Sean Paul <seanpaul@chromium.org>
> >
> > Sphinx really wants colons after arguments :/
> >
> > Fixes the following warnings:
> > drm_gem.c:1384: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add'
> > drm_gem.c:1384: warning: Function parameter or member 'fence' not described in 'drm_gem_fence_array_add'
> > drm_gem.c:1435: warning: Function parameter or member 'fence_array' not described in 'drm_gem_fence_array_add_implicit'
> > drm_gem.c:1435: warning: Function parameter or member 'obj' not described in 'drm_gem_fence_array_add_implicit'
> > drm_gem.c:1435: warning: Function parameter or member 'write' not described in 'drm_gem_fence_array_add_implicit'
> 
> Hopefully some day we can move to gitlab and have CI and make sure we
> don't screw this stuff up ever again.

Fingers crossed :) Until then, this has been pushed with your R-b, thanks!

Sean

> 
> Reviewed-by: Eric Anholt <eric@anholt.net>
diff mbox series

Patch

diff --git a/drivers/gpu/drm/drm_gem.c b/drivers/gpu/drm/drm_gem.c
index fae4676707b6..50de138c89e0 100644
--- a/drivers/gpu/drm/drm_gem.c
+++ b/drivers/gpu/drm/drm_gem.c
@@ -1372,8 +1372,8 @@  EXPORT_SYMBOL(drm_gem_unlock_reservations);
  * drm_gem_fence_array_add - Adds the fence to an array of fences to be
  * waited on, deduplicating fences from the same context.
  *
- * @fence_array array of dma_fence * for the job to block on.
- * @fence the dma_fence to add to the list of dependencies.
+ * @fence_array: array of dma_fence * for the job to block on.
+ * @fence: the dma_fence to add to the list of dependencies.
  *
  * Returns:
  * 0 on success, or an error on failing to expand the array.
@@ -1423,9 +1423,9 @@  EXPORT_SYMBOL(drm_gem_fence_array_add);
  * GEM objects used in the job but before updating the reservations with your
  * own fences.
  *
- * @fence_array array of dma_fence * for the job to block on.
- * @obj the gem object to add new dependencies from.
- * @write whether the job might write the object (so we need to depend on
+ * @fence_array: array of dma_fence * for the job to block on.
+ * @obj: the gem object to add new dependencies from.
+ * @write: whether the job might write the object (so we need to depend on
  * shared fences in the reservation object).
  */
 int drm_gem_fence_array_add_implicit(struct xarray *fence_array,