netdev - Re: [RFC PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields

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: <ZVSLx9JH7MQGTWGU@Laptop-X1>
Date: Wed, 15 Nov 2023 17:13:43 +0800
From: Hangbin Liu <liuhangbin@...il.com>
To: Nikolay Aleksandrov <razor@...ckwall.org>
Cc: netdev@...r.kernel.org, "David S . Miller" <davem@...emloft.net>,
	David Ahern <dsahern@...nel.org>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
	Ido Schimmel <idosch@...sch.org>, Roopa Prabhu <roopa@...dia.com>,
	Stephen Hemminger <stephen@...workplumber.org>,
	Florian Westphal <fw@...len.de>, Andrew Lunn <andrew@...n.ch>,
	Florian Fainelli <f.fainelli@...il.com>,
	Vladimir Oltean <olteanv@...il.com>, Jiri Pirko <jiri@...nulli.us>
Subject: Re: [RFC PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields

On Mon, Nov 13, 2023 at 11:49:28AM +0200, Nikolay Aleksandrov wrote:
> > +Bridge sysfs
> > +------------
> > +
> > +All the sysfs parameters are also exported via the bridge netlink API.
> 
> drop "the" here, all sysfs parameters
> 
> > +Here you can find the explanation based on the correspond netlink attributes.
> 
> "Here you can find sysfs parameter explanation based on the
> corresponding  netlink attributes."
> But where is "Here"? Not sure what you mean.
> 

How about change it to 

All sysfs attributes are also exported via the bridge netlink API.
You can find each attribute explanation based on the correspond netlink
attribute.

> > +
> > +NOTE: the sysfs interface is deprecated and should not be extended if new
> > +options are added.
> > +
> > +.. kernel-doc:: net/bridge/br_sysfs_br.c
> > +   :doc: The sysfs bridge attrs
> 
> You use "sysfs parameters", here it is "sysfs attrs". Be consistent and
> use one of them. Drop "the" here.

Thanks
Hangbin