| Summary: | the bsdgrep(1) man page should document -u | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | deeptech71 <deeptech71> | ||||
| Component: | Books & Articles | Assignee: | Isabell Long <issyl0> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | CC: | anders, dt71, emaste | ||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
Responsible Changed From-To: freebsd-bugs->freebsd-doc reclassify. State Changed From-To: open-> feedback Hi, The bsdgrep(1) man page already says: "Historic versions of the grep utility also supported the flags [-ruy]. This implementation supports those options; however, their use is strongly discouraged." which appears to address your concern. Are you happy for this to be closed? Thanks, Responsible Changed From-To: freebsd-doc->issyl0 I'll deal with this one. Some things: - Since when is -r (aka. --recursive) obsolete????? - The man page explicitly mentions the -r and the -y flags (in addition to mentioning them in the history paragraph), and describes what they do. Following this practice, -u should also be explicitly described. - The whole history paragraph should be removed after adding an explicit descripion for -u. If that is not going to be done, then: - I recommend replacing "-ruy" with "-r, -u, and -y", to allow man page readers to find the "-u" text. - I repeat: I find it surprizing that -r is obsolete, since I've been using that option ever since day 1. The bsdgrep man page doesn't mention the obsoleteness of -r directly. The gnugrep man page doesn't even say anything about the obsoleteness of -r. Created attachment 143920 [details]
Patch for grep(1) man page
Patched man page as proposed by the PR submitter. Happy to take your recommendations with respect to other changes.
OK for me. A commit references this bug: Author: emaste Date: Sun Feb 19 17:40:24 UTC 2017 New revision: 313955 URL: https://svnweb.freebsd.org/changeset/base/313955 Log: bsdgrep: document ignored option -u MSDOS and Windows GNU grep uses -u to mean "print byte offsets as if running on an UNIX system." The option has no effect on systems that do not use CRLF line endings. PR: 171200 Submitted by: deeptech71@gmail.com, Anders Jensen-Waud MFC after: 1 month Changes: head/usr.bin/grep/grep.1 A commit references this bug: Author: gjb Date: Mon May 22 15:51:17 UTC 2017 New revision: 318650 URL: https://svnweb.freebsd.org/changeset/base/318650 Log: MFC r313955 (emaste): bsdgrep: document ignored option -u MSDOS and Windows GNU grep uses -u to mean "print byte offsets as if running on an UNIX system." The option has no effect on systems that do not use CRLF line endings. PR: 171200 Sponsored by: The FreeBSD Foundation Changes: _U stable/10/ stable/10/usr.bin/grep/grep.1 _U stable/11/ stable/11/usr.bin/grep/grep.1 |
bsdgrep(1) silently ignores the -u flag. This is worth mentioning in the man page. Fix: Add, for example: -u This option has no effect, and is provided only for compatibility with GNU grep.