[19/21] ide: piix: Fix incorrectly documented param 'hwif'

Message ID	20210602101722.2276638-20-lee.jones@linaro.org
State	New
Headers	show Return-Path: <linux-ide-owner@vger.kernel.org> From: Lee Jones <lee.jones@linaro.org> To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, "David S. Miller" <davem@davemloft.net>, Andre Hedrick <andre@linux-ide.org>, "Software, Inc" <source@mvista.com>, linux-ide@vger.kernel.org Subject: [PATCH 19/21] ide: piix: Fix incorrectly documented param 'hwif' Date: Wed, 2 Jun 2021 11:17:20 +0100 Message-Id: <20210602101722.2276638-20-lee.jones@linaro.org> In-Reply-To: <20210602101722.2276638-1-lee.jones@linaro.org> References: <20210602101722.2276638-1-lee.jones@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	Rid W=1 warnings from IDE \| expand [00/21] Rid W=1 warnings from IDE [01/21] ide: alim15x3: Document alim15x3_init_one()'s 'id' param [02/21] ide: ide-dma: Document ide_dma_unmap_sg()'s missing 'cmd' param [03/21] ide: ide-dma-sff: Provide some missing 'param' descriptions [04/21] ide: ide-io: Fix a few kernel-doc misdemeanours [05/21] ide: ide-proc: Strip out unused fops structure and accompanying call-back [06/21] ide: cs5530: Fix incorrect documentation for function init_chipset_cs5530() [07/21] ide: ide-probe: Fix-up incorrectly documented function probe_for_drive() [08/21] ide: hpt366: Provide some missing descriptions for 'f_{low,high}' [09/21] ide: piix: Remove unused variable 'sitre' [10/21] ide: pdc202xx_new: Supply missing description for 'set_indexed_reg()'s 'value' param [11/21] ide: slc90e66: Remove unused variable 'sitre' [12/21] ide: it821x: Fix a couple of incorrectly documented functions [13/21] ide: siimage: Fix some incorrectly documented functions/params [14/21] ide: via82cxxx: Fix misdocumentation of via_set_speed()'s 'hwif' param [15/21] ide: ide-cd_ioctl: Remove unused variable 'stat' [16/21] ide: ide-cd: Demote kernel-doc abuse [17/21] ide: ide-acpi: Mark debugging variable 'bus' as __maybe_unused [18/21] ide: ide-io: Document ide_intr()'s param 'irq' [19/21] ide: piix: Fix incorrectly documented param 'hwif' [20/21] ide: ide-acpi: Provide missing description for param 'obj_loc' [21/21] ide: pmac: Staticise local function 'pmac_ide_probe'

Message ID

20210602101722.2276638-20-lee.jones@linaro.org

State

New

Headers

From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
        "David S. Miller" <davem@davemloft.net>,
        Andre Hedrick <andre@linux-ide.org>,
        "Software, Inc" <source@mvista.com>, linux-ide@vger.kernel.org
Subject: [PATCH 19/21] ide: piix: Fix incorrectly documented param 'hwif'
Date: Wed,  2 Jun 2021 11:17:20 +0100
Message-Id: <20210602101722.2276638-20-lee.jones@linaro.org>
In-Reply-To: <20210602101722.2276638-1-lee.jones@linaro.org>
References: <20210602101722.2276638-1-lee.jones@linaro.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Series

Rid W=1 warnings from IDE | expand

Commit Message

Lee Jones June 2, 2021, 10:17 a.m. UTC

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

 drivers/ide/piix.c:69: warning: Function parameter or member 'hwif' not described in 'piix_set_pio_mode'
 drivers/ide/piix.c:69: warning: Excess function parameter 'port' description in 'piix_set_pio_mode'

Cc: "David S. Miller" <davem@davemloft.net>
Cc: Andre Hedrick <andre@linux-ide.org>
Cc: "Software, Inc" <source@mvista.com>
Cc: linux-ide@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/ide/piix.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ide/piix.c b/drivers/ide/piix.c
index ede42d2a5b0b1..6a22c281ea90a 100644
--- a/drivers/ide/piix.c
+++ b/drivers/ide/piix.c
@@ -59,7 +59,7 @@  static int no_piix_dma;
 
 /**
  *	piix_set_pio_mode	-	set host controller for PIO mode
- *	@port: port
+ *	@hwif: IDE interface
  *	@drive: drive
  *
  *	Set the interface PIO mode based upon the settings done by AMI BIOS.

[19/21] ide: piix: Fix incorrectly documented param 'hwif'

Commit Message

Patch