netdev - Re: [PATCH net 03/15] docs: net: dsa: rename tag_protocol to get_tag

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: <YtQpMJA+kTIYIUFq@lunn.ch>
Date:   Sun, 17 Jul 2022 17:22:24 +0200
From:   Andrew Lunn <andrew@...n.ch>
To:     Vladimir Oltean <vladimir.oltean@....com>
Cc:     netdev@...r.kernel.org, "David S. Miller" <davem@...emloft.net>,
        Eric Dumazet <edumazet@...gle.com>,
        Jakub Kicinski <kuba@...nel.org>,
        Paolo Abeni <pabeni@...hat.com>,
        Vivien Didelot <vivien.didelot@...il.com>,
        Florian Fainelli <f.fainelli@...il.com>
Subject: Re: [PATCH net 03/15] docs: net: dsa: rename tag_protocol to
 get_tag_protocol

On Sat, Jul 16, 2022 at 09:53:32PM +0300, Vladimir Oltean wrote:
> Since the blamed commit, the enum was turned into a function pointer and
> also renamed. Update the documentation.
> 
> Fixes: 7b314362a234 ("net: dsa: Allow the DSA driver to indicate the tag protocol")
> Signed-off-by: Vladimir Oltean <vladimir.oltean@....com>
> ---
>  Documentation/networking/dsa/dsa.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/networking/dsa/dsa.rst b/Documentation/networking/dsa/dsa.rst
> index c04cb4c95b64..f49996e97363 100644
> --- a/Documentation/networking/dsa/dsa.rst
> +++ b/Documentation/networking/dsa/dsa.rst
> @@ -593,8 +593,8 @@ driver may free the data structures associated with the ``dsa_switch``.
>  Switch configuration
>  --------------------
>  
> -- ``tag_protocol``: this is to indicate what kind of tagging protocol is supported,
> -  should be a valid value from the ``dsa_tag_protocol`` enum
> +- ``get_tag_protocol``: this is to indicate what kind of tagging protocol is
> +  supported, should be a valid value from the ``dsa_tag_protocol`` enum

Maybe 'supported' is the wrong word here. It actually returns what is
currently being used. For devices which support multiple tag
protocols, you won't get a list back of supported protocols...

	   Andrew