From mboxrd@z Thu Jan 1 00:00:00 1970 From: Andrzej Pietrasiewicz Subject: [PATCH] drm: Fix comment doc for format_modifiers Date: Tue, 8 Oct 2019 15:01:49 +0200 Message-ID: <20191008130150.11399-1-andrzej.p@collabora.com> References: <20191004192801.GJ1208@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Return-path: In-Reply-To: <20191004192801.GJ1208@intel.com> Sender: linux-kernel-owner@vger.kernel.org To: dri-devel@lists.freedesktop.org Cc: kernel@collabora.com, Maarten Lankhorst , Maxime Ripard , Sean Paul , David Airlie , Daniel Vetter , linux-kernel@vger.kernel.org List-Id: dri-devel@lists.freedesktop.org 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 - if the reader stops reading at the word "struct". If the commit is read beyond that point the reader will likely confuse "drm_formatmodifiers" with "drm_formatmodifiers" and understand the meaning as "passing an array of elements which are of type struct drm_format_modifier". That is not correct. Only if the reader is able to read the comment as "array of struct drm_formatmodifiers" will they be close to the correct meaning. But still not quite there, because the modifiers do not influence struct drm_format in any way - it is not clear what "a modifier of a struct" would be. The comment is changed to simply say that the parameter passes an array of format modifiers, which is the correct meaning. Signed-off-by: Andrzej Pietrasiewicz Reviewed-by: Ville Syrjälä --- 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