diff mbox

drm/doc: Fix up some kms function names

Message ID 20170222084741.8485-1-architt@codeaurora.org (mailing list archive)
State New, archived
Headers show

Commit Message

Archit Taneja Feb. 22, 2017, 8:47 a.m. UTC
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.

Signed-off-by: Archit Taneja <architt@codeaurora.org>
---
 include/drm/drm_mode_config.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Eric Engestrom Feb. 24, 2017, 1:41 p.m. UTC | #1
On Wednesday, 2017-02-22 14:17:41 +0530, Archit Taneja wrote:
> 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.
> 
> Signed-off-by: Archit Taneja <architt@codeaurora.org>

Thanks!
Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
Tested-by: Eric Engestrom <eric.engestrom@imgtec.com>

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? :)

> ---
>  include/drm/drm_mode_config.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
> index 6cd541d69c2e..888cc038899b 100644
> --- a/include/drm/drm_mode_config.h
> +++ b/include/drm/drm_mode_config.h
> @@ -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
>
Archit Taneja Feb. 26, 2017, 1:44 p.m. UTC | #2
On 2/24/2017 7:11 PM, Eric Engestrom wrote:
> On Wednesday, 2017-02-22 14:17:41 +0530, Archit Taneja wrote:
>> 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.
>>
>> Signed-off-by: Archit Taneja <architt@codeaurora.org>
>
> Thanks!
> Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
> Tested-by: Eric Engestrom <eric.engestrom@imgtec.com>
>
> 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

>
>> ---
>>  include/drm/drm_mode_config.h | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
>> index 6cd541d69c2e..888cc038899b 100644
>> --- a/include/drm/drm_mode_config.h
>> +++ b/include/drm/drm_mode_config.h
>> @@ -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
>>
Daniel Vetter Feb. 26, 2017, 9:47 p.m. UTC | #3
On Sun, Feb 26, 2017 at 07:14:07PM +0530, Archit Taneja wrote:
> 
> 
> On 2/24/2017 7:11 PM, Eric Engestrom wrote:
> > On Wednesday, 2017-02-22 14:17:41 +0530, Archit Taneja wrote:
> > > 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.
> > > 
> > > Signed-off-by: Archit Taneja <architt@codeaurora.org>
> > 
> > Thanks!
> > Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
> > Tested-by: Eric Engestrom <eric.engestrom@imgtec.com>
> > 
> > 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

> 
> Archit
> 
> > 
> > > ---
> > >  include/drm/drm_mode_config.h | 6 +++---
> > >  1 file changed, 3 insertions(+), 3 deletions(-)
> > > 
> > > diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
> > > index 6cd541d69c2e..888cc038899b 100644
> > > --- a/include/drm/drm_mode_config.h
> > > +++ b/include/drm/drm_mode_config.h
> > > @@ -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
> > > 
> 
> -- 
> The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
> hosted by The Linux Foundation
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
Archit Taneja Feb. 27, 2017, 3:27 a.m. UTC | #4
On 02/27/2017 03:17 AM, Daniel Vetter wrote:
> On Sun, Feb 26, 2017 at 07:14:07PM +0530, Archit Taneja wrote:
>>
>>
>> On 2/24/2017 7:11 PM, Eric Engestrom wrote:
>>> On Wednesday, 2017-02-22 14:17:41 +0530, Archit Taneja wrote:
>>>> 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.
>>>>
>>>> Signed-off-by: Archit Taneja <architt@codeaurora.org>
>>>
>>> Thanks!
>>> Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
>>> Tested-by: Eric Engestrom <eric.engestrom@imgtec.com>
>>>
>>> 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

> -Daniel
>
>>
>> Archit
>>
>>>
>>>> ---
>>>>  include/drm/drm_mode_config.h | 6 +++---
>>>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>>>
>>>> diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
>>>> index 6cd541d69c2e..888cc038899b 100644
>>>> --- a/include/drm/drm_mode_config.h
>>>> +++ b/include/drm/drm_mode_config.h
>>>> @@ -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
>>>>
>>
>> --
>> The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
>> hosted by The Linux Foundation
>> _______________________________________________
>> dri-devel mailing list
>> dri-devel@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
>
diff mbox

Patch

diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h
index 6cd541d69c2e..888cc038899b 100644
--- a/include/drm/drm_mode_config.h
+++ b/include/drm/drm_mode_config.h
@@ -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);
 };