-
-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add manual pages #26
Add manual pages #26
Conversation
…st-nsec3-hash page to match the current help output of the command.
Co-authored-by: Jannik <jannik@nlnetlabs.nl>
Maybe "The manual goes here ..." in |
I think we should merge this because this is fantastic and we can fix all my nitpicky issues later, but... NITPICK MODE ACTIVATED I don't like how the synopsis renders as:
I'd expect
The main The styling is sometimes inconsistent:
I think that the NITPICK MODE DEACTIVATED That being said, these are all written very well. Amazing! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I put yesterdays nitpicks into comments.
Something for later: we should add examples and document exit codes.
Synopsis | ||
-------- | ||
|
||
:program:`dnst key2ds` [``OPTIONS``] ``<KEYFILE>`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Throughout the docs it's at least inconsistent whether its [
OPTIONS
] or[OPTIONS]
.
I'll solve the inconsistencies.
The big code block with possible invocations sound nice, but might not be able to implement that today.
|
||
.. option:: -o <domain> | ||
|
||
Set the origin for the zone (for zonefiles with relative names and no |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is correct but perhaps it would be better to say that this is only needed for zones that both contain relative labels AND lack an $ORIGIN
directive. I think it also has to be an absolute/fully qualified domain name, not a relative domain name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. It needs to be an absolute domain name. Also, signzone or rather domain's Name (::from_str?) turns any non-dot-terminated domain into an absolute/dot-terminated domain. So dnst signzone -o origin
and dnst signzone -o origin.
do the same.
Left over TODOs (though not merge-blocking I would say):
Also I left some comments unresolved that could potentially turn into separate issues (for dnst sub commands or domain). |
If this matches the current main then I'd say we should merge this so we can update it along with other changes. |
Hm, the nsec3-hash default iterations for dnst is not yet merged into main. I'll change that to the current defaults in main, and the change would be done in #6 then, I suppose. |
Alright I'll add it there! |
Adds manual pages for the six commands based on the help output (of dnst and ldns) and the ldns manuals. I only included arguments actually supported by the dnst reimplementation. Once everything is ready, this will very likely need updating.
This also incorporates and updates the changes from #25.