diff options
author | Karel Zak | 2011-06-09 21:59:52 +0200 |
---|---|---|
committer | Karel Zak | 2011-06-09 21:59:52 +0200 |
commit | 2aefc0a8f267ddb57804755af9095d3cd5ceb0d7 (patch) | |
tree | 8601dca144fccbb9b6a895708868a520caccaddf /libmount/docs | |
parent | build-sys: use top-level directory for libuuid rather than shlibs/uuid (diff) | |
download | kernel-qcow2-util-linux-2aefc0a8f267ddb57804755af9095d3cd5ceb0d7.tar.gz kernel-qcow2-util-linux-2aefc0a8f267ddb57804755af9095d3cd5ceb0d7.tar.xz kernel-qcow2-util-linux-2aefc0a8f267ddb57804755af9095d3cd5ceb0d7.zip |
build-sys: use top-level directory for libmount rather than shlibs/mount
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libmount/docs')
-rw-r--r-- | libmount/docs/.gitignore | 17 | ||||
-rw-r--r-- | libmount/docs/Makefile.am | 101 | ||||
-rw-r--r-- | libmount/docs/libmount-docs.xml | 63 | ||||
-rw-r--r-- | libmount/docs/libmount-sections.txt | 226 | ||||
-rw-r--r-- | libmount/docs/libmount.types | 0 | ||||
-rw-r--r-- | libmount/docs/version.xml.in | 1 |
6 files changed, 408 insertions, 0 deletions
diff --git a/libmount/docs/.gitignore b/libmount/docs/.gitignore new file mode 100644 index 000000000..917c84810 --- /dev/null +++ b/libmount/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/libmount/docs/Makefile.am b/libmount/docs/Makefile.am new file mode 100644 index 000000000..3e087d294 --- /dev/null +++ b/libmount/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)/libmount.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 + +# 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/libmount/docs/libmount-docs.xml b/libmount/docs/libmount-docs.xml new file mode 100644 index 000000000..75802a282 --- /dev/null +++ b/libmount/docs/libmount-docs.xml @@ -0,0 +1,63 @@ +<?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 <kzak@redhat.com></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 package since version 2.18 and is +available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/. + </para> + </partintro> + </part> + + <part> + <title>High-level API</title> + <xi:include href="xml/context.xml"/> + </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/optmap.xml"/> + </part> + <part> + <title>Mtab management</title> + <xi:include href="xml/lock.xml"/> + <xi:include href="xml/update.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/libmount/docs/libmount-sections.txt b/libmount/docs/libmount-sections.txt new file mode 100644 index 000000000..f79374d90 --- /dev/null +++ b/libmount/docs/libmount-sections.txt @@ -0,0 +1,226 @@ +<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_get_fstab_path +mnt_get_mtab_path +mnt_has_regular_mtab +mnt_mangle +mnt_match_fstype +mnt_match_options +mnt_unmangle +</SECTION> + +<SECTION> +<FILE>cache</FILE> +mnt_cache_device_has_tag +mnt_cache_find_tag_value +mnt_cache_read_tags +mnt_free_cache +mnt_get_fstype +mnt_new_cache +mnt_resolve_path +mnt_resolve_spec +mnt_resolve_tag +</SECTION> + +<SECTION> +<FILE>optstr</FILE> +mnt_optstr_append_option +mnt_optstr_apply_flags +mnt_optstr_get_flags +mnt_optstr_get_option +mnt_optstr_get_options +mnt_optstr_next_option +mnt_optstr_prepend_option +mnt_optstr_remove_option +mnt_optstr_set_option +mnt_split_optstr +</SECTION> + +<SECTION> +<FILE>iter</FILE> +mnt_free_iter +mnt_iter_get_direction +mnt_new_iter +mnt_reset_iter +</SECTION> + +<SECTION> +<FILE>optmap</FILE> +mnt_get_builtin_optmap +</SECTION> + +<SECTION> +<FILE>lock</FILE> +mnt_free_lock +mnt_lock_file +mnt_new_lock +mnt_unlock_file +</SECTION> + +<SECTION> +<FILE>fs</FILE> +mnt_copy_fs +mnt_free_fs +mnt_free_mntent +mnt_fs_append_attributes +mnt_fs_append_fs_options +mnt_fs_append_options +mnt_fs_append_user_options +mnt_fs_append_vfs_options +mnt_fs_get_attribute +mnt_fs_get_attributes +mnt_fs_get_bindsrc +mnt_fs_get_devno +mnt_fs_get_freq +mnt_fs_get_fs_options +mnt_fs_get_fstype +mnt_fs_get_id +mnt_fs_get_option +mnt_fs_get_parent_id +mnt_fs_get_passno +mnt_fs_get_root +mnt_fs_get_source +mnt_fs_get_srcpath +mnt_fs_get_tag +mnt_fs_get_target +mnt_fs_get_userdata +mnt_fs_get_user_options +mnt_fs_get_vfs_options +mnt_fs_match_fstype +mnt_fs_match_options +mnt_fs_match_source +mnt_fs_match_target +mnt_fs_prepend_attributes +mnt_fs_prepend_fs_options +mnt_fs_prepend_options +mnt_fs_prepend_user_options +mnt_fs_prepend_vfs_options +mnt_fs_print_debug +mnt_fs_set_attributes +mnt_fs_set_bindsrc +mnt_fs_set_freq +mnt_fs_set_fs_options +mnt_fs_set_fstype +mnt_fs_set_options +mnt_fs_set_passno +mnt_fs_set_root +mnt_fs_set_source +mnt_fs_set_target +mnt_fs_set_userdata +mnt_fs_set_user_options +mnt_fs_set_vfs_options +mnt_fs_strdup_options +mnt_new_fs +mnt_fs_to_mntent +</SECTION> + +<SECTION> +<FILE>tab</FILE> +mnt_free_table +mnt_new_table +mnt_new_table_from_dir +mnt_new_table_from_file +mnt_table_add_fs +mnt_table_find_next_fs +mnt_table_find_pair +mnt_table_find_source +mnt_table_find_srcpath +mnt_table_find_tag +mnt_table_find_target +mnt_table_get_cache +mnt_table_get_name +mnt_table_get_nents +mnt_table_get_root_fs +mnt_table_next_child_fs +mnt_table_next_fs +mnt_table_parse_file +mnt_table_parse_fstab +mnt_table_parse_mtab +mnt_table_parse_stream +mnt_table_remove_fs +mnt_table_set_cache +mnt_table_set_iter +mnt_table_set_parser_errcb +</SECTION> + +<SECTION> +<FILE>update</FILE> +mnt_free_update +mnt_new_update +mnt_update_force_rdonly +mnt_update_get_filename +mnt_update_get_fs +mnt_update_get_mflags +mnt_update_is_ready +mnt_update_set_fs +mnt_update_table +</SECTION> + +<SECTION> +<FILE>context</FILE> +mnt_context_init_helper +mnt_context_helper_setopt +mnt_context_append_options +mnt_context_apply_fstab +mnt_context_disable_canonicalize +mnt_context_disable_helpers +mnt_context_disable_mtab +mnt_context_do_mount +mnt_context_do_umount +mnt_context_enable_fake +mnt_context_enable_force +mnt_context_enable_lazy +mnt_context_enable_loopdel +mnt_context_enable_rdonly_umount +mnt_context_enable_sloppy +mnt_context_enable_verbose +mnt_context_finalize_mount +mnt_context_finalize_umount +mnt_context_get_cache +mnt_context_get_fs +mnt_context_get_fstab +mnt_context_get_fstype +mnt_context_get_lock +mnt_context_get_mflags +mnt_context_get_mtab +mnt_context_get_source +mnt_context_get_status +mnt_context_get_target +mnt_context_get_user_mflags +mnt_context_is_restricted +mnt_context_mount +mnt_context_prepare_mount +mnt_context_prepare_umount +mnt_context_set_cache +mnt_context_set_fs +mnt_context_set_fstab +mnt_context_set_fstype +mnt_context_set_fstype_pattern +mnt_context_set_mflags +mnt_context_set_mountdata +mnt_context_set_options +mnt_context_set_options_pattern +mnt_context_set_optsmode +mnt_context_set_source +mnt_context_set_target +mnt_context_set_user_mflags +mnt_context_strerror +mnt_context_umount +mnt_free_context +mnt_new_context +mnt_reset_context +</SECTION> + diff --git a/libmount/docs/libmount.types b/libmount/docs/libmount.types new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/libmount/docs/libmount.types diff --git a/libmount/docs/version.xml.in b/libmount/docs/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/libmount/docs/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |