Details
- Reviewers
bcr brueffer - Group Reviewers
manpages - Commits
- rS327689: Document the DNS Casper service.
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
A few suggestions and corrections. Thanks for writing the man page!
| lib/libcasper/services/cap_dns/cap_dns.3 | ||
|---|---|---|
| 37 ↗ | (On Diff #37501) | s/capabilitie/capability/ |
| 69 ↗ | (On Diff #37501) | s/value/values/ |
| 92 ↗ | (On Diff #37501) | s/on/one/ |
| 96 ↗ | (On Diff #37501) | I would remove the "the" here and rewrite it to have it read: "The following example first opens capability to casper and then uses this capability to create a new capability to the system.dns casper service and uses the latter capability to resolve an IP address. |
| 107 ↗ | (On Diff #37501) | I would remove "the" here, unless you add "service" after Casper. |
Thank you @bcr for reviewing it!
I bet it was less painful to write it then to review it :)
Haha, yeah. But only because you have a certain Goat looking over your shoulder when writing it. :-)
| lib/libcasper/services/cap_dns/cap_dns.3 | ||
|---|---|---|
| 37 ↗ | (On Diff #37502) | geting -> getting |
| 49 ↗ | (On Diff #37502) | The cap_getnameinfo() signature is missing. |
| 51 ↗ | (On Diff #37502) | The functions |
| 65 ↗ | (On Diff #37502) | Not sure I understand this sentence correctly; is assume the system.dns connection is required for all four cap_* variants? Maybe something like this? and |
| 69 ↗ | (On Diff #37502) | fallowing -> the following |
| 73 ↗ | (On Diff #37502) | Probably .Va instead of .Dv since it's a variable? |
| 77 ↗ | (On Diff #37502) | needs a space between NAME and . |
| 78 ↗ | (On Diff #37502) | .Dv ADDR |
| 83 ↗ | (On Diff #37502) | are allowed. |
| 90 ↗ | (On Diff #37502) | function is allowed |
| 92 ↗ | (On Diff #37502) | family -> families |
| 96 ↗ | (On Diff #37502) | a capability |
| 148 ↗ | (On Diff #37502) | All four entries above need a space between "3" and "," |
After review from @bruffer .
After you review I also noticed I forgot to document to other functions, really sorry for my sloppiness here.
I also update a example.
| lib/libcasper/services/cap_dns/cap_dns.3 | ||
|---|---|---|
| 65 ↗ | (On Diff #37502) | I'm trying to say that the different between API of the get* and cap_get* are only in the one additional parameter with is connection to the system.dns. |
| 73 ↗ | (On Diff #37502) | I'm really not sure about that. |
Good progress! Hopefully these are the last comments.
| lib/libcasper/services/cap_dns/cap_dns.3 | ||
|---|---|---|
| 84 ↗ | (On Diff #37550) | "for more deatls" -> "section for more details" |
| 93 ↗ | (On Diff #37550) | to limit |
| 108 ↗ | (On Diff #37550) | fallowing -> following |
| 139 ↗ | (On Diff #37550) | a capability |
| 142 ↗ | (On Diff #37550) | Lots of capabilities in one sentence :-) I'm not sure how to make this clearer though... |
| 65 ↗ | (On Diff #37502) | Ah! "expect -> except" below then :-) Also "need" -> "needs" |
| 73 ↗ | (On Diff #37502) | Sounds like .Va would be OK then. .Dv is more for constants and other explicit values. |