[PATCH] iio: frequency:: Remove unused parameter from data documentation

[PATCH] iio: frequency:: Remove unused parameter from data documentation

[Gabriel Shahrouzi]

The AD9832 driver uses the Common Clock Framework (CCF) to obtain the
master clock (MCLK) frequency rather than relying on a frequency value
passed from platform data.

Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
---
 drivers/staging/iio/frequency/ad9832.h | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/staging/iio/frequency/ad9832.h b/drivers/staging/iio/frequency/ad9832.h
index 98dfbd9289ab8..d0d840edb8d27 100644
--- a/drivers/staging/iio/frequency/ad9832.h
+++ b/drivers/staging/iio/frequency/ad9832.h
@@ -13,7 +13,6 @@
 
 /**
  * struct ad9832_platform_data - platform specific information
- * @mclk:		master clock in Hz
  * @freq0:		power up freq0 tuning word in Hz
  * @freq1:		power up freq1 tuning word in Hz
  * @phase0:		power up phase0 value [0..4095] correlates with 0..2PI
-- 
2.43.0

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[Charalampos Mitrodimas]

On Thu, 2025-04-17 at 10:32 -0400, Gabriel Shahrouzi wrote:
> The AD9832 driver uses the Common Clock Framework (CCF) to obtain the
> master clock (MCLK) frequency rather than relying on a frequency
> value
> passed from platform data.
> 
> Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> ---
>  drivers/staging/iio/frequency/ad9832.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/staging/iio/frequency/ad9832.h
> b/drivers/staging/iio/frequency/ad9832.h
> index 98dfbd9289ab8..d0d840edb8d27 100644
> --- a/drivers/staging/iio/frequency/ad9832.h
> +++ b/drivers/staging/iio/frequency/ad9832.h
> @@ -13,7 +13,6 @@
>  
>  /**
>   * struct ad9832_platform_data - platform specific information
> - * @mclk:              master clock in Hz

Hi Gabriel,

This seems to be a leftover from
566564e80b0ed23ffa4c40f7ad4224bf3327053a ("staging: iio: ad9832: use
clock framework for clock reference")



>   * @freq0:             power up freq0 tuning word in Hz
>   * @freq1:             power up freq1 tuning word in Hz
>   * @phase0:            power up phase0 value [0..4095] correlates
> with 0..2PI

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[Charalampos Mitrodimas]

On Thu, 2025-04-17 at 15:53 +0000, Charalampos Mitrodimas wrote:
> On Thu, 2025-04-17 at 10:32 -0400, Gabriel Shahrouzi wrote:
> > The AD9832 driver uses the Common Clock Framework (CCF) to obtain
> > the
> > master clock (MCLK) frequency rather than relying on a frequency
> > value
> > passed from platform data.
> > 
> > Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> > ---
> >  drivers/staging/iio/frequency/ad9832.h | 1 -
> >  1 file changed, 1 deletion(-)
> > 
> > diff --git a/drivers/staging/iio/frequency/ad9832.h
> > b/drivers/staging/iio/frequency/ad9832.h
> > index 98dfbd9289ab8..d0d840edb8d27 100644
> > --- a/drivers/staging/iio/frequency/ad9832.h
> > +++ b/drivers/staging/iio/frequency/ad9832.h
> > @@ -13,7 +13,6 @@
> >  
> >  /**
> >   * struct ad9832_platform_data - platform specific information
> > - * @mclk:              master clock in Hz
> 
> Hi Gabriel,
> 
> This seems to be a leftover from
> 566564e80b0ed23ffa4c40f7ad4224bf3327053a ("staging: iio: ad9832: use
> clock framework for clock reference")

That said, a Fixes: tag might be helpful?

> 
> 
> 
> >   * @freq0:             power up freq0 tuning word in Hz
> >   * @freq1:             power up freq1 tuning word in Hz
> >   * @phase0:            power up phase0 value [0..4095] correlates
> > with 0..2PI
> 
> 

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[Jonathan Cameron]

On Thu, 17 Apr 2025 15:57:48 +0000
Charalampos Mitrodimas <charmitro@posteo.net> wrote:

> On Thu, 2025-04-17 at 15:53 +0000, Charalampos Mitrodimas wrote:
> > On Thu, 2025-04-17 at 10:32 -0400, Gabriel Shahrouzi wrote:  
> > > The AD9832 driver uses the Common Clock Framework (CCF) to obtain
> > > the
> > > master clock (MCLK) frequency rather than relying on a frequency
> > > value
> > > passed from platform data.
> > > 
> > > Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> > > ---
> > >  drivers/staging/iio/frequency/ad9832.h | 1 -
> > >  1 file changed, 1 deletion(-)
> > > 
> > > diff --git a/drivers/staging/iio/frequency/ad9832.h
> > > b/drivers/staging/iio/frequency/ad9832.h
> > > index 98dfbd9289ab8..d0d840edb8d27 100644
> > > --- a/drivers/staging/iio/frequency/ad9832.h
> > > +++ b/drivers/staging/iio/frequency/ad9832.h
> > > @@ -13,7 +13,6 @@
> > >  
> > >  /**
> > >   * struct ad9832_platform_data - platform specific information
> > > - * @mclk:              master clock in Hz  
> > 
> > Hi Gabriel,
> > 
> > This seems to be a leftover from
> > 566564e80b0ed23ffa4c40f7ad4224bf3327053a ("staging: iio: ad9832: use
> > clock framework for clock reference")  
> 
> That said, a Fixes: tag might be helpful?

Not for a documentation fix in a staging driver.  A reference
in the commit message is fine though.

Fixes tags tend to make people look at is as a possible thing to backport
and this is not something where that makes sense.

Jonathan

> 
> > 
> > 
> >   
> > >   * @freq0:             power up freq0 tuning word in Hz
> > >   * @freq1:             power up freq1 tuning word in Hz
> > >   * @phase0:            power up phase0 value [0..4095] correlates
> > > with 0..2PI  
> > 
> >   
> 
> 

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[Gabriel Shahrouzi]

On Thu, Apr 17, 2025 at 11:57 AM Charalampos Mitrodimas
<charmitro@posteo.net> wrote:
>
> On Thu, 2025-04-17 at 15:53 +0000, Charalampos Mitrodimas wrote:
> > On Thu, 2025-04-17 at 10:32 -0400, Gabriel Shahrouzi wrote:
> > > The AD9832 driver uses the Common Clock Framework (CCF) to obtain
> > > the
> > > master clock (MCLK) frequency rather than relying on a frequency
> > > value
> > > passed from platform data.
> > >
> > > Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> > > ---
> > >  drivers/staging/iio/frequency/ad9832.h | 1 -
> > >  1 file changed, 1 deletion(-)
> > >
> > > diff --git a/drivers/staging/iio/frequency/ad9832.h
> > > b/drivers/staging/iio/frequency/ad9832.h
> > > index 98dfbd9289ab8..d0d840edb8d27 100644
> > > --- a/drivers/staging/iio/frequency/ad9832.h
> > > +++ b/drivers/staging/iio/frequency/ad9832.h
> > > @@ -13,7 +13,6 @@
> > >
> > >  /**
> > >   * struct ad9832_platform_data - platform specific information
> > > - * @mclk:              master clock in Hz
> >
> > Hi Gabriel,
> >
> > This seems to be a leftover from
> > 566564e80b0ed23ffa4c40f7ad4224bf3327053a ("staging: iio: ad9832: use
> > clock framework for clock reference")
Ah ok. I will include this in the body as a reference. I guess for
small clean up patches like this, they would have been most likely to
be included in a larger patch that covered other changes but
forgotten. In this case, should they be referenced?
>
> That said, a Fixes: tag might be helpful?
>
> >
> >
> >
> > >   * @freq0:             power up freq0 tuning word in Hz
> > >   * @freq1:             power up freq1 tuning word in Hz
> > >   * @phase0:            power up phase0 value [0..4095] correlates
> > > with 0..2PI
> >
> >
>

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[Charalampos Mitrodimas]

On Thu, 2025-04-17 at 13:17 -0400, Gabriel Shahrouzi wrote:
> On Thu, Apr 17, 2025 at 11:57 AM Charalampos Mitrodimas
> <charmitro@posteo.net> wrote:
> > 
> > On Thu, 2025-04-17 at 15:53 +0000, Charalampos Mitrodimas wrote:
> > > On Thu, 2025-04-17 at 10:32 -0400, Gabriel Shahrouzi wrote:
> > > > The AD9832 driver uses the Common Clock Framework (CCF) to
> > > > obtain
> > > > the
> > > > master clock (MCLK) frequency rather than relying on a
> > > > frequency
> > > > value
> > > > passed from platform data.
> > > > 
> > > > Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> > > > ---
> > > >  drivers/staging/iio/frequency/ad9832.h | 1 -
> > > >  1 file changed, 1 deletion(-)
> > > > 
> > > > diff --git a/drivers/staging/iio/frequency/ad9832.h
> > > > b/drivers/staging/iio/frequency/ad9832.h
> > > > index 98dfbd9289ab8..d0d840edb8d27 100644
> > > > --- a/drivers/staging/iio/frequency/ad9832.h
> > > > +++ b/drivers/staging/iio/frequency/ad9832.h
> > > > @@ -13,7 +13,6 @@
> > > > 
> > > >  /**
> > > >   * struct ad9832_platform_data - platform specific information
> > > > - * @mclk:              master clock in Hz
> > > 
> > > Hi Gabriel,
> > > 
> > > This seems to be a leftover from
> > > 566564e80b0ed23ffa4c40f7ad4224bf3327053a ("staging: iio: ad9832:
> > > use
> > > clock framework for clock reference")
> Ah ok. I will include this in the body as a reference. I guess for
> small clean up patches like this, they would have been most likely to
> be included in a larger patch that covered other changes but
> forgotten. In this case, should they be referenced?

Yes, you can just have a reference to it on your v2 (if a v2 is
needed).

> > 
> > That said, a Fixes: tag might be helpful?
> > 
> > > 
> > > 
> > > 
> > > >   * @freq0:             power up freq0 tuning word in Hz
> > > >   * @freq1:             power up freq1 tuning word in Hz
> > > >   * @phase0:            power up phase0 value [0..4095]
> > > > correlates
> > > > with 0..2PI
> > > 
> > > 
> > 

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[David Lechner]

On 4/17/25 9:32 AM, Gabriel Shahrouzi wrote:
> The AD9832 driver uses the Common Clock Framework (CCF) to obtain the
> master clock (MCLK) frequency rather than relying on a frequency value
> passed from platform data.
> 
> Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> ---
>  drivers/staging/iio/frequency/ad9832.h | 1 -
>  1 file changed, 1 deletion(-)
> 
Please include the driver name in your patch subjects. Otherwise readers will
assume that this is something that affects all IIO frequency drivers. I noticed
you are doing this on all of the patches you are sending, not just this one.


[PATCH] iio: frequency: ad9832: Remove unused parameter from data documentation

Re: [PATCH] iio: frequency:: Remove unused parameter from data documentation

[Gabriel Shahrouzi]

On Thu, Apr 17, 2025 at 12:17 PM David Lechner <dlechner@baylibre.com> wrote:
>
> On 4/17/25 9:32 AM, Gabriel Shahrouzi wrote:
> > The AD9832 driver uses the Common Clock Framework (CCF) to obtain the
> > master clock (MCLK) frequency rather than relying on a frequency value
> > passed from platform data.
> >
> > Signed-off-by: Gabriel Shahrouzi <gshahrouzi@gmail.com>
> > ---
> >  drivers/staging/iio/frequency/ad9832.h | 1 -
> >  1 file changed, 1 deletion(-)
> >
> Please include the driver name in your patch subjects. Otherwise readers will
> assume that this is something that affects all IIO frequency drivers. I noticed
> you are doing this on all of the patches you are sending, not just this one.
Whoops. I thought that would be redundant because the information is
in the git commit body. However, I realized it would be useful for
people quickly glancing over emails to categorize them or get an
initial idea of it solely based on the git commit title. Therefore, it
makes the most sense to be specify the driver to indicate specifically
what the change is being made towards. I'll use this convention for
future patches.

>
>
> [PATCH] iio: frequency: ad9832: Remove unused parameter from data documentation