netlink icon indicating copy to clipboard operation
netlink copied to clipboard

NeighDel documentation appears to be incorrect

Open pitust opened this issue 1 year ago • 2 comments

The documentation for NeighDel (which wraps RTM_NEIGHDEL) appears to be incorrect:

// NeighDel will delete an IP address from a link device.
// Equivalent to: `ip addr del $addr dev $link`
func NeighDel(neigh *Neigh) error

This does not match the manual page which reads:

Add, remove, or receive information about a neighbor entry (e.g., an ARP entry). The message contains an ndmsg structure.

All the other Neigh* methods do talk about bridges and the FDB which is about what I would expect.

pitust avatar Feb 24 '24 19:02 pitust

I guess a correct documentation would be something like:

// NeighDel will delete an entry from the NDB
// Equivalent to: `bridge fdb del $addr dev $dev`

pitust avatar Feb 24 '24 20:02 pitust

please provide a PR which will be handling this change

jellonek avatar Feb 24 '24 22:02 jellonek