diff options
Diffstat (limited to 'libblkid/docs')
| -rw-r--r-- | libblkid/docs/.gitignore | 18 | ||||
| -rw-r--r-- | libblkid/docs/Makefile.am | 95 | ||||
| -rw-r--r-- | libblkid/docs/libblkid-config.xml | 57 | ||||
| -rw-r--r-- | libblkid/docs/libblkid-docs.xml | 70 | ||||
| -rw-r--r-- | libblkid/docs/libblkid-sections.txt | 201 | ||||
| -rw-r--r-- | libblkid/docs/version.xml.in | 1 |
6 files changed, 442 insertions, 0 deletions
diff --git a/libblkid/docs/.gitignore b/libblkid/docs/.gitignore new file mode 100644 index 000000000..f91f93db7 --- /dev/null +++ b/libblkid/docs/.gitignore @@ -0,0 +1,18 @@ +*-decl-list.txt +*-decl.txt +*-overrides.txt +*-undeclared.txt +*-undocumented.txt +*-unused.txt +*.args +*.bak +*.hierarchy +*.interfaces +*.prerequisites +*.signals +*.stamp +*.types +html/* +tmpl/* +version.xml +xml/* diff --git a/libblkid/docs/Makefile.am b/libblkid/docs/Makefile.am new file mode 100644 index 000000000..dc6dd3e5e --- /dev/null +++ b/libblkid/docs/Makefile.am @@ -0,0 +1,95 @@ +## 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=--deprecated-guards="BLKID_DISABLE_DEPRECATED" + +# 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= + +# 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_builddir)/libblkid/src/blkid.h +CFILE_GLOB=$(top_srcdir)/libblkid/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 partitions.h superblocks.h \ + topology.h aix.h dos.h iso9660.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 $(srcdir)/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)/config/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in $(srcdir)/libblkid-config.xml + +# 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 += version.xml + diff --git a/libblkid/docs/libblkid-config.xml b/libblkid/docs/libblkid-config.xml new file mode 100644 index 000000000..89fbb7f17 --- /dev/null +++ b/libblkid/docs/libblkid-config.xml @@ -0,0 +1,57 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY version SYSTEM "version.xml"> +]> +<refentry id="libblkid-config"> +<refmeta> +<refentrytitle role="top_of_page" id="libblkid-config.top_of_page">Config file</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo>LIBBLKID Library</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>Config file</refname> +<refpurpose>config file to control paths and basic library behavior</refpurpose> +</refnamediv> + +<refsect1 id="libblkid-config.description" role="desc"> +<title role="desc.title">Description</title> +<para> +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: +</para> + +<variablelist role="params"> + <varlistentry> + <term>SEND_UEVENT=<parameter>yes|not</parameter></term> + <listitem><simpara> + Sends uevent when /dev/disk/by-{label,uuid}/ + symlink does not match with LABEL or UUID on the device. Default is "yes". + </simpara></listitem> + </varlistentry> + <varlistentry> + <term>CACHE_FILE=<parameter>path</parameter></term> + <listitem><simpara> + Overrides the standard location of the cache file. This + setting can be overridden by the environment variable BLKID_FILE. Default is + /etc/blkid.tab. + </simpara></listitem> + </varlistentry> + <varlistentry> + <term>EVALUATE=<parameter>method</parameter></term> + <listitem><simpara> + 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. + </simpara></listitem> + </varlistentry> +</variablelist> + +</refsect1> + +</refentry> diff --git a/libblkid/docs/libblkid-docs.xml b/libblkid/docs/libblkid-docs.xml new file mode 100644 index 000000000..1f412c105 --- /dev/null +++ b/libblkid/docs/libblkid-docs.xml @@ -0,0 +1,70 @@ +<?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>libblkid Reference Manual</title> + <releaseinfo>for libblkid version &version;</releaseinfo> + <copyright> + <year>2009-2013</year> + <holder>Karel Zak <kzak@redhat.com></holder> + </copyright> + </bookinfo> + + <part id="gtk"> + <title>libblkid Overview</title> + <partintro> + <para> +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. + </para> + <para> +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. + </para> + <para> +The low-level probing code, topology and partitions support was written +by Karel Zak. Currently, the library is mainatned by Karel Zak. + </para> + <para> +The library is part of the util-linux package since version 2.15 and is +available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/. + </para> + </partintro> + <xi:include href="xml/libblkid-config.xml"/> + </part> + + <part> + <title>High-level</title> + <xi:include href="xml/evaluate.xml"/> + <xi:include href="xml/cache.xml"/> + <xi:include href="xml/search.xml"/> + </part> + <part> + <title>Low-level</title> + <xi:include href="xml/init.xml"/> + <xi:include href="xml/lowprobe.xml"/> + <xi:include href="xml/lowprobe-tags.xml"/> + <xi:include href="xml/superblocks.xml"/> + <xi:include href="xml/partitions.xml"/> + <xi:include href="xml/topology.xml"/> + </part> + <part> + <title>Common utils</title> + <xi:include href="xml/encode.xml"/> + <xi:include href="xml/misc.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/libblkid/docs/libblkid-sections.txt b/libblkid/docs/libblkid-sections.txt new file mode 100644 index 000000000..53cf84b78 --- /dev/null +++ b/libblkid/docs/libblkid-sections.txt @@ -0,0 +1,201 @@ +<SECTION> +<FILE>evaluate</FILE> +blkid_evaluate_tag +blkid_evaluate_spec +</SECTION> + +<SECTION> +<FILE>init</FILE> +blkid_init_debug +</SECTION> + +<SECTION> +<FILE>cache</FILE> +blkid_cache +blkid_gc_cache +blkid_get_cache +blkid_put_cache +blkid_probe_all +blkid_probe_all_removable +blkid_probe_all_new +blkid_verify +</SECTION> + +<SECTION> +<FILE>search</FILE> +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 +</SECTION> + +<SECTION> +<FILE>lowprobe</FILE> +blkid_probe +blkid_free_probe +blkid_new_probe +blkid_new_probe_from_filename +blkid_probe_get_devno +blkid_probe_get_fd +blkid_probe_get_offset +blkid_probe_get_sectors +blkid_probe_get_sectorsize +blkid_probe_get_size +blkid_probe_get_wholedisk_devno +blkid_probe_is_wholedisk +blkid_probe_set_device +blkid_probe_step_back +blkid_reset_probe +</SECTION> + +<SECTION> +<FILE>lowprobe-tags</FILE> +blkid_do_fullprobe +blkid_do_wipe +blkid_do_probe +blkid_do_safeprobe +<SUBSECTION> +blkid_probe_get_value +blkid_probe_has_value +blkid_probe_lookup_value +blkid_probe_numof_values +</SECTION> + +<SECTION> +<FILE>partitions</FILE> +blkid_partlist +blkid_partition +blkid_parttable +blkid_probe_enable_partitions +blkid_probe_set_partitions_flags +blkid_probe_filter_partitions_type +blkid_probe_invert_partitions_filter +blkid_probe_reset_partitions_filter +<SUBSECTION> +blkid_known_pttype +<SUBSECTION> +blkid_partition_get_name +blkid_partition_get_flags +blkid_partition_get_partno +blkid_partition_get_size +blkid_partition_get_start +blkid_partition_get_table +blkid_partition_get_type +blkid_partition_get_type_string +blkid_partition_get_uuid +blkid_partition_is_extended +blkid_partition_is_logical +blkid_partition_is_primary +<SUBSECTION> +blkid_partlist_get_partition +blkid_partlist_get_partition_by_partno +blkid_partlist_numof_partitions +blkid_partlist_devno_to_partition +blkid_partlist_get_table +<SUBSECTION> +blkid_parttable_get_id +blkid_parttable_get_offset +blkid_parttable_get_parent +blkid_parttable_get_type +<SUBSECTION> +blkid_probe_get_partitions +</SECTION> + +<SECTION> +<FILE>superblocks</FILE> +blkid_probe_enable_superblocks +<SUBSECTION> +blkid_known_fstype +blkid_superblocks_get_name +<SUBSECTION> +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 +<SUBSECTION> +blkid_probe_reset_filter +blkid_probe_filter_types +blkid_probe_filter_usage +blkid_probe_invert_filter +blkid_probe_set_request +</SECTION> + +<SECTION> +<FILE>topology</FILE> +blkid_topology +blkid_probe_enable_topology +<SUBSECTION> +blkid_probe_get_topology +blkid_topology_get_alignment_offset +blkid_topology_get_logical_sector_size +blkid_topology_get_minimum_io_size +blkid_topology_get_optimal_io_size +blkid_topology_get_physical_sector_size +</SECTION> + +<SECTION> +<FILE>encode</FILE> +blkid_encode_string +blkid_safe_string +</SECTION> + +<SECTION> +<FILE>misc</FILE> +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 +BLKID_VERSION +BLKID_DATE +BLKID_FLTR_NOTIN +BLKID_FLTR_ONLYIN +BLKID_DEV_CREATE +BLKID_DEV_FIND +BLKID_DEV_NORMAL +BLKID_DEV_VERIFY +BLKID_PARTS_ENTRY_DETAILS +BLKID_PARTS_FORCE_GPT +BLKID_PARTS_MAGIC +BLKID_PROBREQ_LABEL +BLKID_PROBREQ_LABELRAW +BLKID_PROBREQ_SECTYPE +BLKID_PROBREQ_TYPE +BLKID_PROBREQ_USAGE +BLKID_PROBREQ_UUID +BLKID_PROBREQ_UUIDRAW +BLKID_PROBREQ_VERSION +BLKID_SUBLKS_BADCSUM +BLKID_SUBLKS_DEFAULT +BLKID_SUBLKS_LABEL +BLKID_SUBLKS_LABELRAW +BLKID_SUBLKS_MAGIC +BLKID_SUBLKS_SECTYPE +BLKID_SUBLKS_TYPE +BLKID_SUBLKS_USAGE +BLKID_SUBLKS_UUID +BLKID_SUBLKS_UUIDRAW +BLKID_SUBLKS_VERSION +BLKID_USAGE_CRYPTO +BLKID_USAGE_FILESYSTEM +BLKID_USAGE_OTHER +BLKID_USAGE_RAID +</SECTION> + + diff --git a/libblkid/docs/version.xml.in b/libblkid/docs/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/libblkid/docs/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |