From 1e018c1571ff80b7750cadeb591da36d75c51083 Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Wed, 16 Sep 2009 21:25:38 +0200 Subject: [PATCH] libblkid: gtkdocize (API docs generated by gtk-docs) Signed-off-by: Karel Zak --- .gitignore | 1 + Makefile.am | 3 +- autogen.sh | 17 ++- configure.ac | 5 + shlibs/blkid/Makefile.am | 4 + shlibs/blkid/docs/.gitignore | 16 +++ shlibs/blkid/docs/Makefile.am | 99 +++++++++++++++++ shlibs/blkid/docs/libblkid-config.xml | 57 ++++++++++ shlibs/blkid/docs/libblkid-docs.xml | 69 ++++++++++++ shlibs/blkid/docs/libblkid-sections.txt | 140 ++++++++++++++++++++++++ shlibs/blkid/docs/libblkid.types | 0 shlibs/blkid/docs/version.xml.in | 1 + 12 files changed, 410 insertions(+), 2 deletions(-) create mode 100644 shlibs/blkid/docs/.gitignore create mode 100644 shlibs/blkid/docs/Makefile.am create mode 100644 shlibs/blkid/docs/libblkid-config.xml create mode 100644 shlibs/blkid/docs/libblkid-docs.xml create mode 100644 shlibs/blkid/docs/libblkid-sections.txt create mode 100644 shlibs/blkid/docs/libblkid.types create mode 100644 shlibs/blkid/docs/version.xml.in diff --git a/.gitignore b/.gitignore index 9f6d8b85f..f5d5bc5c5 100644 --- a/.gitignore +++ b/.gitignore @@ -34,6 +34,7 @@ missing libtool .deps .libs +gtk-doc.make # libtool-2 stuff -- temporary added to repository (because libtool-2.x.x is # still not in avaialable in many Linux distributions) diff --git a/Makefile.am b/Makefile.am index 0c8fb693d..9899a9937 100644 --- a/Makefile.am +++ b/Makefile.am @@ -67,4 +67,5 @@ ENABLE_ALL = --enable-static-programs --with-fsprobe=builtin \ --enable-elvtune --enable-init --enable-kill --enable-last \ --enable-mesg --enable-partx --enable-raw --enable-rdev --enable-reset \ --enable-login-utils --enable-write --enable-arch --enable-mount -DISTCHECK_CONFIGURE_FLAGS = --disable-use-tty-group $(ENABLE_ALL) + +DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --disable-use-tty-group $(ENABLE_ALL) diff --git a/autogen.sh b/autogen.sh index 61b7bd96b..8edee0b9e 100755 --- a/autogen.sh +++ b/autogen.sh @@ -12,6 +12,7 @@ test -z "$srcdir" && srcdir=. THEDIR=`pwd` cd $srcdir DIE=0 +HAS_GTKDOC=1 (autopoint --version) < /dev/null > /dev/null 2>&1 || { echo @@ -53,6 +54,12 @@ DIE=0 echo "or see http://www.gnu.org/software/autoheader" DIE=1 } + +(gtkdocize --version) < /dev/null > /dev/null 2>&1 || { + echo "WARNING: You must have gtk-doc installed to generate libblkid API docs." + HAS_GTKDOC=0 +} + if test "$DIE" -eq 1; then exit 1 fi @@ -76,7 +83,10 @@ echo " autoconf: $(autoconf --version | head -1)" echo " autoheader: $(autoheader --version | head -1)" echo " automake: $(automake --version | head -1)" #echo " libtoolize: $(libtoolize --version | head -1)" -echo + +if test "$HAS_GTKDOC" -eq 1; then + echo " gtkdocize: $(gtkdocize --version | head -1)" +fi set -e autopoint --force $AP_OPTS @@ -84,6 +94,11 @@ autopoint --force $AP_OPTS aclocal -I m4 $AL_OPTS autoconf $AC_OPTS autoheader $AH_OPTS + +if test "$HAS_GTKDOC" -eq 1; then + gtkdocize +fi + automake --add-missing $AM_OPTS cd $THEDIR diff --git a/configure.ac b/configure.ac index bb2d825df..9944270ec 100644 --- a/configure.ac +++ b/configure.ac @@ -11,6 +11,9 @@ AC_CONFIG_SRCDIR(mount/mount.c) AC_PREFIX_DEFAULT([/usr]) +GTK_DOC_CHECK(1.10) +AC_PATH_PROG([XSLTPROC], [xsltproc]) + dnl version details from .[-] PACKAGE_VERSION_MAJOR=$(echo $PACKAGE_VERSION | awk -F. '{print $1}') PACKAGE_VERSION_MINOR=$(echo $PACKAGE_VERSION | awk -F. '{print $2}' \ @@ -920,6 +923,8 @@ po/Makefile.in schedutils/Makefile shlibs/blkid/blkid.pc shlibs/blkid/Makefile +shlibs/blkid/docs/Makefile +shlibs/blkid/docs/version.xml shlibs/blkid/src/Makefile shlibs/blkid/src/superblocks/Makefile shlibs/blkid/src/topology/Makefile diff --git a/shlibs/blkid/Makefile.am b/shlibs/blkid/Makefile.am index 6ad42d8c3..041fa79b4 100644 --- a/shlibs/blkid/Makefile.am +++ b/shlibs/blkid/Makefile.am @@ -2,6 +2,10 @@ include $(top_srcdir)/config/include-Makefile.am SUBDIRS = src samples +if ENABLE_GTK_DOC +SUBDIRS += docs +endif + # pkg-config stuff pkgconfigdir = $(usrlib_execdir)/pkgconfig pkgconfig_DATA = blkid.pc diff --git a/shlibs/blkid/docs/.gitignore b/shlibs/blkid/docs/.gitignore new file mode 100644 index 000000000..f4879a986 --- /dev/null +++ b/shlibs/blkid/docs/.gitignore @@ -0,0 +1,16 @@ +*.args +*-decl-list.txt +*-decl.txt +*.hierarchy +html/* +*.interfaces +*-overrides.txt +*.prerequisites +*.signals +*.stamp +tmpl/* +*-undeclared.txt +*-undocumented.txt +*-unused.txt +version.xml +xml/* diff --git a/shlibs/blkid/docs/Makefile.am b/shlibs/blkid/docs/Makefile.am new file mode 100644 index 000000000..b8ea54e48 --- /dev/null +++ b/shlibs/blkid/docs/Makefile.am @@ -0,0 +1,99 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.10 at least. +AUTOMAKE_OPTIONS = 1.10 + +# 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=libblkid + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# 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=../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 --name-space blkid + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS=--path=$(abs_srcdir) --path=$(abs_builddir) + +# 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)/shlibs/blkid/src/blkid.h +CFILE_GLOB=$(top_srcdir)/shlibs/blkid/src/*.c + +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files to ignore when scanning. Use base file name, no paths +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=blkidP.h list.h partitions.h sublks.h toplgy.h aix.h dos.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 = version.xml libblkid-config.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +if ENABLE_GTK_DOC +#TESTS_ENVIRONMENT = cd $(srcsrc) +#TESTS = $(GTKDOC_CHECK) +endif diff --git a/shlibs/blkid/docs/libblkid-config.xml b/shlibs/blkid/docs/libblkid-config.xml new file mode 100644 index 000000000..89fbb7f17 --- /dev/null +++ b/shlibs/blkid/docs/libblkid-config.xml @@ -0,0 +1,57 @@ + + +]> + + +Config file +3 +LIBBLKID Library + + + +Config file +config file to control paths and basic library behavior + + + +Description + +The standard location of the +/etc/blkid.conf config file can be overridden by the environment variable +BLKID_CONF. The following options control the libblkid library: + + + + + SEND_UEVENT=yes|not + + Sends uevent when /dev/disk/by-{label,uuid}/ + symlink does not match with LABEL or UUID on the device. Default is "yes". + + + + CACHE_FILE=path + + Overrides the standard location of the cache file. This + setting can be overridden by the environment variable BLKID_FILE. Default is + /etc/blkid.tab. + + + + EVALUATE=method + + Defines LABEL and UUID evaluation method(s). Currently, + the libblkid library supports "udev" and "scan" methods. More than one methods + may be specified in a comma separated list. Default is "udev,scan". The "udev" + method uses udev /dev/disk/by-* symlinks and the "scan" method scans all + block devices from the /proc/partitions file. + + + + + + + diff --git a/shlibs/blkid/docs/libblkid-docs.xml b/shlibs/blkid/docs/libblkid-docs.xml new file mode 100644 index 000000000..eafc54dcd --- /dev/null +++ b/shlibs/blkid/docs/libblkid-docs.xml @@ -0,0 +1,69 @@ + + +]> + + + libblkid Reference Manual + for libblkid version &version; + + 2009 + Karel Zak <kzak@redhat.com> + + + + + libblkid Overview + + +The libblkid library is used to identify block devices (disks) as to their +content (e.g. filesystem type, partitions) as well as extracting additional +information such as filesystem labels/volume names, partitions, unique +identifiers/serial numbers, etc. A common use is to allow use of LABEL= and +UUID= tags instead of hard-coding specific block device names into +configuration files. + + +The libblkid librray +was written by Andreas Dilger for the ext2 filesystem utilties, with input +from Ted Ts'o. The library was subsequently heavily modified by Ted Ts'o. + + +The low-level probing code, topology and partitions support was written +by Karel Zak. Currently, the library is mainatned by Karel Zak. + + +The library is part of the util-linux-ng package since version 2.15 and is +available from ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. + + + + + + + Hihg-level + + + + + + Low-level + + + + + + + + Common utils + + + + + + API Index + + + diff --git a/shlibs/blkid/docs/libblkid-sections.txt b/shlibs/blkid/docs/libblkid-sections.txt new file mode 100644 index 000000000..4d98b160c --- /dev/null +++ b/shlibs/blkid/docs/libblkid-sections.txt @@ -0,0 +1,140 @@ +
+evaluate +blkid_evaluate_tag +
+ +
+cache +blkid_cache +blkid_gc_cache +blkid_get_cache +blkid_put_cache +blkid_probe_all +blkid_probe_all_new +blkid_verify +
+ +
+search +blkid_dev +blkid_dev_devname +blkid_dev_has_tag +blkid_dev_iterate +blkid_dev_iterate_begin +blkid_dev_iterate_end +blkid_dev_next +blkid_dev_set_search +blkid_find_dev_with_tag +blkid_get_dev +blkid_get_devname +blkid_get_tag_value +blkid_tag_iterate +blkid_tag_iterate_begin +blkid_tag_iterate_end +blkid_tag_next +
+ +
+lowprobe +blkid_probe +blkid_free_probe +blkid_new_probe +blkid_probe_get_devno +blkid_probe_get_sectorsize +blkid_probe_get_size +blkid_probe_set_device +blkid_reset_probe +
+ +
+lowprobe-tags +blkid_do_fullprobe +blkid_do_probe +blkid_do_safeprobe + +blkid_probe_get_value +blkid_probe_has_value +blkid_probe_lookup_value +blkid_probe_numof_values +
+ +
+partitions +blkid_partlist +blkid_partition +blkid_parttable +blkid_probe_enable_partitions +blkid_probe_set_partitions_flags + +blkid_known_pttype + +blkid_partition_get_name +blkid_partition_get_partno +blkid_partition_get_size +blkid_partition_get_start +blkid_partition_get_table +blkid_partition_get_type +blkid_partition_get_uuid +blkid_partition_is_extended +blkid_partition_is_logical +blkid_partition_is_primary + +blkid_partlist_get_partition +blkid_partlist_numof_partitions + +blkid_parttable_get_offset +blkid_parttable_get_parent +blkid_parttable_get_type + +blkid_probe_get_partitions +
+ +
+superblocks +blkid_probe_enable_superblocks + +blkid_known_fstype + +blkid_probe_filter_superblocks_type +blkid_probe_filter_superblocks_usage +blkid_probe_invert_superblocks_filter +blkid_probe_reset_superblocks_filter +blkid_probe_set_superblocks_flags + +blkid_probe_reset_filter +blkid_probe_filter_types +blkid_probe_filter_usage +blkid_probe_invert_filter +blkid_probe_set_request +
+ +
+topology +blkid_topology +blkid_probe_enable_topology + +blkid_probe_get_topology +blkid_topology_get_alignment_offset +blkid_topology_get_minimum_io_size +blkid_topology_get_optimal_io_size +
+ +
+encode +blkid_encode_string +blkid_safe_string +
+ +
+misc +blkid_loff_t +blkid_devno_to_devname +blkid_devno_to_wholedisk +blkid_get_dev_size +blkid_get_library_version +blkid_parse_tag_string +blkid_parse_version_string +blkid_send_uevent +
+ + diff --git a/shlibs/blkid/docs/libblkid.types b/shlibs/blkid/docs/libblkid.types new file mode 100644 index 000000000..e69de29bb diff --git a/shlibs/blkid/docs/version.xml.in b/shlibs/blkid/docs/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/shlibs/blkid/docs/version.xml.in @@ -0,0 +1 @@ +@VERSION@