From: Sam Ravnborg <sam@ravnborg.org>
To: Sean Paul <sean@poorly.run>
Cc: Pekka Paalanen <pekka.paalanen@collabora.com>,
Jani Nikula <jani.nikula@intel.com>,
David Airlie <airlied@linux.ie>,
dri-devel@lists.freedesktop.org,
Maxime Ripard <maxime.ripard@bootlin.com>,
Sean Paul <seanpaul@chromium.org>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Subject: Re: [PATCH] drm: Fix kerneldoc warns in connector-related docs
Date: Fri, 9 Aug 2019 23:06:07 +0200 [thread overview]
Message-ID: <20190809210607.GA852@ravnborg.org> (raw)
In-Reply-To: <20190809202911.GE104440@art_vandelay>
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?
>
> I'm on 1.7.9. I just rechecked and was a bit confused in my last mail. The
> drm_atomic_get_*_connector_for_encoder links do work with (), it's the ones
> drm_connector_helper_funcs in the paragraph above that need the '&'. So I'll
> switch up these 2 and leave the others as-is. Cool?
Perfect!
You can add my:
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>
and then apply.
Sam
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2019-08-09 21:06 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-07 16:28 [PATCH] drm: Fix kerneldoc warns in connector-related docs Sean Paul
2019-08-07 17:30 ` Sam Ravnborg
2019-08-09 19:05 ` Sean Paul
2019-08-09 20:15 ` Sam Ravnborg
2019-08-09 20:29 ` Sean Paul
2019-08-09 21:06 ` Sam Ravnborg [this message]
2019-08-12 14:01 ` [PATCH v2] " Sean Paul
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=20190809210607.GA852@ravnborg.org \
--to=sam@ravnborg.org \
--cc=airlied@linux.ie \
--cc=dri-devel@lists.freedesktop.org \
--cc=jani.nikula@intel.com \
--cc=laurent.pinchart@ideasonboard.com \
--cc=maxime.ripard@bootlin.com \
--cc=pekka.paalanen@collabora.com \
--cc=sean@poorly.run \
--cc=seanpaul@chromium.org \
/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