diff options
author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2013-01-21 21:18:59 +0100 |
---|---|---|
committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2013-01-21 21:18:59 +0100 |
commit | e36b08d729af195c1d9dd1800ff0b57349fe4aab (patch) | |
tree | 4bfdd37c29d5ddc423ebdba9168d8382cab94376 | |
parent | 1e8f5a67debebb0f918660bf34fedebc43b1ef36 (diff) | |
download | gnutls-e36b08d729af195c1d9dd1800ff0b57349fe4aab.tar.gz |
updated docs for sbuf API.
-rw-r--r-- | doc/Makefile.am | 53 | ||||
-rw-r--r-- | doc/cha-functions.texi | 9 | ||||
-rw-r--r-- | doc/doc.mk | 2 |
3 files changed, 42 insertions, 22 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 8962ccf6d0..c9970e5d14 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -206,20 +206,19 @@ MAINTAINERCLEANFILES = # Generated texinfos. -gnutls_TEXINFOS += gnutls-api.texi x509-api.texi pgp-api.texi \ - pkcs12-api.texi pkcs11-api.texi abstract-api.texi tpm-api.texi \ - compat-api.texi dtls-api.texi crypto-api.texi ocsp-api.texi \ - dane-api.texi -MAINTAINERCLEANFILES += gnutls-api.texi x509-api.texi pgp-api.texi \ - pkcs12-api.texi pkcs11-api.texi abstract-api.texi tpm-api.texi \ - compat-api.texi dtls-api.texi crypto-api.texi ocsp-api.texi \ - dane-api.texi +API_FILES=gnutls-api.texi x509-api.texi pgp-api.texi pkcs12-api.texi \ + tpm-api.texi pkcs11-api.texi abstract-api.texi compat-api.texi \ + dtls-api.texi crypto-api.texi ocsp-api.texi tpm-api.texi dane-api.texi \ + sbuf-api.texi +gnutls_TEXINFOS += $(API_FILES) + +MAINTAINERCLEANFILES += $(API_FILES) gnutls-api.texi: $(top_srcdir)/lib/includes/gnutls/gnutls.h.in echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/gnutls.h.in|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -230,7 +229,7 @@ gnutls-api.texi: $(top_srcdir)/lib/includes/gnutls/gnutls.h.in dane-api.texi: $(top_srcdir)/libdane/includes/gnutls/dane.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$^|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -241,7 +240,18 @@ dane-api.texi: $(top_srcdir)/libdane/includes/gnutls/dane.h x509-api.texi: $(top_srcdir)/lib/includes/gnutls/x509.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/x509.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ + echo $(ECHO_N) "Creating documentation for $$i... " && \ + $(srcdir)/scripts/gdoc -texinfo \ + -function $$i \ + $(C_SOURCE_FILES) >> $@-tmp 2>/dev/null && \ + echo "ok"; \ + done + mv -f $@-tmp $@ + +sbuf-api.texi: $(top_srcdir)/lib/includes/gnutls/sbuf.h + echo "" > $@-tmp + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -252,7 +262,7 @@ x509-api.texi: $(top_srcdir)/lib/includes/gnutls/x509.h pgp-api.texi: $(top_srcdir)/lib/includes/gnutls/openpgp.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/openpgp.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -264,7 +274,7 @@ pgp-api.texi: $(top_srcdir)/lib/includes/gnutls/openpgp.h pkcs12-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs12.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/pkcs12.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -275,7 +285,7 @@ pkcs12-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs12.h pkcs11-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs11.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/pkcs11.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -286,7 +296,7 @@ pkcs11-api.texi: $(top_srcdir)/lib/includes/gnutls/pkcs11.h tpm-api.texi: $(top_srcdir)/lib/includes/gnutls/tpm.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/tpm.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -297,7 +307,7 @@ tpm-api.texi: $(top_srcdir)/lib/includes/gnutls/tpm.h abstract-api.texi: $(top_srcdir)/lib/includes/gnutls/abstract.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/abstract.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -308,7 +318,7 @@ abstract-api.texi: $(top_srcdir)/lib/includes/gnutls/abstract.h compat-api.texi: $(top_srcdir)/lib/includes/gnutls/compat.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/compat.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -319,7 +329,7 @@ compat-api.texi: $(top_srcdir)/lib/includes/gnutls/compat.h dtls-api.texi: $(top_srcdir)/lib/includes/gnutls/dtls.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/dtls.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -330,7 +340,7 @@ dtls-api.texi: $(top_srcdir)/lib/includes/gnutls/dtls.h crypto-api.texi: $(top_srcdir)/lib/includes/gnutls/crypto.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/crypto.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -341,7 +351,7 @@ crypto-api.texi: $(top_srcdir)/lib/includes/gnutls/crypto.h ocsp-api.texi: $(top_srcdir)/lib/includes/gnutls/ocsp.h echo "" > $@-tmp - for i in `$(top_srcdir)/doc/scripts/getfuncs.pl <$(top_srcdir)/lib/includes/gnutls/ocsp.h|sort|uniq`; do \ + for i in `$(top_srcdir)/doc/scripts/getfuncs.pl < $<|sort|uniq`; do \ echo $(ECHO_N) "Creating documentation for file $$i... " && \ $(srcdir)/scripts/gdoc -texinfo \ -function $$i \ @@ -400,7 +410,8 @@ enums.texi: $(HEADER_FILES) gnutls_TEXINFOS += $(ENUMS) $(FUNCS) DISTCLEANFILES += $(ENUMS) stamp_enums stamp_functions -stamp_functions: gnutls-api.texi x509-api.texi pgp-api.texi pkcs12-api.texi tpm-api.texi pkcs11-api.texi abstract-api.texi compat-api.texi dtls-api.texi crypto-api.texi ocsp-api.texi tpm-api.texi dane-api.texi + +stamp_functions: $(API_FILES) -mkdir functions -rm -f functions/*.short for i in $^; do \ diff --git a/doc/cha-functions.texi b/doc/cha-functions.texi index da86cc4b2c..145f9d5da6 100644 --- a/doc/cha-functions.texi +++ b/doc/cha-functions.texi @@ -4,6 +4,7 @@ @menu * Core TLS API:: +* High level TLS API:: * Datagram TLS API:: * X509 certificate API:: * OCSP API:: @@ -25,6 +26,14 @@ The prototypes for the following functions lie in @include gnutls-api.texi +@node High level TLS API +@section High level TLS API + +The prototypes for the following functions lie in +@file{gnutls/sbuf.h}. + +@include sbuf-api.texi + @node Datagram TLS API @section Datagram TLS API diff --git a/doc/doc.mk b/doc/doc.mk index 6f67f61d9d..ff9cccb441 100644 --- a/doc/doc.mk +++ b/doc/doc.mk @@ -24,6 +24,6 @@ HEADER_FILES = $(top_srcdir)/lib/includes/gnutls/gnutls.h.in \ $(top_srcdir)/lib/includes/gnutls/abstract.h $(top_srcdir)/lib/includes/gnutls/compat.h \ $(top_srcdir)/lib/includes/gnutls/dtls.h $(top_srcdir)/lib/includes/gnutls/crypto.h \ $(top_srcdir)/lib/includes/gnutls/ocsp.h $(top_srcdir)/lib/includes/gnutls/tpm.h \ - $(top_srcdir)/libdane/includes/gnutls/dane.h + $(top_srcdir)/libdane/includes/gnutls/dane.h $(top_srcdir)/lib/includes/gnutls/sbuf.h C_SOURCE_FILES = $(top_srcdir)/lib/*/*.c $(top_srcdir)/lib/*.c $(top_srcdir)/libdane/*.c |