All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Jens Axboe <axboe@kernel.dk>,
	linux-ide@vger.kernel.org
Subject: [PATCH 02/20] ata: libata-transport: Fix some potential doc-rot issues
Date: Thu, 28 Jan 2021 18:02:21 +0000	[thread overview]
Message-ID: <20210128180239.548512-3-lee.jones@linaro.org> (raw)
In-Reply-To: <20210128180239.548512-1-lee.jones@linaro.org>

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

 drivers/ata/libata-transport.c:258: warning: Function parameter or member 'ap' not described in 'ata_tport_delete'
 drivers/ata/libata-transport.c:258: warning: Excess function parameter 'port' description in 'ata_tport_delete'
 drivers/ata/libata-transport.c:384: warning: Function parameter or member 'link' not described in 'ata_tlink_delete'
 drivers/ata/libata-transport.c:384: warning: Excess function parameter 'port' description in 'ata_tlink_delete'
 drivers/ata/libata-transport.c:640: warning: Function parameter or member 'ata_dev' not described in 'ata_tdev_delete'
 drivers/ata/libata-transport.c:640: warning: Excess function parameter 'port' description in 'ata_tdev_delete'

Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-ide@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/ata/libata-transport.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/ata/libata-transport.c b/drivers/ata/libata-transport.c
index 6a40e3c6cf492..34bb4608bdc67 100644
--- a/drivers/ata/libata-transport.c
+++ b/drivers/ata/libata-transport.c
@@ -250,7 +250,7 @@ static int ata_tport_match(struct attribute_container *cont,
 
 /**
  * ata_tport_delete  --  remove ATA PORT
- * @port:	ATA PORT to remove
+ * @ap:	ATA PORT to remove
  *
  * Removes the specified ATA PORT.  Remove the associated link as well.
  */
@@ -376,7 +376,7 @@ static int ata_tlink_match(struct attribute_container *cont,
 
 /**
  * ata_tlink_delete  --  remove ATA LINK
- * @port:	ATA LINK to remove
+ * @link:	ATA LINK to remove
  *
  * Removes the specified ATA LINK.  remove associated ATA device(s) as well.
  */
@@ -632,7 +632,7 @@ static void ata_tdev_free(struct ata_device *dev)
 
 /**
  * ata_tdev_delete  --  remove ATA device
- * @port:	ATA PORT to remove
+ * @ata_dev:	ATA device to remove
  *
  * Removes the specified ATA device.
  */
-- 
2.25.1


  parent reply	other threads:[~2021-01-28 18:05 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-28 18:02 [PATCH 00/20] [Set 1] Rid W=1 warnings from ATA Lee Jones
2021-01-28 18:02 ` [PATCH 01/20] ata: ahci_dm816: Ignore -Woverride-init Lee Jones
2021-01-28 18:19   ` Christoph Hellwig
2021-01-28 18:27     ` Lee Jones
2021-02-01 11:05       ` Arnd Bergmann
2021-02-01 13:56         ` Lee Jones
2021-01-28 18:02 ` Lee Jones [this message]
2021-01-28 18:02 ` [PATCH 03/20] ata: ahci_platform: " Lee Jones
2021-01-28 18:02 ` [PATCH 04/20] ata: libata-sata: Fix function names in header comments Lee Jones
2021-01-28 18:02 ` [PATCH 05/20] ata: libata-pmp: Fix misspelling of 'val' Lee Jones
2021-01-28 18:02 ` [PATCH 06/20] ata: ahci_mtk: Ignore -Woverride-init Lee Jones
2021-01-28 18:02 ` [PATCH 07/20] ata: pata_ali: Repair some misnamed kernel-doc issues Lee Jones
2021-01-28 18:02 ` [PATCH 08/20] ata: pata_artop: Fix a function name and parameter description Lee Jones
2021-01-28 18:02 ` [PATCH 09/20] ata: acard-ahci: Ignore -Woverride-init Lee Jones
2021-01-28 18:02 ` [PATCH 10/20] ata: ahci_ceva: " Lee Jones
2021-01-28 18:02 ` [PATCH 11/20] ata: pata_amd: Remove superfluous, add missing and fix broken params Lee Jones
2021-01-28 18:02 ` [PATCH 12/20] ata: pata_hpt366: Provide missing description for 'hpt366_filter()'s 'mask' param Lee Jones
2021-01-28 18:02 ` [PATCH 13/20] ata: pata_hpt37x: Fix some function misnaming and missing param issues Lee Jones
2021-01-28 18:02 ` [PATCH 14/20] ata: sata_sil24: Ignore -Woverride-init Lee Jones
2021-01-28 18:02 ` [PATCH 15/20] ata: sata_highbank: " Lee Jones
2021-01-28 18:02 ` [PATCH 16/20] ata: ahci_brcm: " Lee Jones
2021-01-28 18:02 ` [PATCH 17/20] ata: ahci_xgene: Fix incorrect naming of 'xgene_ahci_handle_broken_edge_irq()'s 'host' param Lee Jones
2021-01-28 18:02 ` [PATCH 18/20] ata: sata_mv: Fix worthy headers and demote others Lee Jones
2021-01-28 18:02 ` [PATCH 19/20] ata: pata_ali: Supply description for 'ali_20_filter()'s 'mask' param Lee Jones
2021-01-28 18:02 ` [PATCH 20/20] ata: ahci: Ignore -Woverride-init Lee Jones
2021-01-29  5:53 ` [PATCH 00/20] [Set 1] Rid W=1 warnings from ATA Christoph Hellwig

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=20210128180239.548512-3-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=axboe@kernel.dk \
    --cc=linux-ide@vger.kernel.org \
    --cc=linux-kernel@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.