Bug 990906
Summary: | invalid NAME section in nmcli(1) man page | ||
---|---|---|---|
Product: | [Fedora] Fedora | Reporter: | Michal Hlavinka <mhlavink> |
Component: | NetworkManager | Assignee: | Jirka Klimes <jklimes> |
Status: | CLOSED CURRENTRELEASE | QA Contact: | Fedora Extras Quality Assurance <extras-qa> |
Severity: | low | Docs Contact: | |
Priority: | unspecified | ||
Version: | rawhide | CC: | cjwatson, dcbw, jklimes, pschiffe, rkhan |
Target Milestone: | --- | Keywords: | EasyFix |
Target Release: | --- | ||
Hardware: | All | ||
OS: | Linux | ||
Whiteboard: | |||
Fixed In Version: | Doc Type: | Bug Fix | |
Doc Text: | Story Points: | --- | |
Clone Of: | Environment: | ||
Last Closed: | 2014-02-11 13:53:23 UTC | Type: | Bug |
Regression: | --- | Mount Type: | --- |
Documentation: | --- | CRM: | |
Verified Versions: | Category: | --- | |
oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
Cloudforms Team: | --- | Target Upstream Version: | |
Embargoed: |
Description
Michal Hlavinka
2013-08-01 07:47:37 UTC
Don't do that. The "-" is a syntactic separator, not a typographical one. (In reply to Colin Watson from comment #1) > The "-" is a syntactic separator, not a typographical one. just curious, do you have some url for that? > Don't do that. I don't do that. I just had a (different) problem with lexgrog and checked what other packages have problem with whatis. find /usr/share/man/ -type f | while read f do m=${f%%.*}; m=${m##*/} ; if whatis $m 2>/dev/null | grep -q '(unknown subject)' #whatis does not work then #check if there is a chance that NAME section contains useful information zgrep -A1 -E '^.SH[ "]+NAME' $f | grep -v NAME | grep -q -E '[^, ] [^ ].{5,}' && echo "broken: $f" fi done and different dash was one of the culprits lexgrog(1), which indeed notes that the correct form is "\-" not just "-". Also I'm the upstream maintainer. You should file bugs about incorrect separators against the packages that use the incorrect separators. Please fix nmcli(1) (and nm-connection-editor(1) from network-manager-applet package) man pages to have correct NAME section (according to lexgrog(1)): .SH NAME foo \- program to do something Thanks, peter The '\(en' was changed back to '\-' in upstream master branch, but we forgot to do that in branches for 0.9.8 too. (bug 948450). Fixed now: a6def6b8a84c1f4e3dbe700e8b10c82aa9a07816 (nm-0-9-8) fcf1298c8ab21088b1df7b62a945058a76972331 (nma-0-9-8) It will propagate to Fedora in the next release. |