diff mbox series

drm/modes: Fix drm_mode_validate_size() docs

Message ID 20220203071326.23681-1-ville.syrjala@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series drm/modes: Fix drm_mode_validate_size() docs | expand

Commit Message

Ville Syrjälä Feb. 3, 2022, 7:13 a.m. UTC 
From: Ville Syrjälä <ville.syrjala@linux.intel.com>

drm_mode_validate_size() does *not* modify the passed in mode's
status (in fact it is passed in as const). Also this operates
on a single mode, so the reference to some list is just confusing.
Remove the nonsense docs.

Signed-off-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
---
 drivers/gpu/drm/drm_modes.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
index 1c72208d8133..425a56a976a1 100644
--- a/drivers/gpu/drm/drm_modes.c
+++ b/drivers/gpu/drm/drm_modes.c
@@ -1136,16 +1136,14 @@  EXPORT_SYMBOL(drm_mode_validate_driver);
 /**
  * drm_mode_validate_size - make sure modes adhere to size constraints
  * @mode: mode to check
  * @maxX: maximum width
  * @maxY: maximum height
  *
- * This function is a helper which can be used to validate modes against size
- * limitations of the DRM device/connector. If a mode is too big its status
- * member is updated with the appropriate validation failure code. The list
- * itself is not changed.
+ * This function is a helper which can be used to validate
+ * modes against size limitations of the DRM device/connector.
  *
  * Returns:
  * The mode status
  */
 enum drm_mode_status
 drm_mode_validate_size(const struct drm_display_mode *mode,