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

arp.8: don't document a syntax that doesn't exist #1215

Merged
merged 1 commit into from
May 9, 2024

Conversation

llfw
Copy link
Contributor

@llfw llfw commented May 4, 2024

The arp.8 manpage documents 'arp -d pub', but the 'pub' flag is not accepted by the arp command. Remove this incorrect documentation.

@bsdimp
Copy link
Member

bsdimp commented May 4, 2024

"pub" is still in the sources:

                } else if (strcmp(argv[0], "pub") == 0) {
			opts.flags |= RTF_ANNOUNCE;
                        if (argc && strcmp(argv[1], "only") == 0) {
                                /*                                                                                                                                                                                                          
                                 * Compatibility: in pre FreeBSD 8 times                                                                                                                                                                    
                                 * the "only" keyword used to mean that                                                                                                                                                                     
                                 * an ARP entry should be announced, but                                                                                                                                                                    
                                 * not installed into routing table.                                                                                                                                                                        
                                 */
                                argc--; argv++;
                        }
                } else if (strcmp(argv[0], "blackhole") == 0) {

so why isn't it accepted?

3f844a2 added it, but I haven't seen anything that removed it, at least on purpose.

Ah, looks like 9711a16 removed it with the code that parsed the command line option. I wonder what @glebius was thinking. Tagged him for comment to see if this is a doc bug or a code bug... But it's been like this since 2013 :(.

@llfw
Copy link
Contributor Author

llfw commented May 4, 2024

right, it's still accepted for arp -s, but not for arp -d.

@bsdimp bsdimp self-assigned this May 4, 2024
@glebius
Copy link
Member

glebius commented May 5, 2024

This is a doc bug and submission is correct. Thanks!

P.S. I'm having a hard time looking for "Approve" button in GitHub Web UI.

@markpeek
Copy link
Member

markpeek commented May 5, 2024

@glebius Files Changed tab > Review Changes button > Approve

@llfw
Copy link
Contributor Author

llfw commented May 5, 2024

pushed a minor change to replace "This -d flag" with "The -d flag" which is more standard English.

The arp.8 manpage documents 'arp -d <addr> pub', but the 'pub' flag is
not accepted by the arp command.  Remove this incorrect documentation.

Reviewed by: imp, gleb, mp
Pull Request: freebsd#1215
@freebsd-git freebsd-git merged commit cd917a1 into freebsd:main May 9, 2024
7 of 9 checks passed
@bsdimp
Copy link
Member

bsdimp commented May 9, 2024

OK. The asymmetry is not a bug, so the doc change is good.

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