Re: [PATCH net-next v2 5/6] bonding: update Documentation for port/bond terminology

On Fri, Oct 2, 2020 at 6:55 PM David Miller [off-list ref] wrote:

From: Jarod Wilson <redacted>
Date: Fri, 2 Oct 2020 16:12:49 -0400

quoted

The documentation was updated to point to the new names, but the old
ones still exist across the board, there should be no userspace
breakage here. (My lnst bonding tests actually fall flat currently
if the old names are gone).

The documentation is the reference point for people reading code in
userspace that manipulates bonding devices.

So people will come across the deprecated names in userland code and
therefore will try to learn what they do and what they mean.

Which means that the documentation must reference the old names.

You can mark them "(DEPRECATED)" or similar, but you must not remove
them.

Okay, so it sounds like just a blurb near the top of the file
referencing the changes that have been made in the code might be the
way to go here. Tagging every occurrence of master or slave in the doc
inline as deprecated would get ... noisy.

-- 
Jarod Wilson
jarod@redhat.com