linux-kernel - Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YEt1GlakFcST27F0@lunn.ch>
Date:   Fri, 12 Mar 2021 15:05:14 +0100
From:   Andrew Lunn <andrew@...n.ch>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     linux-kernel@...r.kernel.org,
        Heiner Kallweit <hkallweit1@...il.com>,
        Russell King <linux@...linux.org.uk>,
        Rob Herring <robh+dt@...nel.org>,
        Frank Rowand <frowand.list@...il.com>, netdev@...r.kernel.org,
        devicetree@...r.kernel.org
Subject: Re: [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header

On Fri, Mar 12, 2021 at 11:07:56AM +0000, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/of/of_net.c:104: warning: Function parameter or member 'np' not described in 'of_get_mac_address'
>  drivers/of/of_net.c:104: warning: expecting prototype for mac(). Prototype was for of_get_mac_address() instead
> 
> Cc: Andrew Lunn <andrew@...n.ch>
> Cc: Heiner Kallweit <hkallweit1@...il.com>
> Cc: Russell King <linux@...linux.org.uk>
> Cc: Rob Herring <robh+dt@...nel.org>
> Cc: Frank Rowand <frowand.list@...il.com>
> Cc: netdev@...r.kernel.org
> Cc: devicetree@...r.kernel.org
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>  drivers/of/of_net.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/of/of_net.c b/drivers/of/of_net.c
> index 6e411821583e4..9b41a343e88ab 100644
> --- a/drivers/of/of_net.c
> +++ b/drivers/of/of_net.c
> @@ -78,7 +78,7 @@ static const void *of_get_mac_addr_nvmem(struct device_node *np)
>  	return mac;
>  }
>  
> -/**
> +/*
>   * Search the device tree for the best MAC address to use.  'mac-address' is
>   * checked first, because that is supposed to contain to "most recent" MAC
>   * address. If that isn't set, then 'local-mac-address' is checked next,

Hi Lee

of_get_mac_address() is a pretty important API function. So it would
be better to add the missing header to make this valid kdoc.

/**
 * of_get_mac_address - Get MAC address from device tree
 * @np: Pointer to the device_node of the interface
 *

 Andrew