linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sylwester Nawrocki <snawrocki@kernel.org>
To: Lee Jones <lee.jones@linaro.org>,
	broonie@kernel.org, lgirdwood@gmail.com, perex@perex.cz,
	tiwai@suse.com
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, alsa-devel@alsa-project.org,
	Krzysztof Kozlowski <krzk@kernel.org>,
	Sangbeom Kim <sbkim73@samsung.com>,
	Sylwester Nawrocki <s.nawrocki@samsung.com>,
	Jaswinder Singh <jassisinghbrar@gmail.com>
Subject: Re: [PATCH v2 14/28] ASoC: samsung: pcm: Demote half-documented kerneldoc header
Date: Wed, 8 Jul 2020 10:39:30 +0200	[thread overview]
Message-ID: <f85a033f-b435-2611-5be5-1c83edf8cd42@kernel.org> (raw)
In-Reply-To: <20200707143742.2959960-15-lee.jones@linaro.org>

On 7/7/20 16:37, Lee Jones wrote:
> Ideally the author or someone 'in the know' should come back and
> provide the remainder of the documentation.  Until the kerneldoc
> checkers have been satisfied, let's just demote the header to a
> standard comment block.

Thanks for the patch Lee, Pierre-Luis Bossart has already corrected the 
documentation by adding missing entries in patch:

[PATCH v3 03/13] ASoC: samsung: pcm: fix kernel-doc

> Fixes the following W=1 kernel build warning(s):
> 
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'lock' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'sclk_per_fs' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'idleclk' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'pclk' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'cclk' not described in 's3c_pcm_info'

--
Regards,
Sylwester

  reply	other threads:[~2020-07-08  8:39 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-07 14:37 [PATCH v2 00/28] Clean-up ASoC's W=1 build warnings Lee Jones
2020-07-07 14:37 ` [PATCH v2 01/28] ASoC: atmel: atmel-pcm-dma: Demote function header which is clearly not kerneldoc Lee Jones
2020-07-07 14:37 ` [PATCH v2 02/28] ASoC: atmel: atmel_ssc_dai: " Lee Jones
2020-07-07 14:37 ` [PATCH v2 03/28] ASoC: fsl: fsl-asoc-card: Use correct format when providing struct documentation Lee Jones
2020-07-07 14:37 ` [PATCH v2 04/28] ASoC: fsl: fsl_asrc: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-07 14:37 ` [PATCH v2 05/28] ASoC: fsl: fsl_ssi: " Lee Jones
2020-07-07 14:37 ` [PATCH v2 06/28] ASoC: fsl: fsl_ssi_dbg: " Lee Jones
2020-07-07 14:37 ` [PATCH v2 07/28] ASoC: fsl: fsl_spdif: Use correct formatting when denoting struct documentation Lee Jones
2020-07-07 14:37 ` [PATCH v2 08/28] ASoC: fsl: fsl_spdif: Update 'struct fsl_spdif_priv's descriptions Lee Jones
2020-07-07 14:37 ` [PATCH v2 09/28] ASoC: fsl: fsl_esai: Fix a bunch of kerneldoc issues Lee Jones
2020-07-07 14:37 ` [PATCH v2 10/28] ASoC: fsl: fsl_esai: Add descriptions for 'tx_mask' and 'rx_mask' to 'fsl_esai' Lee Jones
2020-07-07 14:37 ` [PATCH v2 11/28] ASoC: pxa: pxa-ssp: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 12/28] ASoC: codecs: ak4458: Remove set but never checked variable 'ret' Lee Jones
2020-07-07 14:37 ` [PATCH v2 13/28] ASoC: qcom: qdsp6: q6asm: Provide documentation for WMA 'codec_profile' Lee Jones
2020-07-07 14:37 ` [PATCH v2 14/28] ASoC: samsung: pcm: Demote half-documented kerneldoc header Lee Jones
2020-07-08  8:39   ` Sylwester Nawrocki [this message]
2020-07-07 14:37 ` [PATCH v2 15/28] ASoC: samsung: spdif: Fix 3 misspelled struct properties Lee Jones
2020-07-07 14:37 ` [PATCH v2 16/28] ASoC: sunxi: sun4i-i2s: Demote half-documented kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 17/28] ASoC: uniphier: aio-core: Fix incorrectly named struct property and remove another Lee Jones
2020-07-07 14:37 ` [PATCH v2 18/28] ASoC: sunxi: sun4i-spdif: Fix misspelling of 'reg_dac_txdata' Lee Jones
2020-07-07 14:37 ` [PATCH v2 19/28] ASoC: ux500: ux500_msp_i2s: Remove unused variables 'reg_val_DR' and 'reg_val_TSTDR' Lee Jones
2020-07-07 14:37 ` [PATCH v2 20/28] ASoC: sti: uniperif: Mark 'uni_tdm_hw' as __maybe_unused Lee Jones
2020-07-08 13:34   ` Arnaud POULIQUEN
2020-07-07 14:37 ` [PATCH v2 21/28] ASoC: ti: omap-mcbsp-st: Remove set, but unused variable 'w' Lee Jones
2020-07-07 14:37 ` [PATCH v2 22/28] ASoC: codecs: da7210: Fix formatting issues in da7210_set_dai_pll() header Lee Jones
2020-07-07 14:37 ` [PATCH v2 23/28] ASoC: soc-ac97: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 24/28] ASoC: codecs: jz4770: Remove defined but never used variable 'mic_boost_tlv' Lee Jones
2020-07-07 14:37 ` [PATCH v2 25/28] ASoC: codecs: rt5631: Demote misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-07 14:37 ` [PATCH v2 26/28] ASoC: codecs: rt5659: Remove many unused const variables Lee Jones
2020-07-07 14:37 ` [PATCH v2 27/28] ASoC: codecs: tlv320aic26: Demote seemingly unintentional kerneldoc header Lee Jones
2020-07-07 14:37 ` [PATCH v2 28/28] ASoC: codecs: wm8400: Remove a bunch of unused variables Lee Jones
2020-07-07 14:38 ` [PATCH v2 00/28] Clean-up ASoC's W=1 build warnings Mark Brown

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=f85a033f-b435-2611-5be5-1c83edf8cd42@kernel.org \
    --to=snawrocki@kernel.org \
    --cc=alsa-devel@alsa-project.org \
    --cc=broonie@kernel.org \
    --cc=jassisinghbrar@gmail.com \
    --cc=krzk@kernel.org \
    --cc=lee.jones@linaro.org \
    --cc=lgirdwood@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=perex@perex.cz \
    --cc=s.nawrocki@samsung.com \
    --cc=sbkim73@samsung.com \
    --cc=tiwai@suse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).