diff mbox series

ASoC: codecs: nau8825: fix kernel-doc

Message ID 20210301165349.114952-2-pierre-louis.bossart@linux.intel.com (mailing list archive)
State Superseded
Headers show
Series ASoC: codecs: nau8825: fix kernel-doc | expand

Commit Message

Pierre-Louis Bossart March 1, 2021, 4:53 p.m. UTC
v5.12-rc1 flags new warnings with make W=1, fix missing or broken
function descriptors.

sound/soc/codecs/nau8825.c:298: warning: wrong kernel-doc identifier
on line:
 * Ramp up the headphone volume change gradually to target level.

sound/soc/codecs/nau8825.c:358: warning: expecting prototype for This
func(). Prototype was for nau8825_intlog10_dec3() instead

sound/soc/codecs/nau8825.c:411: warning: wrong kernel-doc identifier
on line:
 * computes cross talk suppression sidetone gain.

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
---
 sound/soc/codecs/nau8825.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Comments

Mark Brown March 1, 2021, 5:14 p.m. UTC | #1
On Mon, Mar 01, 2021 at 10:53:46AM -0600, Pierre-Louis Bossart wrote:
> v5.12-rc1 flags new warnings with make W=1, fix missing or broken
> function descriptors.

You've sent five patches (for multiple subsystems) in a thread but not
as a series - please don't do this, it confuses tools like b4 since they
can't figure out if this is a series or multiple revisions of a single
patch.  Please don't do this, if things are a series send them as such
or if it's a collection of unrelated patches send them separately.
Pierre-Louis Bossart March 1, 2021, 5:42 p.m. UTC | #2
On 3/1/21 11:14 AM, Mark Brown wrote:
> On Mon, Mar 01, 2021 at 10:53:46AM -0600, Pierre-Louis Bossart wrote:
>> v5.12-rc1 flags new warnings with make W=1, fix missing or broken
>> function descriptors.
> 
> You've sent five patches (for multiple subsystems) in a thread but not
> as a series - please don't do this, it confuses tools like b4 since they
> can't figure out if this is a series or multiple revisions of a single
> patch.  Please don't do this, if things are a series send them as such
> or if it's a collection of unrelated patches send them separately.

Humm yes, I thought git sendmail would be smart enough to detect it 
wasn't a series...oh well, will resend a v2.
diff mbox series

Patch

diff --git a/sound/soc/codecs/nau8825.c b/sound/soc/codecs/nau8825.c
index f0cba7b5758b..e19db30c457b 100644
--- a/sound/soc/codecs/nau8825.c
+++ b/sound/soc/codecs/nau8825.c
@@ -295,7 +295,7 @@  static inline void nau8825_sema_reset(struct nau8825 *nau8825)
 }
 
 /**
- * Ramp up the headphone volume change gradually to target level.
+ * nau8825_hpvol_ramp - Ramp up the headphone volume change gradually to target level.
  *
  * @nau8825:  component to register the codec private data with
  * @vol_from: the volume to start up
@@ -347,8 +347,9 @@  static void nau8825_hpvol_ramp(struct nau8825 *nau8825,
 }
 
 /**
- * Computes log10 of a value; the result is round off to 3 decimal. This func-
- * tion takes reference to dvb-math. The source code locates as the following.
+ * nau8825_intlog10_dec3 - Computes log10 of a value
+ * the result is round off to 3 decimal. This function takes reference to
+ * dvb-math. The source code locates as the following.
  * Linux/drivers/media/dvb-core/dvb_math.c
  * @value:  input for log10
  *
@@ -408,7 +409,7 @@  static u32 nau8825_intlog10_dec3(u32 value)
 }
 
 /**
- * computes cross talk suppression sidetone gain.
+ * nau8825_xtalk_sidetone - computes cross talk suppression sidetone gain.
  *
  * @sig_org: orignal signal level
  * @sig_cros: cross talk signal level