Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NeighDel documentation appears to be incorrect #952

Open
pitust opened this issue Feb 24, 2024 · 2 comments
Open

NeighDel documentation appears to be incorrect #952

pitust opened this issue Feb 24, 2024 · 2 comments

Comments

@pitust
Copy link

pitust commented Feb 24, 2024

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
Copy link
Author

pitust commented Feb 24, 2024

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`

@jellonek
Copy link
Contributor

please provide a PR which will be handling this change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants