diff mbox series

[v2] drm/connector: document DRM_MODE_COLORIMETRY_COUNT

Message ID 20230906-topic-drm_connector_doc-v2-1-1f2dcaa43269@gmail.com (mailing list archive)
State New, archived
Headers show
Series [v2] drm/connector: document DRM_MODE_COLORIMETRY_COUNT | expand

Commit Message

Javier Carrasco Sept. 6, 2023, 8:47 p.m. UTC 
The drm_colorspace enum member DRM_MODE_COLORIMETRY_COUNT has been
properly documented by moving the description out of the enum to the
member description list to get rid of an additional warning and improve
documentation clarity.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
---
Changes in v2:
- Remove applied changes in linux-next (supported_colorspaces
  documentation)
- Link to v1: https://lore.kernel.org/r/20230906-topic-drm_connector_doc-v1-1-f4ce7ad0150c@gmail.com
---
 include/drm/drm_connector.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)


---
base-commit: 65d6e954e37872fd9afb5ef3fc0481bb3c2f20f4
change-id: 20230906-topic-drm_connector_doc-42dae3ba43c6

Best regards,

Comments

Jani Nikula Sept. 11, 2023, 10:23 a.m. UTC | #1 
On Thu, 07 Sep 2023, Maxime Ripard <mripard@kernel.org> wrote:
> On Wed, 06 Sep 2023 22:47:38 +0200, Javier Carrasco wrote:
>> The drm_colorspace enum member DRM_MODE_COLORIMETRY_COUNT has been
>> properly documented by moving the description out of the enum to the
>> member description list to get rid of an additional warning and improve
>> documentation clarity.
>> 
>> 
>
> Applied to drm/drm-misc (drm-misc-next).

After the fact, but adding /* private: */ would've been an alternative
approach. I think support for that for enums should be there.

Anyway, just for future reference, the merged patch is fine.

BR,
Jani.

>
> Thanks!
> Maxime
>
Randy Dunlap Sept. 11, 2023, 3:16 p.m. UTC | #2 
On 9/11/23 03:23, Jani Nikula wrote:
> On Thu, 07 Sep 2023, Maxime Ripard <mripard@kernel.org> wrote:
>> On Wed, 06 Sep 2023 22:47:38 +0200, Javier Carrasco wrote:
>>> The drm_colorspace enum member DRM_MODE_COLORIMETRY_COUNT has been
>>> properly documented by moving the description out of the enum to the
>>> member description list to get rid of an additional warning and improve
>>> documentation clarity.
>>>
>>>
>>
>> Applied to drm/drm-misc (drm-misc-next).
> 
> After the fact, but adding /* private: */ would've been an alternative
> approach. I think support for that for enums should be there.

Yes, that was the first patch that I sent....
but nobody picked it up.

> 
> Anyway, just for future reference, the merged patch is fine.
> 
> BR,
> Jani.
> 
>>
>> Thanks!
>> Maxime
diff mbox series

Patch

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index d300fde6c1a4..18cf46e3478b 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -498,6 +498,8 @@  enum drm_privacy_screen_status {
  *   ITU-R BT.601 colorimetry format
  *   The DP spec does not say whether this is the 525 or the 625
  *   line version.
+ * @DRM_MODE_COLORIMETRY_COUNT:
+ *   Not a valid value; merely used four counting
  */
 enum drm_colorspace {
 	/* For Default case, driver will set the colorspace */
@@ -522,7 +524,6 @@  enum drm_colorspace {
 	DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED	= 13,
 	DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT	= 14,
 	DRM_MODE_COLORIMETRY_BT601_YCC		= 15,
-	/* not a valid value; merely used for counting */
 	DRM_MODE_COLORIMETRY_COUNT
 };