Details
- Reviewers
bcr brueffer - Group Reviewers
manpages - Commits
- rS327689: Document the DNS Casper service.
Diff Detail
- Lint
Lint Skipped - Unit
Tests Skipped
Event Timeline
A few suggestions and corrections. Thanks for writing the man page!
| lib/libcasper/services/cap_dns/cap_dns.3 | ||
|---|---|---|
| 38 | s/capabilitie/capability/ | |
| 70 | s/value/values/ | |
| 93 | s/on/one/ | |
| 97 | 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. | |
| 108 | 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 | ||
|---|---|---|
| 38 | geting -> getting | |
| 50 | The cap_getnameinfo() signature is missing. | |
| 52 | The functions | |
| 66 | 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 | |
| 70 | fallowing -> the following | |
| 74 | Probably .Va instead of .Dv since it's a variable? | |
| 78 | needs a space between NAME and . | |
| 79 | .Dv ADDR | |
| 84 | are allowed. | |
| 91 | function is allowed | |
| 93 | family -> families | |
| 97 | a capability | |
| 149 | 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 | ||
|---|---|---|
| 66 | 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. | |
| 74 | I'm really not sure about that. | |
Good progress! Hopefully these are the last comments.
| lib/libcasper/services/cap_dns/cap_dns.3 | ||
|---|---|---|
| 66 | Ah! "expect -> except" below then :-) Also "need" -> "needs" | |
| 74 | Sounds like .Va would be OK then. .Dv is more for constants and other explicit values. | |
| 84 | "for more deatls" -> "section for more details" | |
| 93 | to limit | |
| 108 | fallowing -> following | |
| 139 | a capability | |
| 142 | Lots of capabilities in one sentence :-) I'm not sure how to make this clearer though... | |