Improve the documentation about generic_dns_client and explain the format of the nameserver argument
#1365
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rmat of the [nameservers] argument
|
once mirage/ocaml-dns@2a44ec1 is merged and released, we'll have a nice error message which describes the format in detail. I'm actually not sure where the documentation makes sense -- is it at runtime (i.e. reporting a failure) or in the ocamldoc. I dislike that we repeat it all over, and e.g. here we'll remember to update it soon... |
hannesm
added a commit
to hannesm/opam-repository
that referenced
this pull request
Oct 25, 2022
… (4.3.1) CHANGES: #### Fixed - adapt to conduit 6.0.1 API (delay the parsing of the nameserver list) (mirage/mirage#1362 mirage/mirage#1369, @reynir @hannesm, fixes mirage/mirage#1360) - improve the generic_dns_client documentation (mirage/mirage#1365, @dinosaure) - upgrade to git 3.10.0 (mirage/mirage#1366, @dinosaure) #### Changed - mirage-runtime: use Logs.level_of_string / level_to_string, avoid manual construction of Cmdliner.Arg.conv types (use the Cmdliner.Arg.conv function instead) (mirage/mirage#1358, @hannesm) #### Added - functoria-runtime: provide argument_error exit code (mirage/mirage#1361, @hannesm) - add a http_server device using paf (mirage/mirage#1367, @dinosaure)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pointed out by @Engil, it is difficult to get a description of the format required to define a specific nameserver. I have added documentation to explain the format of the latter to make it easier to use. (/cc @hannesm)