| Message ID | 20220120094856.3004147-1-jani.nikula@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/locking: fix drm_modeset_acquire_ctx kernel-doc | expand |
On Thu, Jan 20, 2022 at 10:49 AM Jani Nikula <jani.nikula@intel.com> wrote: > > The stack_depot member was added without kernel-doc, leading to below > warning. Fix it. > > ./include/drm/drm_modeset_lock.h:74: warning: Function parameter or > member 'stack_depot' not described in 'drm_modeset_acquire_ctx' > > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Fixes: cd06ab2fd48f ("drm/locking: add backtrace for locking contended locks without backoff") > Signed-off-by: Jani Nikula <jani.nikula@intel.com> > --- > include/drm/drm_modeset_lock.h | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h > index b84693fbd2b5..ec4f543c3d95 100644 > --- a/include/drm/drm_modeset_lock.h > +++ b/include/drm/drm_modeset_lock.h > @@ -34,6 +34,7 @@ struct drm_modeset_lock; > * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx) > * @ww_ctx: base acquire ctx > * @contended: used internally for -EDEADLK handling > + * @stack_depot: used internally for contention debugging Uh would be nice to switch to the inline style, since we already have inline comments (just not kerneldoc). Either way: Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch> > * @locked: list of held locks > * @trylock_only: trylock mode used in atomic contexts/panic notifiers > * @interruptible: whether interruptible locking should be used. > -- > 2.30.2 >
Hi Jani, On Thu, 20 Jan 2022 11:48:56 +0200 Jani Nikula <jani.nikula@intel.com> wrote: > > The stack_depot member was added without kernel-doc, leading to below > warning. Fix it. > > ./include/drm/drm_modeset_lock.h:74: warning: Function parameter or > member 'stack_depot' not described in 'drm_modeset_acquire_ctx' > > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Fixes: cd06ab2fd48f ("drm/locking: add backtrace for locking contended locks without backoff") > Signed-off-by: Jani Nikula <jani.nikula@intel.com> > --- > include/drm/drm_modeset_lock.h | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h > index b84693fbd2b5..ec4f543c3d95 100644 > --- a/include/drm/drm_modeset_lock.h > +++ b/include/drm/drm_modeset_lock.h > @@ -34,6 +34,7 @@ struct drm_modeset_lock; > * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx) > * @ww_ctx: base acquire ctx > * @contended: used internally for -EDEADLK handling > + * @stack_depot: used internally for contention debugging > * @locked: list of held locks > * @trylock_only: trylock mode used in atomic contexts/panic notifiers > * @interruptible: whether interruptible locking should be used. > -- > 2.30.2 > Tested-by: Stephen Rothwell <sfr@canb.auug.org.au> Thanks.
On Thu, 20 Jan 2022, Daniel Vetter <daniel@ffwll.ch> wrote: > On Thu, Jan 20, 2022 at 10:49 AM Jani Nikula <jani.nikula@intel.com> wrote: >> >> The stack_depot member was added without kernel-doc, leading to below >> warning. Fix it. >> >> ./include/drm/drm_modeset_lock.h:74: warning: Function parameter or >> member 'stack_depot' not described in 'drm_modeset_acquire_ctx' >> >> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> >> Fixes: cd06ab2fd48f ("drm/locking: add backtrace for locking contended locks without backoff") >> Signed-off-by: Jani Nikula <jani.nikula@intel.com> >> --- >> include/drm/drm_modeset_lock.h | 1 + >> 1 file changed, 1 insertion(+) >> >> diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h >> index b84693fbd2b5..ec4f543c3d95 100644 >> --- a/include/drm/drm_modeset_lock.h >> +++ b/include/drm/drm_modeset_lock.h >> @@ -34,6 +34,7 @@ struct drm_modeset_lock; >> * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx) >> * @ww_ctx: base acquire ctx >> * @contended: used internally for -EDEADLK handling >> + * @stack_depot: used internally for contention debugging > > Uh would be nice to switch to the inline style, since we already have > inline comments (just not kerneldoc). Either way: Considered that, but looks like it's been intentionally split to kernel-doc documentation and internal comments, and just wanted to get this quick fix out of the way. > > Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch> Thanks! > > >> * @locked: list of held locks >> * @trylock_only: trylock mode used in atomic contexts/panic notifiers >> * @interruptible: whether interruptible locking should be used. >> -- >> 2.30.2 >>
On Thu, 20 Jan 2022, Daniel Vetter <daniel@ffwll.ch> wrote: > On Thu, Jan 20, 2022 at 10:49 AM Jani Nikula <jani.nikula@intel.com> wrote: >> >> The stack_depot member was added without kernel-doc, leading to below >> warning. Fix it. >> >> ./include/drm/drm_modeset_lock.h:74: warning: Function parameter or >> member 'stack_depot' not described in 'drm_modeset_acquire_ctx' >> >> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> >> Fixes: cd06ab2fd48f ("drm/locking: add backtrace for locking contended locks without backoff") >> Signed-off-by: Jani Nikula <jani.nikula@intel.com> >> --- >> include/drm/drm_modeset_lock.h | 1 + >> 1 file changed, 1 insertion(+) >> >> diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h >> index b84693fbd2b5..ec4f543c3d95 100644 >> --- a/include/drm/drm_modeset_lock.h >> +++ b/include/drm/drm_modeset_lock.h >> @@ -34,6 +34,7 @@ struct drm_modeset_lock; >> * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx) >> * @ww_ctx: base acquire ctx >> * @contended: used internally for -EDEADLK handling >> + * @stack_depot: used internally for contention debugging > > Uh would be nice to switch to the inline style, since we already have > inline comments (just not kerneldoc). Either way: > > Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch> Thanks for the review and testing, pushed to drm-misc-next. BR, Jani. > > >> * @locked: list of held locks >> * @trylock_only: trylock mode used in atomic contexts/panic notifiers >> * @interruptible: whether interruptible locking should be used. >> -- >> 2.30.2 >>
diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h index b84693fbd2b5..ec4f543c3d95 100644 --- a/include/drm/drm_modeset_lock.h +++ b/include/drm/drm_modeset_lock.h @@ -34,6 +34,7 @@ struct drm_modeset_lock; * struct drm_modeset_acquire_ctx - locking context (see ww_acquire_ctx) * @ww_ctx: base acquire ctx * @contended: used internally for -EDEADLK handling + * @stack_depot: used internally for contention debugging * @locked: list of held locks * @trylock_only: trylock mode used in atomic contexts/panic notifiers * @interruptible: whether interruptible locking should be used.
The stack_depot member was added without kernel-doc, leading to below warning. Fix it. ./include/drm/drm_modeset_lock.h:74: warning: Function parameter or member 'stack_depot' not described in 'drm_modeset_acquire_ctx' Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Fixes: cd06ab2fd48f ("drm/locking: add backtrace for locking contended locks without backoff") Signed-off-by: Jani Nikula <jani.nikula@intel.com> --- include/drm/drm_modeset_lock.h | 1 + 1 file changed, 1 insertion(+)