[PATCH] MIPS: SGI-IP27: hubio: fix nasid kernel-doc warning

[PATCH] MIPS: SGI-IP27: hubio: fix nasid kernel-doc warning

[Randy Dunlap]

ip27-hubio.c:32: warning: Function parameter or member 'nasid' not described in 'hub_pio_map'
ip27-hubio.c:32: warning: Excess function parameter 'hub' description in 'hub_pio_map'

Fixes: 4bf841ebf17a ("MIPS: SGI-IP27: get rid of compact node ids")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Closes: lore.kernel.org/r/202311101336.BUL1JuvU-lkp@intel.com
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: Paul Burton <paulburton@kernel.org>
Cc: Ralf Baechle <ralf@linux-mips.org>
Cc: Jiri Slaby <jslaby@suse.cz>
Cc: linux-mips@vger.kernel.org
---
 arch/mips/sgi-ip27/ip27-hubio.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/arch/mips/sgi-ip27/ip27-hubio.c b/arch/mips/sgi-ip27/ip27-hubio.c
--- a/arch/mips/sgi-ip27/ip27-hubio.c
+++ b/arch/mips/sgi-ip27/ip27-hubio.c
@@ -21,7 +21,7 @@ static int force_fire_and_forget = 1;
 /**
  * hub_pio_map	-  establish a HUB PIO mapping
  *
- * @hub:	hub to perform PIO mapping on
+ * @nasid:	nasid to perform PIO mapping on
  * @widget:	widget ID to perform PIO mapping for
  * @xtalk_addr: xtalk_address that needs to be mapped
  * @size:	size of the PIO mapping

Re: [PATCH] MIPS: SGI-IP27: hubio: fix nasid kernel-doc warning

[Thomas Bogendoerfer]

On Fri, Nov 10, 2023 at 07:02:13PM -0800, Randy Dunlap wrote:
> ip27-hubio.c:32: warning: Function parameter or member 'nasid' not described in 'hub_pio_map'
> ip27-hubio.c:32: warning: Excess function parameter 'hub' description in 'hub_pio_map'
> 
> Fixes: 4bf841ebf17a ("MIPS: SGI-IP27: get rid of compact node ids")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: lore.kernel.org/r/202311101336.BUL1JuvU-lkp@intel.com
> Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
> Cc: Paul Burton <paulburton@kernel.org>
> Cc: Ralf Baechle <ralf@linux-mips.org>
> Cc: Jiri Slaby <jslaby@suse.cz>
> Cc: linux-mips@vger.kernel.org
> ---
>  arch/mips/sgi-ip27/ip27-hubio.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/arch/mips/sgi-ip27/ip27-hubio.c b/arch/mips/sgi-ip27/ip27-hubio.c
> --- a/arch/mips/sgi-ip27/ip27-hubio.c
> +++ b/arch/mips/sgi-ip27/ip27-hubio.c
> @@ -21,7 +21,7 @@ static int force_fire_and_forget = 1;
>  /**
>   * hub_pio_map	-  establish a HUB PIO mapping
>   *
> - * @hub:	hub to perform PIO mapping on
> + * @nasid:	nasid to perform PIO mapping on
>   * @widget:	widget ID to perform PIO mapping for
>   * @xtalk_addr: xtalk_address that needs to be mapped
>   * @size:	size of the PIO mapping

applied to mips-next.

Thomas.

-- 
Crap can work. Given enough thrust pigs will fly, but it's not necessarily a
good idea.                                                [ RFC1925, 2.3 ]