diff mbox

Doc: spi: make xmldocs warning caused by spi.c

Message ID 1456140824-15744-1-git-send-email-standby24x7@gmail.com (mailing list archive)
State Accepted
Commit 3700ce951c405f748a4767cabe6ac65727cbf767
Headers show

Commit Message

Masanari Iida Feb. 22, 2016, 11:33 a.m. UTC
This patch fix following warnings while make xmldocs.

.//drivers/spi/spi.c:2354: warning: Excess function parameter
'message' description in 'spi_split_transfers_maxsize'
.//drivers/spi/spi.c:2354: warning: Excess function parameter
 'max_size' description in 'spi_split_transfers_maxsize'

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
---
 drivers/spi/spi.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Mark Brown Feb. 22, 2016, 2:03 p.m. UTC | #1
On Mon, Feb 22, 2016 at 08:33:44PM +0900, Masanari Iida wrote:
> This patch fix following warnings while make xmldocs.
> 
> .//drivers/spi/spi.c:2354: warning: Excess function parameter
> 'message' description in 'spi_split_transfers_maxsize'
> .//drivers/spi/spi.c:2354: warning: Excess function parameter
>  'max_size' description in 'spi_split_transfers_maxsize'

Please use subject lines matching the style for the subsystem.  This
makes it easier for people to identify relevant patches.
diff mbox

Patch

diff --git a/drivers/spi/spi.c b/drivers/spi/spi.c
index 3e45fca..fe01963 100644
--- a/drivers/spi/spi.c
+++ b/drivers/spi/spi.c
@@ -2342,8 +2342,8 @@  static int __spi_split_transfer_maxsize(struct spi_master *master,
  *                              when an individual transfer exceeds a
  *                              certain size
  * @master:    the @spi_master for this transfer
- * @message:   the @spi_message to transform
- * @max_size:  the maximum when to apply this
+ * @msg:   the @spi_message to transform
+ * @maxsize:  the maximum when to apply this
  *
  * Return: status of transformation
  */