wpa_cli.8: describe better + tag spdx + linter nit #1299
Conversation
concussious
force-pushed
the
wpa_cli.8
branch
3 times, most recently
from
69ee173 to
40f4765
Compare
usr.sbin/wpa/wpa_cli/wpa_cli.8
Outdated
| .Dt WPA_CLI 8 | ||
| .Os | ||
| .Sh NAME | ||
| .Nm wpa_cli | ||
| .Nd "text-based frontend program for interacting with wpa_supplicant" | ||
| .Nd console utility for wifi authentication with wpa_supplicant |
There was a problem hiding this comment.
"Wi-Fi" is the trademark. But people are likely searching for wifi, which is the whole reason to change it here.
So what do we do elsewhere?
There was a problem hiding this comment.
Are we abusing the trademark if we use it the way it's used in the real world?
I have a baseless suspicion no one has ever initially searched ms-dos or wi-fi.
Edit: I think the body of the doc should use the proper trademark for correctness, but the Document Description should not for visibility.
There was a problem hiding this comment.
"Wi-Fi" is the trademark. But people are likely searching for wifi, which is the whole reason to change it here.
So what do we do elsewhere?
The wifi(4) man page has the description: generic WiFi 802.11 link-layer support
"Wi-Fi" appears in the body of man pages such as networking(7).
apropos wi-fi yields no results. apropos wifi is case insensitive and will therefore include wpa_cli(8) regardless of how it is capitalized.
So, I suggest 'WiFi', but have no problem with 'wifi'.
There was a problem hiding this comment.
Yea, let's use 'WiFi' but 'wifi' also works.
As for trademark issues: there's none. We're not selling products that claim to be in conformance, so we're under no obligation to use it correctly everywhere w/o exception. So I like having it wifi in the doc descrip, but Wi-Fi elsewhere. Might not be a bad thing to do a sweep on for existing man pages and handbook entries.
There was a problem hiding this comment.
Copy, doc sweep on tonight's todo.
"how do I switch active wifi network on console" "% apropos wifi" MFC after: 3 days Reviewed by: mhorne, imp Pull Request: freebsd#1299
"how do I switch active wifi network on console" "% apropos wifi" MFC after: 3 days Reviewed by: mhorne, imp Pull Request: freebsd#1299
|
Merged to |
|
Thanks @mhorne! |
"how do I switch active wifi network on console" "% apropos wifi" MFC after: 3 days Reviewed by: mhorne, imp Pull Request: freebsd/freebsd-src#1299
"how do I switch active wifi network on console"
"% apropos wifi"
MFC after: 3 days