diff mbox series

docs: gpu: i915.rst: Update DRRS functions names

Message ID 20220325153436.95045-1-jose.souza@intel.com (mailing list archive)
State New, archived
Headers show
Series docs: gpu: i915.rst: Update DRRS functions names | expand

Commit Message

Souza, Jose March 25, 2022, 3:34 p.m. UTC
intel_drrs_enable and intel_drrs_disable where renamed to
intel_drrs_activate and intel_drrs_deactivate in commit
54903c7a6b40 ("drm/i915: s/enable/active/ for DRRS").

Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
Signed-off-by: José Roberto de Souza <jose.souza@intel.com>
---
 Documentation/gpu/i915.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Ville Syrjälä March 25, 2022, 6:10 p.m. UTC | #1
On Fri, Mar 25, 2022 at 08:34:36AM -0700, José Roberto de Souza wrote:
> intel_drrs_enable and intel_drrs_disable where renamed to
> intel_drrs_activate and intel_drrs_deactivate in commit
> 54903c7a6b40 ("drm/i915: s/enable/active/ for DRRS").
> 
> Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
> Signed-off-by: José Roberto de Souza <jose.souza@intel.com>
> ---
>  Documentation/gpu/i915.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> index bcaefc952764e..ab596b0a9f259 100644
> --- a/Documentation/gpu/i915.rst
> +++ b/Documentation/gpu/i915.rst

Oh that's whete it's coming from.

> @@ -187,10 +187,10 @@ Display Refresh Rate Switching (DRRS)
>     :doc: Display Refresh Rate Switching (DRRS)
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
> -   :functions: intel_drrs_enable
> +   :functions: intel_drrs_activate

Hmm. Can't we just nuke all these explicit references and let the
tooling pull in all of it automagically since there's nothing
else in that file?

>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
> -   :functions: intel_drrs_disable
> +   :functions: intel_drrs_deactivate
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>     :functions: intel_drrs_invalidate
> -- 
> 2.35.1
Rodrigo Vivi March 25, 2022, 6:22 p.m. UTC | #2
On Fri, Mar 25, 2022 at 08:10:59PM +0200, Ville Syrjälä wrote:
> On Fri, Mar 25, 2022 at 08:34:36AM -0700, José Roberto de Souza wrote:
> > intel_drrs_enable and intel_drrs_disable where renamed to
> > intel_drrs_activate and intel_drrs_deactivate in commit
> > 54903c7a6b40 ("drm/i915: s/enable/active/ for DRRS").
> >
> > Cc: Ville Syrjälä <ville.syrjala@linux.intel.com>
> > Signed-off-by: José Roberto de Souza <jose.souza@intel.com>
> > ---
> >  Documentation/gpu/i915.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
> > index bcaefc952764e..ab596b0a9f259 100644
> > --- a/Documentation/gpu/i915.rst
> > +++ b/Documentation/gpu/i915.rst
>
> Oh that's whete it's coming from.
>
> > @@ -187,10 +187,10 @@ Display Refresh Rate Switching (DRRS)
> >     :doc: Display Refresh Rate Switching (DRRS)
> >
> >  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
> > -   :functions: intel_drrs_enable
> > +   :functions: intel_drrs_activate
>
> Hmm. Can't we just nuke all these explicit references and let the
> tooling pull in all of it automagically since there's nothing
> else in that file?

Indeed.

.. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
   :doc: Display Refresh Rate Switching (DRRS)

.. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
   :internal:

looks the right thing to do here.

And if the other matters, than sort the functions in intel_drrs.c

>
> >
> >  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
> > -   :functions: intel_drrs_disable
> > +   :functions: intel_drrs_deactivate
> >
> >  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
> >     :functions: intel_drrs_invalidate
> > --
> > 2.35.1
>
> --
> Ville Syrjälä
> Intel
kernel test robot March 27, 2022, 4:04 a.m. UTC | #3
Hi "José,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on drm-intel/for-linux-next]
[also build test WARNING on v5.17 next-20220325]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/intel-lab-lkp/linux/commits/Jos-Roberto-de-Souza/docs-gpu-i915-rst-Update-DRRS-functions-names/20220325-233423
base:   git://anongit.freedesktop.org/drm-intel for-linux-next
reproduce: make htmldocs

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

>> drivers/gpu/drm/i915/display/intel_drrs.c:1: warning: 'intel_drrs_activate' not found
>> drivers/gpu/drm/i915/display/intel_drrs.c:1: warning: 'intel_drrs_deactivate' not found

vim +/intel_drrs_activate +1 drivers/gpu/drm/i915/display/intel_drrs.c

a1b63119ee839c8 José Roberto de Souza 2021-08-27 @1  // SPDX-License-Identifier: MIT
a1b63119ee839c8 José Roberto de Souza 2021-08-27  2  /*
a1b63119ee839c8 José Roberto de Souza 2021-08-27  3   * Copyright © 2021 Intel Corporation
a1b63119ee839c8 José Roberto de Souza 2021-08-27  4   */
a1b63119ee839c8 José Roberto de Souza 2021-08-27  5
diff mbox series

Patch

diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index bcaefc952764e..ab596b0a9f259 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -187,10 +187,10 @@  Display Refresh Rate Switching (DRRS)
    :doc: Display Refresh Rate Switching (DRRS)
 
 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
-   :functions: intel_drrs_enable
+   :functions: intel_drrs_activate
 
 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
-   :functions: intel_drrs_disable
+   :functions: intel_drrs_deactivate
 
 .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
    :functions: intel_drrs_invalidate