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 01/14] spi: spi-loopback-test: Fix formatting issues in function header blocks
Date: Wed, 15 Jul 2020 16:06:19 +0100 [thread overview]
Message-ID: <20200715150632.409077-2-lee.jones@linaro.org> (raw)
In-Reply-To: <20200715150632.409077-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
next prev parent reply other threads:[~2020-07-15 15:06 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-15 15:06 [PATCH 00/14] Rid W=1 warnings in SPI Lee Jones
2020-07-15 15:06 ` Lee Jones [this message]
2020-07-15 15:06 ` [PATCH 02/14] spi: spi-bitbang: Demote obvious misuse of kerneldoc to standard comment blocks Lee Jones
2020-07-15 15:06 ` [PATCH 03/14] spi: spi-davinci: Fix a few kerneldoc misspellings and API slippages Lee Jones
2020-07-15 15:06 ` [PATCH 04/14] spi: spi-ep93xx: Fix API slippage Lee Jones
2020-07-15 15:06 ` [PATCH 05/14] spi: spi-meson-spifc: Fix misdocumenting of 'dev' in 'struct meson_spifc' Lee Jones
2020-07-15 15:06 ` [PATCH 06/14] spi: spi-meson-spicc: Remove set but never used variable 'data' from meson_spicc_reset_fifo() Lee Jones
2020-07-15 15:06 ` [PATCH 07/14] spi: spi-s3c64xx: Add missing entries for structs 's3c64xx_spi_dma_data' and 's3c64xx_spi_dma_data' Lee Jones
2020-07-15 15:06 ` [PATCH 08/14] spi: spi-pl022: Provide missing struct attribute/function param docs Lee Jones
2020-07-16 13:59 ` Linus Walleij
2020-07-15 15:06 ` [PATCH 09/14] spi: spi-zynq-qspi: Add description for 2 missing attributes/parameters Lee Jones
2020-07-16 7:19 ` Michal Simek
2020-07-15 15:06 ` [PATCH 10/14] spi: spi-zynqmp-gqspi: Correct a couple of misspellings in kerneldoc Lee Jones
2020-07-16 7:20 ` Michal Simek
2020-07-15 15:06 ` [PATCH 11/14] spi: spi-topcliff-pch: Add missing descriptions to 'struct pch_spi_data' Lee Jones
2020-07-15 15:06 ` [PATCH 12/14] spi: spi-at91-usart: Make use of the defined 'struct of_device_id' Lee Jones
2020-07-15 21:24 ` Alexandre Belloni
2020-07-16 7:56 ` Lee Jones
2020-07-16 8:50 ` Alexandre Belloni
2020-07-15 15:06 ` [PATCH 13/14] spi: spi-pxa2xx: Do not define 'struct acpi_device_id' when Lee Jones
2020-07-15 15:06 ` [PATCH 14/14] spi: spi-amd: " Lee Jones
2020-07-20 11:12 ` [PATCH 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=20200715150632.409077-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
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).