Merge pull request #109 from dkg/develop

improve documentation

Looks good! Thanks!

.dir-locals.el

@@ -0,0 +1,9 @@
+;; emacs local configuration settings for getdns source
+;; surmised by dkg on 2015-07-19 10:10:51+0200
+
+((c-mode
+  (indent-tabs-mode . t)
+  (tab-width . 8)
+  (c-basic-offset . 8)
+  (c-file-style . "linux"))
+ )

.gitignore

@@ -39,3 +39,12 @@ src/getdns/getdns.h
 src/Doxyfile
 src/getdns/getdns_extra.h
 src/version.c
+aclocal.m4
+configure
+ltmain.sh
+m4/libtool.m4
+m4/ltoptions.m4
+m4/ltsugar.m4
+m4/ltversion.m4
+m4/lt~obsolete.m4
+src/config.h.in

doc/Makefile.in

@@ -32,6 +32,8 @@ version = @PACKAGE_VERSION@
 tarname = @PACKAGE_TARNAME@
 distdir = $(tarname)-$(version)
 
+api_version = @API_VERSION@
+
 prefix = @prefix@
 exec_prefix = @exec_prefix@
 bindir = @bindir@
@@ -58,7 +60,7 @@ doc: 	$(MANPAGES3)
 
 .SUFFIXES: .3.in .3
 .3.in.3:
-	sed $(EDITS) -e "s/@date@/`date +'%B %Y'`/g" $< > $@
+	sed $(EDITS) -e "s/@date@/$(api_version)/g" $< > $@
 
 # we assume that we want a separate file for each "name" specified for each man page
 # and consider these "alternate names" simple copies of the main man page

src/context.h

@@ -80,6 +80,7 @@ typedef enum getdns_tls_hs_state {
 } getdns_tls_hs_state_t;
 
 typedef struct getdns_upstream {
+	/* backpointer to containing upstreams structure */
 	struct getdns_upstreams *upstreams;
 
 	socklen_t                addr_len;
@@ -245,6 +246,6 @@ void priv_getdns_context_ub_read_cb(void *userarg);
 
 void priv_getdns_upstreams_dereference(getdns_upstreams *upstreams);
 
-void priv_getdns_upstream_shutdown(getdns_upstream *upstreams);
+void priv_getdns_upstream_shutdown(getdns_upstream *upstream);
 
 #endif /* _GETDNS_CONTEXT_H_ */