hal ChangeLog, 1.831, 1.832 acinclude.m4, 1.2, 1.3 autogen.sh, 1.3, 1.4 configure.in, 1.120, 1.121

David Zeuthen david at kemper.freedesktop.org
Sat Feb 25 12:38:25 PST 2006


Update of /cvs/hal/hal
In directory kemper:/tmp/cvs-serv7058

Modified Files:
	ChangeLog acinclude.m4 autogen.sh configure.in 
Log Message:
2006-02-25  David Zeuthen  <davidz at redhat.com>

        * libhal/libhal.[ch]: Convert doc comments from Doxygen to gtk-doc

        * libhal-storage/libhal-storage.[ch]: Convert doc comments from
        Doxygen to gtk-doc (not completely done)

        * doc/api/hal-docs.xml: New file

        * doc/api/Doxyfile.in: Remove

        * doc/api/Makefile.am: Use gtk-doc instead of Doxygen

        * configure.in: Various cleanups; use gtk-doc instead of Doxygen

        * autogen.sh: Pass --enable-gtk-doc to configure.

        * acinclude.m4: Add GTK_DOC_CHECK, from cairo, thanks.



Index: ChangeLog
===================================================================
RCS file: /cvs/hal/hal/ChangeLog,v
retrieving revision 1.831
retrieving revision 1.832
diff -u -d -r1.831 -r1.832
--- ChangeLog	25 Feb 2006 16:32:28 -0000	1.831
+++ ChangeLog	25 Feb 2006 20:38:23 -0000	1.832
@@ -1,5 +1,24 @@
 2006-02-25  David Zeuthen  <davidz at redhat.com>
 
+	* libhal/libhal.[ch]: Convert doc comments from Doxygen to gtk-doc
+
+	* libhal-storage/libhal-storage.[ch]: Convert doc comments from
+	Doxygen to gtk-doc (not completely done)
+
+	* doc/api/hal-docs.xml: New file
+
+	* doc/api/Doxyfile.in: Remove
+
+	* doc/api/Makefile.am: Use gtk-doc instead of Doxygen
+
+	* configure.in: Various cleanups; use gtk-doc instead of Doxygen
+
+	* autogen.sh: Pass --enable-gtk-doc to configure.
+
+	* acinclude.m4: Add GTK_DOC_CHECK, from cairo, thanks.
+
+2006-02-25  David Zeuthen  <davidz at redhat.com>
+
 	* hal-policy.pc.in: New file
 
 	* libhal-policy/libhal-policy-test.c: New file

Index: acinclude.m4
===================================================================
RCS file: /cvs/hal/hal/acinclude.m4,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- acinclude.m4	22 Dec 2003 14:07:48 -0000	1.2
+++ acinclude.m4	25 Feb 2006 20:38:23 -0000	1.3
@@ -9,7 +9,7 @@
 dnl AS_AC_EXPAND(SYSCONFDIR, $sysconfdir)
 dnl will set SYSCONFDIR to /usr/local/etc if prefix=/usr/local
 
-AC_DEFUN(AS_AC_EXPAND,
+AC_DEFUN([AS_AC_EXPAND],
 [
   EXP_VAR=[$1]
   FROM_VAR=[$2]
@@ -43,3 +43,55 @@
   prefix=$prefix_save
   exec_prefix=$exec_prefix_save
 ])
+
+dnl GTK_DOC_CHECK borrowed from cairo, thanks!
+
+dnl Usage:
+dnl   GTK_DOC_CHECK([minimum-gtk-doc-version])
+AC_DEFUN([GTK_DOC_CHECK],
+[
+  AC_BEFORE([AC_PROG_LIBTOOL],[$0])dnl setup libtool first
+  AC_BEFORE([AM_PROG_LIBTOOL],[$0])dnl setup libtool first
+  dnl for overriding the documentation installation directory
+  AC_ARG_WITH(html-dir,
+    AC_HELP_STRING([--with-html-dir=PATH], [path to installed docs]),,
+    [with_html_dir='${datadir}/gtk-doc/html'])
+  HTML_DIR="$with_html_dir"
+  AC_SUBST(HTML_DIR)
+
+  dnl enable/disable documentation building
+  AC_ARG_ENABLE(gtk-doc,
+    AC_HELP_STRING([--enable-gtk-doc],
+                   [use gtk-doc to build documentation [default=yes]]),,
+    enable_gtk_doc=yes)
+
+  have_gtk_doc=no
+  if test x$enable_gtk_doc = xyes; then
+    if test -z "$PKG_CONFIG"; then
+      AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
+    fi
+    if test "$PKG_CONFIG" != "no" && $PKG_CONFIG --exists gtk-doc; then
+      have_gtk_doc=yes
+    fi
+
+  dnl do we want to do a version check?
+ifelse([$1],[],,
+    [gtk_doc_min_version=$1
+    if test "$have_gtk_doc" = yes; then
+      AC_MSG_CHECKING([gtk-doc version >= $gtk_doc_min_version])
+      if $PKG_CONFIG --atleast-version $gtk_doc_min_version gtk-doc; then
+        AC_MSG_RESULT(yes)
+      else
+        AC_MSG_RESULT(no)
+        have_gtk_doc=no
+      fi
+    fi
+])
+    if test "$have_gtk_doc" != yes; then
+      enable_gtk_doc=no
+    fi
+  fi
+
+  AM_CONDITIONAL(ENABLE_GTK_DOC, test x$enable_gtk_doc = xyes)
+  AM_CONDITIONAL(GTK_DOC_USE_LIBTOOL, test -n "$LIBTOOL")
+])

Index: autogen.sh
===================================================================
RCS file: /cvs/hal/hal/autogen.sh,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- autogen.sh	23 Jun 2005 14:50:04 -0000	1.3
+++ autogen.sh	25 Feb 2006 20:38:23 -0000	1.4
@@ -85,7 +85,7 @@
 glib-gettextize --force --copy                              || exit 1
 intltoolize --copy --force --automake                  || exit 1
 
-conf_flags="--enable-maintainer-mode"
+conf_flags="--enable-maintainer-mode --enable-gtk-doc"
 
 if test x$NOCONFIGURE = x; then
   echo Running $srcdir/configure $conf_flags "$@" ...

Index: configure.in
===================================================================
RCS file: /cvs/hal/hal/configure.in,v
retrieving revision 1.120
retrieving revision 1.121
diff -u -d -r1.120 -r1.121
--- configure.in	25 Feb 2006 16:32:28 -0000	1.120
+++ configure.in	25 Feb 2006 20:38:23 -0000	1.121
@@ -74,24 +74,22 @@
 # Taken from dbus
 AC_ARG_ENABLE(ansi,             [  --enable-ansi           enable -ansi -pedantic gcc flags],enable_ansi=$enableval,enable_ansi=no)
 AC_ARG_ENABLE(verbose-mode,     [  --enable-verbose-mode   support verbose debug mode],enable_verbose_mode=$enableval,enable_verbose_mode=$USE_MAINTAINER_MODE)
-AC_ARG_ENABLE(doxygen-docs,     [  --enable-doxygen-docs   build DOXYGEN documentation (requires Doxygen)],enable_doxygen_docs=$enableval,enable_doxygen_docs=auto)
-AC_ARG_ENABLE(docbook-docs,     [  --enable-docbook-docs   build DocBook documentation (requires docbook2html)],enable_docbook_docs=$enableval,enable_docbook_docs=auto)
+AC_ARG_ENABLE(docbook-docs,     [  --enable-docbook-docs   build documentation (requires docbook2html)],enable_docbook_docs=$enableval,enable_docbook_docs=auto)
 
-if test x$enable_verbose_mode = xyes; then
-    AC_DEFINE(ENABLE_VERBOSE_MODE,1,[Support a verbose mode])
-fi
+
+GTK_DOC_CHECK([1.3])
 
 # ACPI event source
-AC_ARG_ENABLE(acpi-acpid, [  --disable-acpi-acpid     Use ACPI daemon event source],acpi_acpid=no,acpi_acpid=yes)
+AC_ARG_ENABLE(acpi-acpid, [  --disable-acpi-acpid    do not use acpid event source],acpi_acpid=no,acpi_acpid=yes)
 if test "x$acpi_acpid" == "xyes" ; then
    AC_DEFINE(ACPI_ACPID,1,[Common event source of ACPI events])
 fi
 AC_SUBST(ACPI_ACPID)
 AM_CONDITIONAL(ACPI_ACPID, test x$acpi_acpid != xyes)
 
-AC_ARG_ENABLE(acpi-proc, [  --disable-acpi-proc      Use ACPI kernel-interface directly(the kernel supports only one listener)],acpi_proc=no,acpi_proc=yes)
+AC_ARG_ENABLE(acpi-proc, [  --disable-acpi-proc     do not use acpi kernel interface directly],acpi_proc=no,acpi_proc=yes)
 if test "x$acpi_proc" == "xyes" ; then
-   AC_DEFINE(ACPI_PROC,1,[Direct kernel connection for ACPI events, the kernel interface is exclusiv to one user only])
+   AC_DEFINE(ACPI_PROC,1,[Direct kernel connection for ACPI events, the kernel interface is exclusive to one user only])
 fi
 AC_SUBST(ACPI_PROC)
 AM_CONDITIONAL(ACPI_PROC, test x$acpi_proc == xyes)
@@ -184,7 +182,7 @@
 PKG_CHECK_MODULES(PACKAGE, [$pkg_modules])
 
 EXPAT_LIB=""
-AC_ARG_WITH(expat, [  --with-expat=<dir>      Use expat from here],
+AC_ARG_WITH(expat, [  --with-expat=<dir>      ese expat from here],
                       [
                       expat=$withval
                       CPPFLAGS="$CPPFLAGS -I$withval/include"
@@ -207,7 +205,7 @@
 
 
 
-AC_ARG_WITH(backend, [  --with-backend=<name>   Backend to use (linux2/solaris/dummy)],
+AC_ARG_WITH(backend, [  --with-backend=<name>   backend to use (linux2/solaris/dummy)],
                       [
                       backend=$withval
                       ]
@@ -245,37 +243,6 @@
 AC_SUBST(GLIB_CFLAGS)
 AC_SUBST(GLIB_LIBS)
 
-### All this also from dbus
-
-### Doxygen Documentation
-
-AC_PATH_PROG(DOXYGEN, doxygen, no)
-
-AC_MSG_CHECKING([whether to build Doxygen documentation])
-
-if test x$DOXYGEN = xno ; then
-    have_doxygen=no
-else
-    have_doxygen=yes
-fi
-
-if test x$enable_doxygen_docs = xauto ; then
-    if test x$have_doxygen = xno ; then
-        enable_doxygen_docs=no
-    else
-        enable_doxygen_docs=yes
-    fi
-fi
-
-if test x$enable_doxygen_docs = xyes; then
-    if test x$have_doxygen = xno; then
-	AC_MSG_ERROR([Building Doxygen docs explicitly required, but Doxygen not found])
-    fi
-fi
-
-AM_CONDITIONAL(DOXYGEN_DOCS_ENABLED, test x$enable_doxygen_docs = xyes)
-AC_MSG_RESULT(yes)
-
 # Check for BLKGETSIZE64
 AC_CHECK_TYPE(pgoff_t, ,
               [AC_DEFINE(pgoff_t, unsigned long, [Index into the pagecache])],
@@ -388,7 +355,7 @@
 AC_DEFINE_UNQUOTED(HALD_PID_FILE, "$HALD_PID_FILE", [pid file])
 
 # documentation target
-AC_ARG_WITH(doc-dir,   [  --with-doc-dir=[dirname] directory to install documentation])
+AC_ARG_WITH(doc-dir,   [  --with-doc-dir=[dirname]  directory to install documentation])
 if ! test -z "$with_doc_dir"; then
    DOCDIR=$with_doc_dir
 else
@@ -445,7 +412,6 @@
 fdi/policy/30user/Makefile
 doc/Makefile
 doc/api/Makefile
-doc/api/Doxyfile
 doc/conf/Makefile
 doc/spec/Makefile
 doc/spec/hal-spec.xml
@@ -460,36 +426,34 @@
                     HAL $VERSION
                   ==============
 
-        prefix:                   ${prefix}
-        libdir:                   ${LIBDIR}
-        libexecdir:               ${LIBEXECDIR}
-        bindir:                   ${BINDIR}
-        sbindir:                  ${SBINDIR}
-        datadir:                  ${DATADIR}
-        sysconfdir:               ${SYSCONFDIR}
-        localstatedir:            ${LOCALSTATEDIR}
-        docdir:                   ${DOCDIR}
-        dbus-1 system.d dir:      ${DBUS_SYS_DIR}
-        pci.ids, usb.ids dir:     ${HWDATA_DIR}
-
-        compiler:                 ${CC}
-        cflags:                   ${CFLAGS}
-        cppflags:                 ${CPPFLAGS}
-        Doxygen:                  ${DOXYGEN}
-        DocBook:                  ${DOCBOOK}
-        User for HAL:             ${HAL_USER}
-        Group for HAL:            ${HAL_GROUP}
-        hald pidfile:             ${HALD_PID_FILE}
-        hald backend:             ${HALD_BACKEND}
-        acpi proc support:        ${acpi_proc}
-        acpi daemon support:      ${acpi_acpid}
+        prefix:                     ${prefix}
+        libdir:                     ${LIBDIR}
+        libexecdir:                 ${LIBEXECDIR}
+        bindir:                     ${BINDIR}
+        sbindir:                    ${SBINDIR}
+        datadir:                    ${DATADIR}
+        sysconfdir:                 ${SYSCONFDIR}
+        localstatedir:              ${LOCALSTATEDIR}
+        docdir:                     ${DOCDIR}
+        dbus-1 system.d dir:        ${DBUS_SYS_DIR}
+        pci.ids, usb.ids dir:       ${HWDATA_DIR}
 
-        use libusb (for usb-csr): ${USE_LIBUSB}
+        compiler:                   ${CC}
+        cflags:                     ${CFLAGS}
+        cppflags:                   ${CPPFLAGS}
+        DocBook:                    ${DOCBOOK}
+        User for HAL:               ${HAL_USER}
+        Group for HAL:              ${HAL_GROUP}
+        hald pidfile:               ${HALD_PID_FILE}
+        hald backend:               ${HALD_BACKEND}
+        use acpi kernel interface:  ${acpi_proc}
+        use acpid interface:        ${acpi_acpid}
+        use libusb:                 ${USE_LIBUSB}
 
-        Maintainer mode:          ${USE_MAINTAINER_MODE}
-        Building verbose mode:    ${enable_verbose_mode}
-        Building Doxygen docs:    ${enable_doxygen_docs}
-        Building docs:            ${enable_docbook_docs}
+        Maintainer mode:            ${USE_MAINTAINER_MODE}
+        Building verbose mode:      ${enable_verbose_mode}
+        Building api docs:          ${enable_gtk_doc}
+        Building docs:              ${enable_docbook_docs}
 "
 
 if test x$enable_verbose_mode = xyes; then
@@ -511,7 +475,7 @@
 
 echo "NOTE: For development, use run-hald.sh and debug-hald.sh scripts in hald/ to "
 echo "      use programs (callouts, probers, addons) and device information files "
-echo "      from build directories."
-echo "      (You may still need 'make install' to install the udev rule to receive events)"
+echo "      from build directories. You may still need 'make install' to"
+echo "      install the udev rule to receive events from udev."
 echo
 




More information about the hal-commit mailing list