[PATCH] drm: Fix kerneldoc warns in connector-related docs
Sam Ravnborg
sam at ravnborg.org
Fri Aug 9 20:15:51 UTC 2019
Hi Sean.
> > > --- a/include/drm/drm_connector.h
> > > +++ b/include/drm/drm_connector.h
> > > @@ -543,8 +543,8 @@ struct drm_connector_state {
> > > *
> > > * This is also used in the atomic helpers to map encoders to their
> > > * current and previous connectors, see
> > > - * &drm_atomic_get_old_connector_for_encoder() and
> > > - * &drm_atomic_get_new_connector_for_encoder().
> > > + * &drm_atomic_get_old_connector_for_encoder and
> > > + * &drm_atomic_get_new_connector_for_encoder.
> > Please fix this to use () for the functions and drop the "&".
> > This is what we use in drm kernel-doc for functions.
> > See for example function references in doc of writeback_job in the same file.
>
> Doing this won't get a hyperlink in the docs. It seems like these hooks aren't
> recognized as functions by sphinx (not sure didn't look into it too deeply). The
> other "_funcs.*" hooks are also handled with '&' (there are lots of examples in
> drm_connector.h).
>
> I think preserving the hyperlinks probably outweighs the missing (), thoughts?
Hmm, I actually tested it here - with sphinx_1.4.9.
The links was preserved, the only difference was that they had the ()
prefixed to their name.
Do you happen to use an older sphinx version?
Sam
More information about the dri-devel
mailing list