Skip to contentSkip to conversation

drm/doc: Fix up some kms function names

PATCH In review Archit Taneja 3 participants 5 messages Feb 22, 2017 – Feb 27, 2017

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/doc: Fix up some kms function names

A couple of the kms functions didn't have the correct/newest names. This prevented them to be identified as refs in the html doc.

---
 include/drm/drm_mode_config.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/drm/drm_mode_config.h +3 -3
index 6cd541d69c2e..888cc038899b 100644
@@ -267,7 +267,7 @@ struct drm_mode_config_funcs {
 	 * passed-in &drm_atomic_state. This hook is called when the caller
 	 * encountered a &drm_modeset_lock deadlock and needs to drop all
 	 * already acquired locks as part of the deadlock avoidance dance
-	 * implemented in drm_modeset_lock_backoff().
+	 * implemented in drm_modeset_backoff().
 	 *
 	 * Any duplicated state must be invalidated since a concurrent atomic
 	 * update might change it, and the drm atomic interfaces always apply
@@ -285,8 +285,8 @@ struct drm_mode_config_funcs {
 	 * itself. Note that the core first calls drm_atomic_state_clear() to
 	 * avoid code duplicate between the clear and free hooks.
 	 *
-	 * Drivers that implement this must call drm_atomic_state_default_free()
-	 * to release common resources.
+	 * Drivers that implement this must call
+	 * drm_atomic_state_default_release() to release common resources.
 	 */
 	void (*atomic_state_free)(struct drm_atomic_state *state);
 };
Signature · 7 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
hosted by The Linux Foundation

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Reviewed-by Tested-by on v1 1/1
#1 lore raw
Quoted 4 lines · Archit Taneja

A couple of the kms functions didn't have the correct/newest names. This prevented them to be identified as refs in the html doc.

Thanks!

There's a lot of other symbols not ref-linked because of incorrect syntax, including in this file; can I interest you in fixing those as well? :)

Quoted 32 lines
---
 include/drm/drm_mode_config.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/drm/drm_mode_config.h +3 -3
index 6cd541d69c2e..888cc038899b 100644
@@ -267,7 +267,7 @@ struct drm_mode_config_funcs {
 	 * passed-in &drm_atomic_state. This hook is called when the caller
 	 * encountered a &drm_modeset_lock deadlock and needs to drop all
 	 * already acquired locks as part of the deadlock avoidance dance
-	 * implemented in drm_modeset_lock_backoff().
+	 * implemented in drm_modeset_backoff().
 	 *
 	 * Any duplicated state must be invalidated since a concurrent atomic
 	 * update might change it, and the drm atomic interfaces always apply
@@ -285,8 +285,8 @@ struct drm_mode_config_funcs {
 	 * itself. Note that the core first calls drm_atomic_state_clear() to
 	 * avoid code duplicate between the clear and free hooks.
 	 *
-	 * Drivers that implement this must call drm_atomic_state_default_free()
-	 * to release common resources.
+	 * Drivers that implement this must call
+	 * drm_atomic_state_default_release() to release common resources.
 	 */
 	void (*atomic_state_free)(struct drm_atomic_state *state);
 };
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
hosted by The Linux Foundation

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#2 lore raw
Quoted 4 lines · Eric Engestrom
Quoted 3 lines · Archit Taneja

A couple of the kms functions didn't have the correct/newest names. This prevented them to be identified as refs in the html doc.

Quoted 8 lines
Quoted 1 line

Thanks!

There's a lot of other symbols not ref-linked because of incorrect syntax, including in this file; can I interest you in fixing those as well? :)

Yeah, I'll try to fix them as I continue reading the docs :)

Archit

Quoted 33 lines
Quoted 33 lines
---
 include/drm/drm_mode_config.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/drm/drm_mode_config.h +3 -4
index 6cd541d69c2e..888cc038899b 100644
@@ -267,7 +267,7 @@ struct drm_mode_config_funcs {
 	 * passed-in &drm_atomic_state. This hook is called when the caller
 	 * encountered a &drm_modeset_lock deadlock and needs to drop all
 	 * already acquired locks as part of the deadlock avoidance dance
-	 * implemented in drm_modeset_lock_backoff().
+	 * implemented in drm_modeset_backoff().
 	 *
 	 * Any duplicated state must be invalidated since a concurrent atomic
 	 * update might change it, and the drm atomic interfaces always apply
@@ -285,8 +285,8 @@ struct drm_mode_config_funcs {
 	 * itself. Note that the core first calls drm_atomic_state_clear() to
 	 * avoid code duplicate between the clear and free hooks.
 	 *
-	 * Drivers that implement this must call drm_atomic_state_default_free()
-	 * to release common resources.
+	 * Drivers that implement this must call
+	 * drm_atomic_state_default_release() to release common resources.
 	 */
 	void (*atomic_state_free)(struct drm_atomic_state *state);
 };
--

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, hosted by The Linux Foundation

Signature · 6 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
hosted by The Linux Foundation
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
#3 lore raw
Quoted 9 lines · Archit Taneja
Quoted 6 lines · Eric Engestrom
Quoted 4 lines · Archit Taneja

A couple of the kms functions didn't have the correct/newest names. This prevented them to be identified as refs in the html doc.

Quoted 8 lines
Quoted 6 lines

Thanks!

There's a lot of other symbols not ref-linked because of incorrect syntax, including in this file; can I interest you in fixing those as well? :)

Yeah, I'll try to fix them as I continue reading the docs :)

Since you have drm-misc commit rights, I assume you'll push this directly? -Daniel

Quoted 44 lines

Archit

Quoted 33 lines
Quoted 33 lines
---
 include/drm/drm_mode_config.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/drm/drm_mode_config.h +3 -4
index 6cd541d69c2e..888cc038899b 100644
@@ -267,7 +267,7 @@ struct drm_mode_config_funcs {
 	 * passed-in &drm_atomic_state. This hook is called when the caller
 	 * encountered a &drm_modeset_lock deadlock and needs to drop all
 	 * already acquired locks as part of the deadlock avoidance dance
-	 * implemented in drm_modeset_lock_backoff().
+	 * implemented in drm_modeset_backoff().
 	 *
 	 * Any duplicated state must be invalidated since a concurrent atomic
 	 * update might change it, and the drm atomic interfaces always apply
@@ -285,8 +285,8 @@ struct drm_mode_config_funcs {
 	 * itself. Note that the core first calls drm_atomic_state_clear() to
 	 * avoid code duplicate between the clear and free hooks.
 	 *
-	 * Drivers that implement this must call drm_atomic_state_default_free()
-	 * to release common resources.
+	 * Drivers that implement this must call
+	 * drm_atomic_state_default_release() to release common resources.
 	 */
 	void (*atomic_state_free)(struct drm_atomic_state *state);
 };
--

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, hosted by The Linux Foundation

Signature · 6 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
hosted by The Linux Foundation
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
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
#4 lore raw
Quoted 14 lines · Daniel Vetter
Quoted 13 lines · Archit Taneja
Quoted 10 lines · Eric Engestrom
Quoted 4 lines · Archit Taneja

A couple of the kms functions didn't have the correct/newest names. This prevented them to be identified as refs in the html doc.

Thanks!

Quoted 6 lines
Quoted 4 lines
Quoted 2 lines

There's a lot of other symbols not ref-linked because of incorrect syntax, including in this file; can I interest you in fixing those as well? :)

Yeah, I'll try to fix them as I continue reading the docs :)

Since you have drm-misc commit rights, I assume you'll push this directly?

Yes. Applied.

Archit

Quoted 47 lines

-Daniel

Quoted 44 lines

Archit

Quoted 25 lines
Quoted 25 lines
---
 include/drm/drm_mode_config.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/drm/drm_mode_config.h +2 -3
index 6cd541d69c2e..888cc038899b 100644
@@ -267,7 +267,7 @@ struct drm_mode_config_funcs {
 	 * passed-in &drm_atomic_state. This hook is called when the caller
 	 * encountered a &drm_modeset_lock deadlock and needs to drop all
 	 * already acquired locks as part of the deadlock avoidance dance
-	 * implemented in drm_modeset_lock_backoff().
+	 * implemented in drm_modeset_backoff().
 	 *
 	 * Any duplicated state must be invalidated since a concurrent atomic
 	 * update might change it, and the drm atomic interfaces always apply
@@ -285,8 +285,8 @@ struct drm_mode_config_funcs {
 	 * itself. Note that the core first calls drm_atomic_state_clear() to
 	 * avoid code duplicate between the clear and free hooks.
 	 *
-	 * Drivers that implement this must call drm_atomic_state_default_free()
-	 * to release common resources.
+	 * Drivers that implement this must call
Quoted 8 lines
Quoted 8 lines
include/drm/drm_mode_config.h +1 -1
+	 * drm_atomic_state_default_release() to release common resources.
 	 */
 	void (*atomic_state_free)(struct drm_atomic_state *state);
 };
--

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, hosted by The Linux Foundation

--
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, hosted by The Linux Foundation
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Signature · 6 lines
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel