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

[Jonathan Cameron]

On Thu, 17 Apr 2025 15:57:48 +0000
Charalampos Mitrodimas <charmitro@xxxxxxxxxx> 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@xxxxxxxxx>
> > > ---
> > >  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  
> > 
> >   
> 
>