| Message ID | 20191003075118.6257-1-andrzej.p@collabora.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm: Fix comment doc for format_modifiers | expand |
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. 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
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 >
On Fri, Oct 04, 2019 at 08:08:26PM +0100, Eric Engestrom wrote: > 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/). OK, so I guess I really am blind. > > 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 > >
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
To human readers "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. 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 an array of structs. Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@collabora.com> --- drivers/gpu/drm/drm_plane.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)