diff options
author | Karel Zak | 2011-07-23 01:27:39 +0200 |
---|---|---|
committer | Karel Zak | 2011-07-23 01:27:39 +0200 |
commit | 63de90d44f4f05a1f48942148edcf1740ba4a623 (patch) | |
tree | 63605bd12892a706c3c51d2910850ae10b423edd /libmount/docs | |
parent | libblkid: update docs (diff) | |
download | kernel-qcow2-util-linux-63de90d44f4f05a1f48942148edcf1740ba4a623.tar.gz kernel-qcow2-util-linux-63de90d44f4f05a1f48942148edcf1740ba4a623.tar.xz kernel-qcow2-util-linux-63de90d44f4f05a1f48942148edcf1740ba4a623.zip |
libmount: cleanup docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libmount/docs')
-rw-r--r-- | libmount/docs/Makefile.am | 2 | ||||
-rw-r--r-- | libmount/docs/libmount-docs.xml | 18 | ||||
-rw-r--r-- | libmount/docs/libmount-sections.txt | 270 |
3 files changed, 166 insertions, 124 deletions
diff --git a/libmount/docs/Makefile.am b/libmount/docs/Makefile.am index 3e087d294..fe0545a96 100644 --- a/libmount/docs/Makefile.am +++ b/libmount/docs/Makefile.am @@ -34,7 +34,7 @@ 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 +MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space mnt # Extra options to supply to gtkdoc-mktmpl # e.g. MKTMPL_OPTIONS=--only-section-tmpl diff --git a/libmount/docs/libmount-docs.xml b/libmount/docs/libmount-docs.xml index 75802a282..b948e7408 100644 --- a/libmount/docs/libmount-docs.xml +++ b/libmount/docs/libmount-docs.xml @@ -9,7 +9,7 @@ <title>libmount Reference Manual</title> <releaseinfo>for libmount version &version;</releaseinfo> <copyright> - <year>2010</year> + <year>2010-2011</year> <holder>Karel Zak <kzak@redhat.com></holder> </copyright> </bookinfo> @@ -31,23 +31,26 @@ available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/. <part> <title>High-level API</title> <xi:include href="xml/context.xml"/> + <xi:include href="xml/context-mount.xml"/> + <xi:include href="xml/context-umount.xml"/> </part> <part> <title>Files parsing</title> - <xi:include href="xml/tab.xml"/> + <xi:include href="xml/table.xml"/> <xi:include href="xml/fs.xml"/> </part> <part> + <title>Tables management</title> + <xi:include href="xml/lock.xml"/> + <xi:include href="xml/update.xml"/> + <xi:include href="xml/tabdiff.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"/> @@ -55,7 +58,6 @@ available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/. <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> diff --git a/libmount/docs/libmount-sections.txt b/libmount/docs/libmount-sections.txt index f79374d90..e58dbcdfc 100644 --- a/libmount/docs/libmount-sections.txt +++ b/libmount/docs/libmount-sections.txt @@ -1,73 +1,91 @@ <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_new_cache +mnt_free_cache mnt_cache_device_has_tag mnt_cache_find_tag_value mnt_cache_read_tags -mnt_free_cache mnt_get_fstype -mnt_new_cache +mnt_pretty_path 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 +<FILE>context</FILE> +mnt_free_context +mnt_new_context +mnt_reset_context +mnt_context_append_options +mnt_context_apply_fstab +mnt_context_disable_canonicalize +mnt_context_disable_helpers +mnt_context_disable_mtab +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_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_optsmode +mnt_context_get_source +mnt_context_get_status +mnt_context_get_table +mnt_context_get_target +mnt_context_get_user_mflags +mnt_context_helper_setopt +mnt_context_init_helper +mnt_context_is_fake +mnt_context_is_force +mnt_context_is_fs_mounted +mnt_context_is_lazy +mnt_context_is_nomtab +mnt_context_is_rdonly_umount +mnt_context_is_restricted +mnt_context_is_sloppy +mnt_context_is_verbose +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_syscall_status +mnt_context_set_tables_errcb +mnt_context_set_target +mnt_context_set_user_mflags +mnt_context_strerror </SECTION> <SECTION> -<FILE>optmap</FILE> -mnt_get_builtin_optmap +<FILE>context-mount</FILE> +mnt_context_do_mount +mnt_context_finalize_mount +mnt_context_mount +mnt_context_next_mount +mnt_context_prepare_mount </SECTION> <SECTION> -<FILE>lock</FILE> -mnt_free_lock -mnt_lock_file -mnt_new_lock -mnt_unlock_file +<FILE>context-umount</FILE> +mnt_context_do_umount +mnt_context_finalize_umount +mnt_context_prepare_umount +mnt_context_umount </SECTION> <SECTION> @@ -76,10 +94,7 @@ 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 @@ -89,6 +104,7 @@ mnt_fs_get_fs_options mnt_fs_get_fstype mnt_fs_get_id mnt_fs_get_option +mnt_fs_get_options mnt_fs_get_parent_id mnt_fs_get_passno mnt_fs_get_root @@ -99,20 +115,17 @@ mnt_fs_get_target mnt_fs_get_userdata mnt_fs_get_user_options mnt_fs_get_vfs_options +mnt_fs_is_kernel 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 @@ -120,17 +133,58 @@ 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 +mnt_new_fs +mnt_reset_fs +</SECTION> + +<SECTION> +<FILE>init</FILE> +mnt_init_debug +</SECTION> + +<SECTION> +<FILE>iter</FILE> +mnt_free_iter +mnt_iter_get_direction +mnt_new_iter +mnt_reset_iter +</SECTION> + +<SECTION> +<FILE>lock</FILE> +mnt_free_lock +mnt_lock_file +mnt_new_lock +mnt_unlock_file +mnt_lock_block_signals +</SECTION> + +<SECTION> +<FILE>optmap</FILE> +mnt_get_builtin_optmap +</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>tab</FILE> +<FILE>table</FILE> mnt_free_table mnt_new_table +mnt_reset_table mnt_new_table_from_dir mnt_new_table_from_file mnt_table_add_fs @@ -144,6 +198,7 @@ mnt_table_get_cache mnt_table_get_name mnt_table_get_nents mnt_table_get_root_fs +mnt_table_is_fs_mounted mnt_table_next_child_fs mnt_table_next_fs mnt_table_parse_file @@ -157,6 +212,14 @@ mnt_table_set_parser_errcb </SECTION> <SECTION> +<FILE>tabdiff</FILE> +mnt_new_tabdiff +mnt_free_tabdiff +mnt_tabdiff_next_change +mnt_diff_tables +</SECTION> + +<SECTION> <FILE>update</FILE> mnt_free_update mnt_new_update @@ -170,57 +233,34 @@ 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 +<FILE>utils</FILE> +mnt_fstype_is_netfs +mnt_fstype_is_pseudofs +mnt_get_fstab_path +mnt_get_fstype +mnt_get_library_version +mnt_get_mtab_path +mnt_has_regular_mtab +mnt_mangle +mnt_match_fstype +mnt_match_options +mnt_unmangle </SECTION> +<SECTION> +<FILE>version</FILE> +mnt_parse_version_string +mnt_get_library_version +</SECTION> + + + + + + + + + + + + |