CVS gsasl/doc/reference

[gsasl-commit]

Update of /home/cvs/gsasl/doc/reference
In directory dopio:/tmp/cvs-serv9079

Modified Files:
        Makefile.am 
Added Files:
        gsasl-docs.sgml gsasl.types gtk-doc.make 
Log Message:
Revamp.

--- /home/cvs/gsasl/doc/reference/Makefile.am   2004/09/24 14:54:57     1.15
+++ /home/cvs/gsasl/doc/reference/Makefile.am   2004/10/24 21:23:50     1.16
@@ -1,50 +1,69 @@
 ## Process this file with automake to produce Makefile.in
-# Copyright (C) 2003, 2004 Simon Josefsson.
-#
-# This file is part of GNU Libidn.
-#
-# GNU Libidn is free software; you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as
-# published by the Free Software Foundation; either version 2.1 of
-# the License, or (at your option) any later version.
-#
-# GNU Libidn is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with GNU Libidn; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
-
-HIGNORE = internal.h
-HTML_OBJECTS = index.html c4.html \
-       gsasl-gsasl.html gsasl-gsasl-compat.html gsasl-gsasl-mech.html
-
-EXTRA_DIST = $(PACKAGE)-docs.tmpl $(HTML_OBJECTS) $(IMAGES)
-IMAGES = home.png left.png right.png up.png
-
-scan.stamp: $(top_srcdir)/lib/src/*.c $(top_srcdir)/lib/src/*.h
-       gtkdoc-scan --module=$(PACKAGE) --source-dir=$(top_srcdir)/lib/src \
-               --ignore-headers="$(HIGNORE)" && touch scan.stamp
-
-tmpl.stamp: scan.stamp
-       gtkdoc-mktmpl --module=$(PACKAGE) --output-dir=.
-
-sgml.stamp: tmpl.stamp
-       gtkdoc-mkdb --module=$(PACKAGE) --source-dir=$(top_srcdir)/lib/src \
-               --tmpl-dir=. --output-dir=. \
-               --main-sgml-file=$(srcdir)/$(PACKAGE)-docs.tmpl
-
-index.html: sgml.stamp
-       cp $(srcdir)/$(PACKAGE)-docs.tmpl $(PACKAGE)-docs.sgml
-       gtkdoc-mkhtml $(PACKAGE) $(PACKAGE)-docs.sgml
-       rm -f $(PACKAGE)-docs.sgml ../html.stamp
-       gtkdoc-fixxref --module-dir=. --html-dir=$(HTML_DIR)
-
-all: index.html
-
-clean-local:
-       rm -f *.bak scan.stamp tmpl.stamp sgml.stamp *.txt *.sgml \
-               $(PACKAGE)-doc.bottom $(PACKAGE)-doc.top \
-               $(HTML_OBJECTS) $(IMAGES) style.css
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=gsasl
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../lib/src
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/lib/src/*.h
+CFILE_GLOB=$(top_srcdir)/lib/src/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=internal.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=
+GTKDOC_LIBS=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += 
--- /home/cvs/gsasl/doc/reference/gsasl-docs.sgml       2003/11/02 00:11:53     
1.3
+++ /home/cvs/gsasl/doc/reference/gsasl-docs.sgml       2004/10/24 21:23:50     
1.4
@@ -1,7 +1,7 @@
-<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!ENTITY gsasl-gsasl SYSTEM "sgml/gsasl.sgml">
-]>
-<book id="index">
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
     <title>GNU SASL API Reference Manual</title>
   </bookinfo>
@@ -16,28 +16,32 @@
 from clients, and in clients to authenticate against servers.
     </para>
     <para>
-GNU SASL contains a library (`libgsasl'), a command line utility
+GNU SASL contains of a library (`libgsasl'), a command line utility
 (`gsasl') to access the library from the shell, and a manual.  The
-library includes support for the SASL framework (with authentication
+library includes support for the framework (with authentication
 functions and application data privacy and integrity functions) and at
 least partial support for the CRAM-MD5, EXTERNAL, GSSAPI, ANONYMOUS,
 PLAIN, SECURID, DIGEST-MD5, LOGIN, NTLM mechanisms.
     </para>
     <para>
-The library is portable because it does not do network communication
-by itself, but rather leaves it up to the calling application.  The
-library is flexible with regards to the authorization infrastructure
-used, as it utilizes callbacks into the application to decide whether
-an user is authorized or not.
+The library is easily ported because it does not do network
+communication by itself, but rather leaves it up to the calling
+application.  The library is flexible with regards to the
+authorization infrastructure used, as it utilizes callbacks into the
+application to decide whether a user is authorized or not.  GNU SASL
+has been ported to many Unix flavors.
     </para>
     <para>
 GNU SASL is developed for the GNU/Linux system, but runs on over 20
-platforms including most major Unix platforms and Windows.
+platforms including most major Unix platforms and Windows, and many
+kind of devices including iPAQ handhelds and S/390 mainframes.
     </para>
     <para>
-GNU SASL is licensed under the GNU Public License.
+GNU SASL is licensed under the GNU General Public License.
     </para>
 
-    &gsasl-gsasl;
+    <xi:include href="xml/gsasl.xml"/>
+    <xi:include href="xml/gsasl-mech.xml"/>
+    <xi:include href="xml/gsasl-compat.xml"/>
   </chapter>
 </book>

--- /home/cvs/gsasl/doc/reference/gtk-doc.make  2004/10/24 21:23:50     NONE
+++ /home/cvs/gsasl/doc/reference/gtk-doc.make  2004/10/24 21:23:50     1.1
# -*- mode: makefile -*-

####################################
# Everything below here is generic #
####################################

if GTK_DOC_USE_LIBTOOL
GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS)
GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS)
else
GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS)
GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS)
endif

# We set GPATH here; this gives us semantics for GNU make
# which are more like other make's VPATH, when it comes to
# whether a source that is a target of one rule is then
# searched for in VPATH/GPATH.
#
GPATH = $(srcdir)

TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)

EXTRA_DIST =                            \
        $(content_files)                \
        $(HTML_IMAGES)                  \
        $(DOC_MAIN_SGML_FILE)           \
        $(DOC_MODULE).types             \
        $(DOC_MODULE)-sections.txt      \
        $(DOC_MODULE)-overrides.txt

DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
           $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp

SCANOBJ_FILES =                  \
        $(DOC_MODULE).args       \
        $(DOC_MODULE).hierarchy  \
        $(DOC_MODULE).interfaces \
        $(DOC_MODULE).prerequisites \
        $(DOC_MODULE).signals

CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)

if ENABLE_GTK_DOC
all-local: html-build.stamp

#### scan ####

scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
        @echo '*** Scanning header files ***'
        @-chmod -R u+w $(srcdir)
        if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" 
LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) 
--module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
        else \
            cd $(srcdir) ; \
            for i in $(SCANOBJ_FILES) ; do \
               test -f $$i || touch $$i ; \
            done \
        fi
        cd $(srcdir) && \
          gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) 
--ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
        touch scan-build.stamp

$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
        @true

#### templates ####

tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) 
$(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
        @echo '*** Rebuilding template files ***'
        @-chmod -R u+w $(srcdir)
        cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
        touch tmpl-build.stamp

tmpl.stamp: tmpl-build.stamp
        @true

#### xml ####

sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
        @echo '*** Building XML ***'
        @-chmod -R u+w $(srcdir)
        cd $(srcdir) && \
        gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) 
--output-format=xml $(MKDB_OPTIONS)
        touch sgml-build.stamp

sgml.stamp: sgml-build.stamp
        @true

#### html ####

html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
        @echo '*** Building HTML ***'
        @-chmod -R u+w $(srcdir)
        rm -rf $(srcdir)/html 
        mkdir $(srcdir)/html
        cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) 
../$(DOC_MAIN_SGML_FILE)
        test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) 
html )
        @echo '-- Fixing Crossreferences' 
        cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) 
$(FIXXREF_OPTIONS)
        touch html-build.stamp
else
all-local:
endif

##############

clean-local:
        rm -f *~ *.bak
        rm -rf .libs

maintainer-clean-local: clean
        cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt 
$(DOC_MODULE)-decl.txt

install-data-local:
        installfiles=`echo $(srcdir)/html/*`; \
        if test "$$installfiles" = '$(srcdir)/html/*'; \
        then echo '-- Nothing to install' ; \
        else \
          $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
          for i in $$installfiles; do \
            echo '-- Installing '$$i ; \
            $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
          done; \
          echo '-- Installing $(srcdir)/html/index.sgml' ; \
          $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || 
:; \
        fi

uninstall-local:
        rm -f $(DESTDIR)$(TARGET_DIR)/*

#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
dist-check-gtkdoc:
else
dist-check-gtkdoc:
        @echo "*** gtk-doc must be installed and enabled in order to make dist"
        @false
endif

dist-hook: dist-check-gtkdoc dist-hook-local
        mkdir $(distdir)/tmpl
        mkdir $(distdir)/xml
        mkdir $(distdir)/html
        -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
        -cp $(srcdir)/xml/*.xml $(distdir)/xml
        -cp $(srcdir)/html/* $(distdir)/html

.PHONY : dist-hook-local