summaryrefslogtreecommitdiffstats
path: root/shlibs/mount/docs
diff options
context:
space:
mode:
Diffstat (limited to 'shlibs/mount/docs')
-rw-r--r--shlibs/mount/docs/.gitignore17
-rw-r--r--shlibs/mount/docs/Makefile.am101
-rw-r--r--shlibs/mount/docs/libmount-docs.xml60
-rw-r--r--shlibs/mount/docs/libmount-sections.txt182
-rw-r--r--shlibs/mount/docs/libmount.types0
-rw-r--r--shlibs/mount/docs/version.xml.in1
6 files changed, 361 insertions, 0 deletions
diff --git a/shlibs/mount/docs/.gitignore b/shlibs/mount/docs/.gitignore
new file mode 100644
index 000000000..917c84810
--- /dev/null
+++ b/shlibs/mount/docs/.gitignore
@@ -0,0 +1,17 @@
+*.args
+*.bak
+*-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/mount/docs/Makefile.am b/shlibs/mount/docs/Makefile.am
new file mode 100644
index 000000000..a50390b07
--- /dev/null
+++ b/shlibs/mount/docs/Makefile.am
@@ -0,0 +1,101 @@
+include $(top_srcdir)/config/include-Makefile.am
+
+## 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=libmount
+
+# 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 mount
+
+# 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=
+
+# 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=$(ul_libmount_incdir)/mount.h
+CFILE_GLOB=$(ul_libmount_srcdir)/*.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=mountP.h list.h partitions.h superblocks.h topology.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 = $(builddir)/version.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)/config/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/mount/docs/libmount-docs.xml b/shlibs/mount/docs/libmount-docs.xml
new file mode 100644
index 000000000..c1371d613
--- /dev/null
+++ b/shlibs/mount/docs/libmount-docs.xml
@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>libmount Reference Manual</title>
+ <releaseinfo>for libmount version &version;</releaseinfo>
+ <copyright>
+ <year>2010</year>
+ <holder>Karel Zak &lt;kzak@redhat.com&gt;</holder>
+ </copyright>
+ </bookinfo>
+
+ <part id="gtk">
+ <title>libmount Overview</title>
+ <partintro>
+ <para>
+The libmount library is used to parse /etc/fstab, /etc/mtab and
+/proc/self/mountinfo files, manage the mtab file, evaluate mount options, etc.
+ </para>
+ <para>
+The library is part of the util-linux-ng package since version 2.18 and is
+available from ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.
+ </para>
+ </partintro>
+ </part>
+
+ <part>
+ <title>Files parsing</title>
+ <xi:include href="xml/tab.xml"/>
+ <xi:include href="xml/fs.xml"/>
+ </part>
+ <part>
+ <title>Mount options</title>
+ <xi:include href="xml/optstr.xml"/>
+ <xi:include href="xml/optls.xml"/>
+ <xi:include href="xml/optent.xml"/>
+ <xi:include href="xml/optmap.xml"/>
+ </part>
+ <part>
+ <title>Mtab management</title>
+ <xi:include href="xml/lock.xml"/>
+ </part>
+ <part>
+ <title>Misc</title>
+ <xi:include href="xml/init.xml"/>
+ <xi:include href="xml/cache.xml"/>
+ <xi:include href="xml/iter.xml"/>
+ <xi:include href="xml/utils.xml"/>
+ <xi:include href="xml/version.xml"/>
+ </part>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+</book>
diff --git a/shlibs/mount/docs/libmount-sections.txt b/shlibs/mount/docs/libmount-sections.txt
new file mode 100644
index 000000000..3c4a9f776
--- /dev/null
+++ b/shlibs/mount/docs/libmount-sections.txt
@@ -0,0 +1,182 @@
+<SECTION>
+<FILE>init</FILE>
+mnt_init_debug
+</SECTION>
+
+<SECTION>
+<FILE>version</FILE>
+mnt_parse_version_string
+mnt_get_library_version
+</SECTION>
+
+<SECTION>
+<FILE>utils</FILE>
+mnt_fstype_is_netfs
+mnt_fstype_is_pseudofs
+mnt_open_device
+mnt_match_fstype
+mnt_match_options
+</SECTION>
+
+<SECTION>
+<FILE>cache</FILE>
+mnt_cache
+mnt_new_cache
+mnt_free_cache
+mnt_cache_find_path
+mnt_cache_find_tag
+mnt_cache_read_tags
+mnt_cache_device_has_tag
+mnt_cache_find_tag_value
+mnt_resolve_path
+mnt_resolve_tag
+mnt_resolve_spec
+</SECTION>
+
+<SECTION>
+<FILE>optstr</FILE>
+mnt_optstr_next_option
+mnt_optstr_append_option
+mnt_optstr_get_option
+mnt_optstr_set_option
+mnt_optstr_remove_option
+</SECTION>
+
+<SECTION>
+<FILE>iter</FILE>
+mnt_iter
+mnt_new_iter
+mnt_free_iter
+mnt_reset_iter
+mnt_iter_get_direction
+</SECTION>
+
+<SECTION>
+<FILE>optmap</FILE>
+mnt_optmap
+mnt_get_builtin_optmap
+</SECTION>
+
+<SECTION>
+<FILE>optent</FILE>
+mnt_optent
+mnt_optent_get_map
+mnt_optent_get_mapent
+mnt_optent_get_type
+mnt_optent_set_value
+mnt_optent_has_value
+mnt_optent_require_value
+mnt_optent_is_inverted
+mnt_optent_strtoul_value
+mnt_optent_strtol_value
+mnt_optent_strtoull_value
+mnt_optent_get_value
+mnt_optent_strlen_value
+mnt_optent_snprintf_value
+mnt_optent_dup_value
+mnt_optent_get_name
+mnt_optent_get_mask
+mnt_optent_get_id
+mnt_optent_get_flag
+mnt_optent_is_unknown
+mnt_optent_print_debug
+</SECTION>
+
+<SECTION>
+<FILE>optls</FILE>
+mnt_optls
+mnt_new_optls
+mnt_free_optls
+mnt_optls_add_map
+mnt_optls_add_builtin_map
+mnt_optls_add_option
+mnt_optls_parse_optstr
+mnt_optls_remove_option
+mnt_optls_remove_option_by_flags
+mnt_optls_remove_option_by_iflags
+mnt_optls_next_option
+mnt_optls_get_option
+mnt_optls_get_ids
+mnt_optls_create_mountflags
+mnt_optls_create_mountdata
+mnt_optls_create_mtab_optstr
+mnt_optls_create_userspace_optstr
+mnt_optls_print_debug
+</SECTION>
+
+
+<SECTION>
+<FILE>lock</FILE>
+mnt_lock
+mnt_new_lock
+mnt_free_lock
+mnt_lock_get_lockfile
+mnt_lock_get_linkfile
+mnt_unlock_file
+mnt_lock_file
+</SECTION>
+
+
+<SECTION>
+<FILE>fs</FILE>
+mnt_fs
+mnt_new_fs
+mnt_free_fs
+mnt_fs_get_userdata
+mnt_fs_set_userdata
+mnt_fs_get_source
+mnt_fs_set_source
+mnt_fs_get_srcpath
+mnt_fs_get_tag
+mnt_fs_get_target
+mnt_fs_set_target
+mnt_fs_get_fstype
+mnt_fs_set_fstype
+mnt_fs_get_optstr
+mnt_fs_set_optstr
+mnt_fs_get_optfs
+mnt_fs_get_optvfs
+mnt_fs_get_freq
+mnt_fs_set_freq
+mnt_fs_get_passno
+mnt_fs_set_passno
+mnt_fs_get_id
+mnt_fs_get_parent_id
+mnt_fs_get_devno
+mnt_fs_get_option
+mnt_fs_match_target
+mnt_fs_match_source
+mnt_fs_match_fstype
+mnt_fs_match_options
+mnt_fprintf_line
+mnt_fs_fprintf
+mnt_fs_print_debug
+</SECTION>
+
+<SECTION>
+<FILE>tab</FILE>
+mnt_tab
+mnt_new_tab_from_file
+mnt_tab_parse_file
+mnt_tab_strerror
+mnt_tab_get_nerrs
+mnt_new_tab
+mnt_free_tab
+mnt_tab_get_nents
+mnt_tab_set_cache
+mnt_tab_get_cache
+mnt_tab_get_name
+mnt_tab_add_fs
+mnt_tab_remove_fs
+mnt_tab_next_fs
+mnt_tab_next_child_fs
+mnt_tab_get_root_fs
+mnt_tab_set_iter
+mnt_tab_find_target
+mnt_tab_find_srcpath
+mnt_tab_find_tag
+mnt_tab_find_source
+mnt_tab_find_next_fs
+mnt_tab_fprintf
+mnt_tab_update_file
+</SECTION>
diff --git a/shlibs/mount/docs/libmount.types b/shlibs/mount/docs/libmount.types
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/shlibs/mount/docs/libmount.types
diff --git a/shlibs/mount/docs/version.xml.in b/shlibs/mount/docs/version.xml.in
new file mode 100644
index 000000000..d78bda934
--- /dev/null
+++ b/shlibs/mount/docs/version.xml.in
@@ -0,0 +1 @@
+@VERSION@