Files
heimdal/doc/Makefile.am
Nicolas Williams f4ba41ebdd Pluggable libheimbase interface for DBs and misc libheimbase enhancements
[Code reviewed by Love Hörnquist Åstrand <lha@kth.se>]

    Added heim_db_*() entry points for dealing with databases, and
    make krb5_aname_to_localname() use it.

    The following enhancements to libheimbase are included:

     - Add heim_data_t and heim_string_t "reference" variants to
       avoid memory copies of potentially large data/strings.

       See heim_data_ref_create() and heim_string_ref_create().

     - Added enhancements to heim_array_t to allow their use for
       queues and stacks, and to improve performance.  See
       heim_array_insert_value().

     - Added XPath-like accessors for heim_object_t.  See
       heim_path_get(), heim_path_copy(), heim_path_create(), and
       heim_path_delete().  These are used extensively in the DB
       framework's generic composition of ACID support and in the
       test_base program

     - Made libheimbase more consistent with Core Foundation naming
       conventions.  See heim_{dict, array}_{get, copy}_value() and
       heim_path_{get, copy}().

     - Added functionality to and fixed bugs in base/json.c:
        - heim_serialize();
        - depth limit for JSON parsing (for DoS protection);
        - pretty-printing;
        - JSON compliance (see below);
        - flag options for parsing and serializing; these are needed
          because of impedance mismatches between heim_object_t and
          JSON (e.g., heim_dict_t allows non-string keys, but JSON
          does not; heimbase supports binary data, while JSON does
          not).

     - Added heim_error_enomem().

     - Enhanced the test_base program to test new functionality and
       to use heim_path*() to better test JSON encoding.  This
       includes some fuzz testing of JSON parsing, and running the
       test under valgrind.

     - Started to add doxygen documentation for libheimbase (but doc
       build for libheimbase is still incomplete).

    Note that there's still some incomplete JSON support:

     - JSON string quoting is not fully implemented;

     - libheimbase lacks support for real numbers, while JSON has
       it -- otherwise libheimbase is a superset of JSON,
       specifically in that any heim_object_t can be a key for an
       associative array.

    The following DB backends are supported natively:

     - "sorted-text", a binary search of sorted (in C locale), flat
       text files;

     - "json", a backend that stores DB contents serialized as JSON
       (this is intended for configuration-like contents).

    The DB framework supports:

     - multiple key/value tables per-DB
     - ACID transactions

    The DB framework also natively implements ACID transactions for
    any DB backends that a) do not provide transactions natively, b)
    do provide lock/unlock/sync methods (even on Windows).  This
    includes autocommit of DB updates outside transactions.

    Future DB enhancements may include:

     - add backends for various DB types (BDB, CDB, MDB, ...);

     - make libhdb use heim_db_t;

     - add a command-line tool for interfacing to databases via
       libheimbase (e.g., to get/set/delete values, create/copy/
       backup DBs, inspect history, check integrity);

     - framework-level transaction logging (with redo and undo
       logging), for generic incremental replication;

     - framework-level DB integrity checking.

       We could store a MAC of the XOR of a hash function applied to
       {key, value} for every entry in the DB, then use this to check
       DB integrity incrementally during incremental replication, as
       well as for the whole DB.
2012-02-05 16:26:32 -06:00

156 lines
3.6 KiB
Makefile

# $Id$
include $(top_srcdir)/Makefile.am.common
AUTOMAKE_OPTIONS = no-texinfo.tex
MAKEINFOFLAGS = --css-include=$(srcdir)/heimdal.css
TEXI2DVI = true # ARGH, make distcheck can't be disabled to not build dvifiles
info_TEXINFOS = heimdal.texi hx509.texi
dxy_subst = sed -e 's,[@]srcdir[@],$(srcdir),g' \
-e 's,[@]objdir[@],.,g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g'
hcrypto.dxy: hcrypto.din Makefile
$(dxy_subst) < $(srcdir)/hcrypto.din > hcrypto.dxy.tmp
chmod +x hcrypto.dxy.tmp
mv hcrypto.dxy.tmp hcrypto.dxy
hdb.dxy: hdb.din Makefile
$(dxy_subst) < $(srcdir)/hdb.din > hdb.dxy.tmp
chmod +x hdb.dxy.tmp
mv hdb.dxy.tmp hdb.dxy
base.dxy: base.din Makefile
$(dxy_subst) < $(srcdir)/base.din > base.dxy.tmp
chmod +x base.dxy.tmp
mv base.dxy.tmp base.dxy
hx509.dxy: hx509.din Makefile
$(dxy_subst) < $(srcdir)/hx509.din > hx509.dxy.tmp
chmod +x hx509.dxy.tmp
mv hx509.dxy.tmp hx509.dxy
gssapi.dxy: gssapi.din Makefile
$(dxy_subst) < $(srcdir)/gssapi.din > gssapi.dxy.tmp
chmod +x gssapi.dxy.tmp
mv gssapi.dxy.tmp gssapi.dxy
krb5.dxy: krb5.din Makefile
$(dxy_subst) < $(srcdir)/krb5.din > krb5.dxy.tmp
chmod +x krb5.dxy.tmp
mv krb5.dxy.tmp krb5.dxy
ntlm.dxy: ntlm.din Makefile
$(dxy_subst) < $(srcdir)/ntlm.din > ntlm.dxy.tmp
chmod +x ntlm.dxy.tmp
mv ntlm.dxy.tmp ntlm.dxy
wind.dxy: wind.din Makefile
$(dxy_subst) < $(srcdir)/wind.din > wind.dxy.tmp
chmod +x wind.dxy.tmp
mv wind.dxy.tmp wind.dxy
texi_subst = sed -e 's,[@]dbdir[@],$(localstatedir),g' \
-e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g'
vars.texi: vars.tin Makefile
$(texi_subst) < $(srcdir)/vars.tin > vars.texi.tmp
chmod +x vars.texi.tmp
mv vars.texi.tmp vars.texi
PROJECTS = base hdb hx509 gssapi krb5 ntlm wind
if !HAVE_OPENSSL
PROJECTS += hcrypto
endif
doxyout doxygen: base.dxy hdb.dxy hx509.dxy hcrypto.dxy gssapi.dxy krb5.dxy ntlm.dxy wind.dxy
@find $(srcdir)/doxyout -type d ! -perm -200 -exec chmod u+w {} ';' ; \
rm -rf $(srcdir)/doxyout ; \
mkdir $(srcdir)/doxyout ; \
for a in $(PROJECTS) ; do \
echo $$a ; \
doxygen $$a.dxy; \
(cd $(srcdir)/doxyout && find $$a/man -type f > $$a/manpages ) ; \
done
install-data-hook: install-doxygen-manpage
uninstall-hook: uninstall-doxygen-manpage
dist-hook: doxygen
install-doxygen-manpage:
for a in $(PROJECTS) ; do \
f="$(srcdir)/doxyout/$$a/manpages" ; \
test -f $$f || continue ; \
echo "install $$a manual pages $$(wc -l < $$f)" ; \
while read x ; do \
section=`echo "$$x" | sed 's/.*\.\([0-9]\)/\1/'` ; \
$(mkinstalldirs) "$(DESTDIR)$(mandir)/man$$section" ; \
$(INSTALL_DATA) $(srcdir)/doxyout/$$x "$(DESTDIR)$(mandir)/man$$section" ; \
done < $$f ; \
done ; exit 0
uninstall-doxygen-manpage:
@for a in $(PROJECTS) ; do \
f="$(srcdir)/doxyout/$$a/manpages" ; \
test -f $$f || continue ; \
echo "removing $$a manual pages" ; \
while read x ; do \
section=`echo "$$x" | sed 's/.*\.\([0-9]\)/\1/'` ; \
base=`basename $$x` ; \
rm "$(DESTDIR)$(mandir)/man$$section/$$base" ; \
done < $$f ; \
done
heimdal_TEXINFOS = \
ack.texi \
apps.texi \
copyright.texi \
heimdal.texi \
install.texi \
intro.texi \
kerberos4.texi \
migration.texi \
misc.texi \
programming.texi \
setup.texi \
vars.texi \
whatis.texi \
win2k.texi
EXTRA_DIST = \
NTMakefile \
doxyout \
footer.html \
gssapi.din \
hdb.din \
hcrypto.din \
header.html \
heimdal.css \
base.din \
hx509.din \
krb5.din \
ntlm.din \
init-creds \
latin1.tex \
layman.asc \
doxytmpl.dxy \
wind.din \
vars.tin
CLEANFILES = \
hcrypto.dxy* \
base.dxy* \
hx509.dxy* \
hdb.dxy* \
gssapi.dxy* \
krb5.dxy* \
ntlm.dxy* \
wind.dxy* \
vars.texi*