Skip to contentSkip to conversation

drm/encoder: Various doc fixes

PATCH In review Lyude Paul 2 participants 5 messages Sep 13, 2019 – Sep 17, 2019

Subsystems (2)
lore
Share & tools
lore

Lyude Paul

author
#0 lore raw

cover drm/encoder: Various doc fixes

Some random issues with documentation that I noticed while working on nouveau the other day. There are no functional changes in this series.

Lyude Paul (3):
drm/encoder: Fix possible_clones documentation drm/encoder: Fix possible_crtcs documentation drm/encoder: Don't raise voice in drm_encoder_mask() documentation

 include/drm/drm_encoder.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Signature · 1 line
2.21.0
author
#1 lore raw

PATCH 1/3 drm/encoder: Fix possible_clones documentation

We say that all of the bits in possible_clones must be set before calling drm_encoder_init(). This isn't true though, since:

* The driver may not even have all of the encoder objects that could be used as clones initialized at that point
* possible_crtcs isn't used at all outside of userspace, so it's not actually needed to initialize it until drm_dev_register()

So, fix it.

---
 include/drm/drm_encoder.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/drm/drm_encoder.h +1 -1
index 70cfca03d812..81273b50b3f6 100644
@@ -154,7 +154,7 @@ struct drm_encoder {
 	 * using drm_encoder_index() as the index into the bitfield. The driver
 	 * must set the bits for all &drm_encoder objects which can clone a
 	 * &drm_crtc together with this encoder before calling
-	 * drm_encoder_init(). Drivers should set the bit representing the
+	 * drm_dev_register(). Drivers should set the bit representing the
 	 * encoder itself, too. Cloning bits should be set such that when two
 	 * encoders can be used in a cloned configuration, they both should have
 	 * each another bits set.
Signature · 1 line
2.21.0
author
#2 lore raw

PATCH 2/3 drm/encoder: Fix possible_crtcs documentation

In reply to Lyude Paul

Similar to possible_clones, we don't actually use possible_crtcs until the driver is registered with userspace. So, fix the documentation to indicate this.

---
 include/drm/drm_encoder.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/drm/drm_encoder.h +1 -1
index 81273b50b3f6..d65173d413b7 100644
@@ -140,7 +140,7 @@ struct drm_encoder {
 	 * @possible_crtcs: Bitmask of potential CRTC bindings, using
 	 * drm_crtc_index() as the index into the bitfield. The driver must set
 	 * the bits for all &drm_crtc objects this encoder can be connected to
-	 * before calling drm_encoder_init().
+	 * before calling drm_dev_register().
 	 *
 	 * In reality almost every driver gets this wrong.
 	 *
Signature · 1 line
2.21.0
author
#3 lore raw

PATCH 3/3 drm/encoder: Don't raise voice in drm_encoder_mask() documentation

In reply to Lyude Paul

There's no need to raise our voice when saying encoder, we're all civilized adults here!

---
 include/drm/drm_encoder.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/drm/drm_encoder.h +1 -1
index d65173d413b7..f06164f44efe 100644
@@ -198,7 +198,7 @@ static inline unsigned int drm_encoder_index(const struct drm_encoder *encoder)
 }
 
 /**
- * drm_encoder_mask - find the mask of a registered ENCODER
+ * drm_encoder_mask - find the mask of a registered encoder
  * @encoder: encoder to find mask for
  *
  * Given a registered encoder, return the mask bit of that encoder for an
Signature · 1 line
2.21.0
Reviewed-by on the v1 series
#4 lore raw
In reply to Lyude Paul
Quoted 2 lines · Lyude Paul

Some random issues with documentation that I noticed while working on nouveau the other day. There are no functional changes in this series.

Nice! On all three:

Quoted 13 lines

Lyude Paul (3):
drm/encoder: Fix possible_clones documentation drm/encoder: Fix possible_crtcs documentation drm/encoder: Don't raise voice in drm_encoder_mask() documentation

 include/drm/drm_encoder.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Signature · 1 line
2.21.0
Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel