[PATCH] drm: Fix comment doc for format_modifiers

Ville Syrjälä ville.syrjala at linux.intel.com
Wed Oct 2 16:31:47 UTC 2019


On Wed, Oct 02, 2019 at 06:22:23PM +0200, Andrzej Pietrasiewicz wrote:
> Hi Ville,
> 
> W dniu 02.10.2019 o 18:18, Ville Syrjälä pisze:
> > On Wed, Oct 02, 2019 at 05:43:49PM +0200, Andrzej Pietrasiewicz wrote:
> >> To human readers
> >>
> >> "array of struct drm_format modifiers" is almost indistinguishable from
> >> "array of struct drm_format_modifiers",
> > 
> > Unless I'm blind those two *are* indistinguishable :P
> > 
> >> 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 at 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..df05d8a0dd63 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
> > 
> > Looks like you have a broken version of git.
> > 
> >>    * @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 modifiers of struct drm_format terminated by
> > 
> > Now it seems to be saying it's passing in struct drm_format foo[].
> > That doesn't seem right either.
> 
> Good point!
> 
> array of modifiers applied to struct drm_format?

Not sure what this has to do with that struct?

I think I'd just make it "array of modifiers terminated by ..."

-- 
Ville Syrjälä
Intel


More information about the dri-devel mailing list