Add EXAMLES covering -c, -s and -r
Details
Details
- Reviewers
bcr 0mp - Group Reviewers
manpages - Commits
- rS362365: md5(1): Add EXAMPLES section
- mandoc -Tlint clean
- igor clean
- aspell happy
- man ./md5.1 renders the page properly
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 31713 Build 29283: arc lint + arc unit
Event Timeline
Comment Actions
Modifying according to suggestions made by bcr@
- Start with the simplest example and grow from that
- s/compare to and/compare with/
sbin/md5/md5.1 | ||
---|---|---|
109 | Yep, seems pretty logical :-) |
Comment Actions
Almost there...
sbin/md5/md5.1 | ||
---|---|---|
105 | I'd combine this to one sentence with the next: |
Comment Actions
Merging two sentences suggested by bcr@
Using .Pa for paths after comment from yuripv@
sbin/md5/md5.1 | ||
---|---|---|
99 |
| |
105 | I think I'd replace "\n" with "a newline character". It's up to you though. | |
111 | checksum or checksums? I am not sure. | |
118 | s/digest/a digest/? Also, I'd probably drop "file". | |
122 | s/validate/validate it/ | |
132 | I'd wrap randomstring with Dq. Also, how about: Same as above but comparing the digest against an invalid string .Pq Dq randomstring , which results in a failure. or something along those lines. | |
135 | The digest file is not used so maybe it could be removed from this example? Also, the example should be on a single line, right? Or at least have a \ at the end of the first line. |
Comment Actions
Address comments made by 0mp:
- Use capitalization the name of the checksum algorithm.
- Replace "\n" with "the newline character".
- Use "the digest" instead of "digest". It is used in this form in the man page before.
- s/validate/validate it/
- Rephrasing where necessary
- Remove superfluous command with redirection since the example doesn't need it.