https://bugzilla.redhat.com/show_bug.cgi?id=2352694
--- Comment #9 from Ben Beasley code@musicinmybrain.net --- I see that you added an appropriate upstream status comment for install.patch. Thanks.
I see that you documented why the tests aren't run. Thanks.
Using sphinx to generate a man page was a good idea, but the resulting man page doesn't appear to usefully document the command-line interface. It appears to document the internal implementation of the command-line tool instead:
DIGDOCCOMMAND-LINETOOL(1) digdoc command-line tool DIGDOCCOMMAND-LINETOOL(1)
NAME digdoccommand-linetool - digdoc command-line tool 0.1
Defines
DNS_PACKET_SIZE
DIGDOC_CF_DNS
Functions
void print_output(ldns_pkt *pkt, size_t dns_length, int query_time) print response
This function prints the DNS response separated in sections.
Parameters
• pkt -- [in] contains the raw DNS packet
• dns_length -- [in] is the size of the DNS packet
• query_time -- [in] is the time between sending a DoC packet and receiving a response in microseconds
coap_response_t handle_response(coap_session_t *session, const coap_pdu_t *sent_pdu, const coap_pdu_t *received_pdu, const coap_mid_t message_id) handle response
This function is automatically called when a DoC packet was received.
NOTE: session, sent_pdu and message_id are not used but need to be included in the coap_response_handler_t of libcoap
Parameters received_pdu -- [in] encapsulates the received message
Returns COAP_RESPONSE_OK if the response is fine
[...]
I don't think we should ship that. Unless Sphinx can be asked to document the actual command-line interface instead, the options would appear to be:
- Use help2man - Write a man page by hand - Don’t ship a man page