From: Eric Engestrom <eric.engestrom@intel.com>
To: "Ville Syrjälä" <ville.syrjala@linux.intel.com>
Cc: Andrzej Pietrasiewicz <andrzej.p@collabora.com>,
David Airlie <airlied@linux.ie>,
linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
Maxime Ripard <mripard@kernel.org>,
kernel@collabora.com, Sean Paul <sean@poorly.run>
Subject: Re: [PATCH] drm: Fix comment doc for format_modifiers
Date: Fri, 4 Oct 2019 20:08:26 +0100 [thread overview]
Message-ID: <20191004190826.x26gb5wnurmwobej@intel.com> (raw)
In-Reply-To: <20191003135318.GH1208@intel.com>
On Thursday, 2019-10-03 16:53:18 +0300, Ville Syrjälä wrote:
> On Thu, Oct 03, 2019 at 09:51:18AM +0200, Andrzej Pietrasiewicz wrote:
> > To human readers
>
> The commit message is always for human readers, no need to point that
> out...
>
> >
> > "array of struct drm_format modifiers" is almost indistinguishable from
> > "array of struct drm_format_modifiers", especially given that
> > struct drm_format_modifier does exist.
>
> ..but this paragraph still manages to 100% confuse this particular human.
There's an underscore instead of a space on the second line
(s/drm_format modifiers/drm_format_modifiers/).
It should definitely be reworded to be much clearer.
>
> The actual code changes lgtm, so with the commit message reworded
> this patch is
> Reviewed-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
>
> >
> > And indeed the parameter passes an array of uint64_t rather than an array
> > of structs, but the first words of the comment suggest that it passes
> >
> > Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@collabora.com>
> > ---
> > drivers/gpu/drm/drm_plane.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/gpu/drm/drm_plane.c b/drivers/gpu/drm/drm_plane.c
> > index d6ad60ab0d38..0d4f9172c0dd 100644
> > --- a/drivers/gpu/drm/drm_plane.c
> > +++ b/drivers/gpu/drm/drm_plane.c
> > @@ -160,7 +160,7 @@ static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane
> > * @funcs: callbacks for the new plane
> > * @formats: array of supported formats (DRM_FORMAT\_\*)
> > * @format_count: number of elements in @formats
> > - * @format_modifiers: array of struct drm_format modifiers terminated by
> > + * @format_modifiers: array of format modifiers terminated by
> > * DRM_FORMAT_MOD_INVALID
> > * @type: type of plane (overlay, primary, cursor)
> > * @name: printf style format string for the plane name, or NULL for default name
> > --
> > 2.17.1
> >
> > _______________________________________________
> > dri-devel mailing list
> > dri-devel@lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/dri-devel
>
next prev parent reply other threads:[~2019-10-04 19:08 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-02 15:43 [PATCH] drm: Fix comment doc for format_modifiers Andrzej Pietrasiewicz
2019-10-02 16:18 ` Ville Syrjälä
2019-10-02 18:30 ` Sam Ravnborg
2019-10-03 7:51 ` Andrzej Pietrasiewicz
2019-10-03 13:53 ` Ville Syrjälä
2019-10-04 19:08 ` Eric Engestrom [this message]
2019-10-04 19:28 ` Ville Syrjälä
2019-10-08 13:01 ` Andrzej Pietrasiewicz
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=20191004190826.x26gb5wnurmwobej@intel.com \
--to=eric.engestrom@intel.com \
--cc=airlied@linux.ie \
--cc=andrzej.p@collabora.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=kernel@collabora.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mripard@kernel.org \
--cc=sean@poorly.run \
--cc=ville.syrjala@linux.intel.com \
/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;
as well as URLs for NNTP newsgroup(s).