Linux-SPI Archive on lore.kernel.org
 help / color / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: broonie@kernel.org
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-spi@vger.kernel.org,
	Lee Jones <lee.jones@linaro.org>,
	Martin Sperl <kernel@martin.sperl.org>
Subject: [PATCH v2 01/14] spi: spi-loopback-test: Fix formatting issues in function header blocks
Date: Fri, 17 Jul 2020 14:54:11 +0100
Message-ID: <20200717135424.2442271-2-lee.jones@linaro.org> (raw)
In-Reply-To: <20200717135424.2442271-1-lee.jones@linaro.org>

Kerneldoc function parameter descriptions must be in '@.*: ' format.

Fixes the following W=1 kernel build warning(s):

 drivers/spi/spi-loopback-test.c:897: warning: Function parameter or member 'spi' not described in 'spi_test_execute_msg'
 drivers/spi/spi-loopback-test.c:897: warning: Function parameter or member 'test' not described in 'spi_test_execute_msg'
 drivers/spi/spi-loopback-test.c:897: warning: Function parameter or member 'tx' not described in 'spi_test_execute_msg'
 drivers/spi/spi-loopback-test.c:897: warning: Function parameter or member 'rx' not described in 'spi_test_execute_msg'
 drivers/spi/spi-loopback-test.c:970: warning: Function parameter or member 'spi' not described in 'spi_test_run_test'
 drivers/spi/spi-loopback-test.c:970: warning: Function parameter or member 'test' not described in 'spi_test_run_test'
 drivers/spi/spi-loopback-test.c:970: warning: Function parameter or member 'tx' not described in 'spi_test_run_test'
 drivers/spi/spi-loopback-test.c:970: warning: Function parameter or member 'rx' not described in 'spi_test_run_test'

Cc: Mark Brown <broonie@kernel.org>
Cc: Martin Sperl <kernel@martin.sperl.org>
Cc: linux-spi@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/spi/spi-loopback-test.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/drivers/spi/spi-loopback-test.c b/drivers/spi/spi-loopback-test.c
index b6d79cd156fb5..9522d1b5786d5 100644
--- a/drivers/spi/spi-loopback-test.c
+++ b/drivers/spi/spi-loopback-test.c
@@ -885,10 +885,10 @@ static int spi_test_run_iter(struct spi_device *spi,
 /**
  * spi_test_execute_msg - default implementation to run a test
  *
- * spi: @spi_device on which to run the @spi_message
- * test: the test to execute, which already contains @msg
- * tx:   the tx buffer allocated for the test sequence
- * rx:   the rx buffer allocated for the test sequence
+ * @spi: @spi_device on which to run the @spi_message
+ * @test: the test to execute, which already contains @msg
+ * @tx:   the tx buffer allocated for the test sequence
+ * @rx:   the rx buffer allocated for the test sequence
  *
  * Returns: error code of spi_sync as well as basic error checking
  */
@@ -957,10 +957,10 @@ EXPORT_SYMBOL_GPL(spi_test_execute_msg);
  *                     including all the relevant iterations on:
  *                     length and buffer alignment
  *
- * spi:  the spi_device to send the messages to
- * test: the test which we need to execute
- * tx:   the tx buffer allocated for the test sequence
- * rx:   the rx buffer allocated for the test sequence
+ * @spi:  the spi_device to send the messages to
+ * @test: the test which we need to execute
+ * @tx:   the tx buffer allocated for the test sequence
+ * @rx:   the rx buffer allocated for the test sequence
  *
  * Returns: status code of spi_sync or other failures
  */
-- 
2.25.1


  reply index

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-17 13:54 [PATCH v2 00/14] Rid W=1 warnings in SPI Lee Jones
2020-07-17 13:54 ` Lee Jones [this message]
2020-07-17 13:54 ` [PATCH v2 02/14] spi: spi-bitbang: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-17 13:54 ` [PATCH v2 03/14] spi: spi-davinci: Fix a few kerneldoc misspellings and API slippages Lee Jones
2020-07-17 13:54 ` [PATCH v2 04/14] spi: spi-ep93xx: Fix API slippage Lee Jones
2020-07-17 13:54 ` [PATCH v2 05/14] spi: spi-meson-spifc: Fix misdocumenting of 'dev' in 'struct meson_spifc' Lee Jones
2020-07-21  8:00   ` Neil Armstrong
2020-07-17 13:54 ` [PATCH v2 06/14] spi: spi-meson-spicc: Remove set but never used variable 'data' from meson_spicc_reset_fifo() Lee Jones
2020-07-21  8:01   ` Neil Armstrong
2020-07-17 13:54 ` [PATCH v2 07/14] spi: spi-s3c64xx: Add missing entries for structs 's3c64xx_spi_dma_data' and 's3c64xx_spi_dma_data' Lee Jones
2020-07-17 13:54 ` [PATCH v2 08/14] spi: spi-pl022: Provide missing struct attribute/function param docs Lee Jones
2020-07-17 13:54 ` [PATCH v2 09/14] spi: spi-zynq-qspi: Add description for 2 missing attributes/parameters Lee Jones
2020-07-17 13:54 ` [PATCH v2 10/14] spi: spi-zynqmp-gqspi: Correct a couple of misspellings in kerneldoc Lee Jones
2020-07-17 13:54 ` [PATCH v2 11/14] spi: spi-topcliff-pch: Add missing descriptions to 'struct pch_spi_data' Lee Jones
2020-07-17 13:54 ` [PATCH v2 12/14] spi: spi-at91-usart: Remove unused OF table 'struct of_device_id' Lee Jones
2020-07-17 14:02   ` Alexandre Belloni
2020-07-17 13:54 ` [PATCH v2 13/14] spi: spi-pxa2xx: Do not define 'struct acpi_device_id' when !CONFIG_ACPI Lee Jones
2020-07-17 13:54 ` [PATCH v2 14/14] spi: spi-amd: " Lee Jones
2020-07-20 11:12 ` [PATCH v2 00/14] Rid W=1 warnings in SPI 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=20200717135424.2442271-2-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=broonie@kernel.org \
    --cc=kernel@martin.sperl.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-spi@vger.kernel.org \
    /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

Linux-SPI Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-spi/0 linux-spi/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-spi linux-spi/ https://lore.kernel.org/linux-spi \
		linux-spi@vger.kernel.org
	public-inbox-index linux-spi

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-spi


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git