From cdf0921cedb00243172bb545bcc8d18977a95bff Mon Sep 17 00:00:00 2001 From: Willem Toorop Date: Mon, 10 Nov 2014 15:50:45 +0100 Subject: [PATCH] Fix and add check for manpage-has-bad-whatis-entry Also remove obsolete getdns_free_sync_request_memory function Also list all authors in libgetdns manpage --- doc/Makefile.in | 4 +- doc/getdns_address.3.in | 1 + doc/getdns_cancel_callback.3.in | 1 + ...s_context_set_context_update_callback.3.in | 1 + doc/getdns_convert.3.in | 1 + doc/getdns_dict.3.in | 1 + doc/getdns_dict_get.3.in | 1 + doc/getdns_dict_set.3.in | 1 + doc/getdns_display_ip_address.3.in | 1 + doc/getdns_free_sync_request_memory.3.in | 75 ------------------- doc/getdns_general.3.in | 1 + doc/getdns_hostname.3.in | 1 + doc/getdns_list.3.in | 1 + doc/getdns_list_get.3.in | 1 + doc/getdns_list_set.3.in | 1 + doc/getdns_pretty_print_dict.3.in | 1 + doc/getdns_root_trust_anchor.3.in | 1 + doc/getdns_service.3.in | 1 + doc/getdns_validate_dnssec.3.in | 1 + doc/libgetdns.3.in | 18 ++++- 20 files changed, 35 insertions(+), 79 deletions(-) delete mode 100644 doc/getdns_free_sync_request_memory.3.in diff --git a/doc/Makefile.in b/doc/Makefile.in index f52dc59e..be3898e9 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -47,7 +47,7 @@ EDITS=-e 's/@''version@/$(version)/g' DOXYGEN = @DOXYGEN@ DOCDIRS = html latex man -MANPAGES3 = libgetdns.3 getdns_address.3 getdns_cancel_callback.3 getdns_context.3 getdns_context_set.3 getdns_context_set_context_update_callback.3 getdns_convert.3 getdns_dict.3 getdns_dict_get.3 getdns_dict_set.3 getdns_display_ip_address.3 getdns_free_sync_request_memory.3 getdns_general.3 getdns_hostname.3 getdns_list.3 getdns_list_get.3 getdns_list_set.3 getdns_pretty_print_dict.3 getdns_root_trust_anchor.3 getdns_service.3 getdns_validate_dnssec.3 +MANPAGES3 = libgetdns.3 getdns_address.3 getdns_cancel_callback.3 getdns_context.3 getdns_context_set.3 getdns_context_set_context_update_callback.3 getdns_convert.3 getdns_dict.3 getdns_dict_get.3 getdns_dict_set.3 getdns_display_ip_address.3 getdns_general.3 getdns_hostname.3 getdns_list.3 getdns_list_get.3 getdns_list_set.3 getdns_pretty_print_dict.3 getdns_root_trust_anchor.3 getdns_service.3 getdns_validate_dnssec.3 default: all @@ -68,7 +68,7 @@ install: $(MANPAGES3) for x in $(MANPAGES3); do echo $(INSTALL) -m 644 $$x $(DESTDIR)$(mandir)/man3; $(INSTALL) -m 644 $$x $(DESTDIR)$(mandir)/man3; for altpg in $$($(srcdir)/manpgaltnames $$x); do cp $$x $$altpg; echo $(INSTALL) -m 644 $$altpg $(DESTDIR)$(mandir)/man3; $(INSTALL) -m 644 $$altpg $(DESTDIR)$(mandir)/man3; done; done check: $(MANPAGES3) - for x in $(MANPAGES3); do LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $$x 2>&1 >/dev/null | awk "-vpage=$$x" '{printf("%s: ", page);print}'; done + for x in $(MANPAGES3); do LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z $$x 2>&1 >/dev/null | awk "-vpage=$$x" '{printf("%s: ", page);print}'; if ! lexgrog $$x >/dev/null 2>&1 ; then echo $$x: manpage-has-bad-whatis-entry; fi; done uninstall: for x in $(MANPAGES3); do echo rm -f $(DESTDIR)$(mandir)/man3/$$x; rm -f $(DESTDIR)$(mandir)/man3/$$x; for altpg in $$($(srcdir)/manpgaltnames $$x); do echo rm -f $(DESTDIR)$(mandir)/man3/$$altpg; rm -f $(DESTDIR)$(mandir)/man3/$$altpg; done; done diff --git a/doc/getdns_address.3.in b/doc/getdns_address.3.in index 1573d862..122f2392 100644 --- a/doc/getdns_address.3.in +++ b/doc/getdns_address.3.in @@ -30,6 +30,7 @@ .SH NAME .B getdns_address, .B getdns_address_sync +-- get ip address(es) for a name .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_cancel_callback.3.in b/doc/getdns_cancel_callback.3.in index 4ceadd6d..012bd3ef 100644 --- a/doc/getdns_cancel_callback.3.in +++ b/doc/getdns_cancel_callback.3.in @@ -29,6 +29,7 @@ .TH getdns_cancel_callback 3 "@date@" "getdns @version@" getdns .SH NAME .B getdns_cancel_callback +-- cancel an outstanding asyn getdns request .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_context_set_context_update_callback.3.in b/doc/getdns_context_set_context_update_callback.3.in index fbe26929..d85b1b3e 100644 --- a/doc/getdns_context_set_context_update_callback.3.in +++ b/doc/getdns_context_set_context_update_callback.3.in @@ -29,6 +29,7 @@ .TH getdns_context_set_context_update_callback 3 "@date@" "getdns @version@" getdns .SH NAME .B getdns_context_set_context_update_callback +-- get informed on getdns context updates .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_convert.3.in b/doc/getdns_convert.3.in index 03568c92..25614585 100644 --- a/doc/getdns_convert.3.in +++ b/doc/getdns_convert.3.in @@ -31,6 +31,7 @@ .B getdns_convert, .B getdns_convert_dns_name_to_fqdn, .B getdns_convert_fqdn_to_dns_name +-- convert dname between presentation- and wire-format .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_dict.3.in b/doc/getdns_dict.3.in index 9fc2aaf1..1d271ddd 100644 --- a/doc/getdns_dict.3.in +++ b/doc/getdns_dict.3.in @@ -33,6 +33,7 @@ .B getdns_dict_create_with_extended_memory_functions, .B getdns_dict_create_with_memory_functions, .B getdns_dict_destroy +-- getdns dict create and destroy routines .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_dict_get.3.in b/doc/getdns_dict_get.3.in index fe70f5db..956c0523 100644 --- a/doc/getdns_dict_get.3.in +++ b/doc/getdns_dict_get.3.in @@ -35,6 +35,7 @@ .B getdns_dict_get_int, .B getdns_dict_get_list, .B getdns_dict_get_names +-- get value by name from a getdns dict .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_dict_set.3.in b/doc/getdns_dict_set.3.in index 23424daa..ee684090 100644 --- a/doc/getdns_dict_set.3.in +++ b/doc/getdns_dict_set.3.in @@ -33,6 +33,7 @@ .B getdns_dict_set_dict, .B getdns_dict_set_int, .B getdns_dict_set_list, +-- set a value by name in a getdns dict .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_display_ip_address.3.in b/doc/getdns_display_ip_address.3.in index 0a41b0f4..a038f4e9 100644 --- a/doc/getdns_display_ip_address.3.in +++ b/doc/getdns_display_ip_address.3.in @@ -29,6 +29,7 @@ .TH getdns_display_ip_address 3 "@date@" "getdns @version@" getdns .SH NAME .B getdns_display_ip_address +-- convert an getdns ip address to string .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_free_sync_request_memory.3.in b/doc/getdns_free_sync_request_memory.3.in deleted file mode 100644 index c80374a1..00000000 --- a/doc/getdns_free_sync_request_memory.3.in +++ /dev/null @@ -1,75 +0,0 @@ -.\" The "BSD-New" License -.\" -.\" Copyright (c) 2013, NLNet Labs, Verisign, Inc. -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions are met: -.\" * Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" * Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" * Neither the names of the copyright holders nor the -.\" names of its contributors may be used to endorse or promote products -.\" derived from this software without specific prior written permission. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -.\" DISCLAIMED. IN NO EVENT SHALL Verisign, Inc. BE LIABLE FOR ANY -.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -.\" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -.\" - -.TH getdns_free_sync_request_memory 3 "@date@" "getdns @version@" getdns -.SH NAME -.B getdns_free_sync_request_memory - -.SH LIBRARY -DNS Resolver library (libgetdns, -lgetdns) - -.SH SYNOPSIS -#include - -getdns_return_t -.br -.B getdns_free_sync_request_memory -(getdns_dict *response) - -.SH DESCRIPTION - -.LP -This function is used to free memory allocated within one of the synchronous functions. - -.HP 3 -.I response -A previously allocated response object. - -.HP -.SH "RETURN VALUES" - -Upon successful completion the function returns -.B GETDNS_RETURN_GOOD - -.SH EXAMPLES - -TBD - -.SH FILES -.br -/etc/hosts -.br -/etc/resolv.conf - -.SH SEE ALSO -.BR libgetdns (3), -.BR getdns_address_sync (3), -.BR getdns_general_sync (3), -.BR getdns_hostname_sync (3), -.BR getdns_service_sync (3) - diff --git a/doc/getdns_general.3.in b/doc/getdns_general.3.in index 7e7fe1b5..9b983d0d 100644 --- a/doc/getdns_general.3.in +++ b/doc/getdns_general.3.in @@ -30,6 +30,7 @@ .SH NAME .B getdns_general, .B getdns_general_sync +-- do a getdns DNS lookup .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_hostname.3.in b/doc/getdns_hostname.3.in index 6c6523ef..e45c3620 100644 --- a/doc/getdns_hostname.3.in +++ b/doc/getdns_hostname.3.in @@ -30,6 +30,7 @@ .SH NAME .B getdns_hostname, .B getdns_hostname_sync +-- get hostname by address .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_list.3.in b/doc/getdns_list.3.in index b9580fe8..27151d57 100644 --- a/doc/getdns_list.3.in +++ b/doc/getdns_list.3.in @@ -33,6 +33,7 @@ .B getdns_list_create_with_extended_memory_functions, .B getdns_list_create_with_memory_functions, .B getdns_list_destroy +-- getdns list create and destroy routines .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_list_get.3.in b/doc/getdns_list_get.3.in index aef83e19..1749ef08 100644 --- a/doc/getdns_list_get.3.in +++ b/doc/getdns_list_get.3.in @@ -35,6 +35,7 @@ .B getdns_list_get_length, .B getdns_list_get_list, .B getdns_list_get_int +-- get a value by index from a getdns list .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_list_set.3.in b/doc/getdns_list_set.3.in index 7b39ac30..7bae75f1 100644 --- a/doc/getdns_list_set.3.in +++ b/doc/getdns_list_set.3.in @@ -33,6 +33,7 @@ .B getdns_list_set_dict, .B getdns_list_set_int, .B getdns_list_set_list, +-- set a value by index from a getdns list .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_pretty_print_dict.3.in b/doc/getdns_pretty_print_dict.3.in index d190cbee..74d25d5a 100644 --- a/doc/getdns_pretty_print_dict.3.in +++ b/doc/getdns_pretty_print_dict.3.in @@ -29,6 +29,7 @@ .TH getdns_pretty_print_dict 3 "@date@" "getdns @version@" getdns .SH NAME .B getdns_pretty_print_dict +-- return a string representation of a getdns dict .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_root_trust_anchor.3.in b/doc/getdns_root_trust_anchor.3.in index 85f81930..401cd297 100644 --- a/doc/getdns_root_trust_anchor.3.in +++ b/doc/getdns_root_trust_anchor.3.in @@ -29,6 +29,7 @@ .TH getdns_root_trust_anchor 3 "@date@" "getdns @version@" getdns .SH NAME .B getdns_root_trust_anchor +-- return the getdns list of default root trust anchors .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_service.3.in b/doc/getdns_service.3.in index 06326a8e..35f40579 100644 --- a/doc/getdns_service.3.in +++ b/doc/getdns_service.3.in @@ -30,6 +30,7 @@ .SH NAME .B getdns_service, .B getdns_service_sync +-- getdns lookup of a service .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/getdns_validate_dnssec.3.in b/doc/getdns_validate_dnssec.3.in index 36bccd11..bce70b85 100644 --- a/doc/getdns_validate_dnssec.3.in +++ b/doc/getdns_validate_dnssec.3.in @@ -29,6 +29,7 @@ .TH getdns_validate_dnssec 3 "@date@" "getdns @version@" getdns .SH NAME .B getdns_validate_dnssec +-- DNSSEC validate a given getdns record .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) diff --git a/doc/libgetdns.3.in b/doc/libgetdns.3.in index f813c340..18921870 100644 --- a/doc/libgetdns.3.in +++ b/doc/libgetdns.3.in @@ -29,6 +29,8 @@ .TH libgetdns 3 "@date@" "getdns @version@" getdns .SH NAME libgetdns +-- an implementation of a modern asynchronous DNS API by and for application developers + .SH LIBRARY DNS Resolver library (libgetdns, -lgetdns) @@ -699,14 +701,26 @@ The getdns API was documented by Paul Hoffman. This implementation of the getdn .LP .RS 3 .br -Carig Despeaux, Verisign Inc. +Craig Despeaux, Verisign Inc. +.br +John Dickinson, Sinodun +.br +Sara Dickinson, Sinodun .br Neel Goyal, Verisign Inc. .br -Melinda Shore, No Mountain Software, LLC +Shumon Huque, Verisign Labs +.br +Olaf Kolkman, NLnet Labs +.br +Allison Mankin, Verisign Inc. - Verisign Labs. +.br +Melinda Shore, No Mountain Software LLC .br Willem Toorop, NLnet Labs .br +Gowri Visweswaran, Verisign Labs +.br Wouter Wijngaards, NLnet Labs .br Glen Wiley, Verisign Inc.