| Message ID | 77a7f3044f603bf9f18b93aa3d44517670c37d67.1683041799.git.jani.nikula@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/i915: fix kernel-doc warnings, enable kernel-doc -Werror | expand |
On Tue, May 02, 2023 at 06:37:28PM +0300, Jani Nikula wrote: > drivers/gpu/drm/i915/gem/i915_gem_ttm.h:50: warning: Function parameter or member 'bo' not described in 'i915_ttm_to_gem' > > Signed-off-by: Jani Nikula <jani.nikula@intel.com> > --- > drivers/gpu/drm/i915/gem/i915_gem_ttm.h | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h > index f8f6bed1b297..70abdc3061a9 100644 > --- a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h > +++ b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h > @@ -42,6 +42,7 @@ static inline bool i915_ttm_is_ghost_object(struct ttm_buffer_object *bo) > /** > * i915_ttm_to_gem - Convert a struct ttm_buffer_object to an embedding > * struct drm_i915_gem_object. > + * @bo: Pointer to the ttm buffer object > * > * Return: Pointer to the embedding struct ttm_buffer_object. I understand the goal is to fix the warnings, but while at it, would you mind also fixing the Return? this was likely a bad copy and paste from i915_gem_to_ttm and the right one should be something like Return: Pointer to the embedding struct drm_i915_gem_object. > */ > -- > 2.39.2 >
On Wed, 03 May 2023, Rodrigo Vivi <rodrigo.vivi@kernel.org> wrote: > On Tue, May 02, 2023 at 06:37:28PM +0300, Jani Nikula wrote: >> drivers/gpu/drm/i915/gem/i915_gem_ttm.h:50: warning: Function parameter or member 'bo' not described in 'i915_ttm_to_gem' >> >> Signed-off-by: Jani Nikula <jani.nikula@intel.com> >> --- >> drivers/gpu/drm/i915/gem/i915_gem_ttm.h | 1 + >> 1 file changed, 1 insertion(+) >> >> diff --git a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h >> index f8f6bed1b297..70abdc3061a9 100644 >> --- a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h >> +++ b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h >> @@ -42,6 +42,7 @@ static inline bool i915_ttm_is_ghost_object(struct ttm_buffer_object *bo) >> /** >> * i915_ttm_to_gem - Convert a struct ttm_buffer_object to an embedding >> * struct drm_i915_gem_object. >> + * @bo: Pointer to the ttm buffer object >> * >> * Return: Pointer to the embedding struct ttm_buffer_object. > > I understand the goal is to fix the warnings, but while at it, > would you mind also fixing the Return? > > this was likely a bad copy and paste from i915_gem_to_ttm > and the right one should be something like > > Return: Pointer to the embedding struct drm_i915_gem_object. v2 at https://patchwork.freedesktop.org/patch/msgid/20230504092320.1787627-1-jani.nikula@intel.com > >> */ >> -- >> 2.39.2 >>
diff --git a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h index f8f6bed1b297..70abdc3061a9 100644 --- a/drivers/gpu/drm/i915/gem/i915_gem_ttm.h +++ b/drivers/gpu/drm/i915/gem/i915_gem_ttm.h @@ -42,6 +42,7 @@ static inline bool i915_ttm_is_ghost_object(struct ttm_buffer_object *bo) /** * i915_ttm_to_gem - Convert a struct ttm_buffer_object to an embedding * struct drm_i915_gem_object. + * @bo: Pointer to the ttm buffer object * * Return: Pointer to the embedding struct ttm_buffer_object. */
drivers/gpu/drm/i915/gem/i915_gem_ttm.h:50: warning: Function parameter or member 'bo' not described in 'i915_ttm_to_gem' Signed-off-by: Jani Nikula <jani.nikula@intel.com> --- drivers/gpu/drm/i915/gem/i915_gem_ttm.h | 1 + 1 file changed, 1 insertion(+)