libblkid/docs/Makefile
libblkid/docs/version.xml
libblkid/src/blkid.h
+libfdisk/docs/Makefile
+libfdisk/docs/version.xml
+libfdisk/src/libfdisk.h
libmount/docs/Makefile
libmount/docs/version.xml
libmount/src/libmount.h
libsmartcols/docs/Makefile
libsmartcols/docs/version.xml
libsmartcols/src/libsmartcols.h
-libfdisk/src/libfdisk.h
po/Makefile.in
])
include libfdisk/src/Makemodule.am
+if ENABLE_GTK_DOC
+# Docs uses separate Makefiles
+SUBDIRS += libfdisk/docs
+endif
+
pkgconfig_DATA += libfdisk/fdisk.pc
PATHFILES += libfdisk/fdisk.pc
EXTRA_DIST += libfdisk/COPYING
--- /dev/null
+*-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/*
--- /dev/null
+## 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=libfdisk
+
+# 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 fdisk
+
+# 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)/libfdisk/src/libfdisk.h
+CFILE_GLOB=$(top_srcdir)/libfdisk/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=fdiskP.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 += version.xml
--- /dev/null
+<?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>libfdisk Reference Manual</title>
+ <releaseinfo>for libfdisk version &version;</releaseinfo>
+ <copyright>
+ <year>2014</year>
+ <holder>Karel Zak <kzak@redhat.com></holder>
+ </copyright>
+ </bookinfo>
+
+ <part id="over">
+ <title>libfdisk Overview</title>
+ <partintro>
+ <para>
+The libfdisk library is used for manipulating with partition tables.
+ </para>
+ <para>
+The library is part of the util-linux package since version 2.26 and is
+available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+ </para>
+ </partintro>
+ </part>
+
+ <part>
+ <title>Basic handlers and setting</title>
+ <xi:include href="xml/context.xml"/>
+ <xi:include href="xml/ask.xml"/>
+ <xi:include href="xml/alignment.xml"/>
+ <xi:include href="xml/script.xml"/>
+ </part>
+ <part>
+ <title>Partitining</title>
+ <xi:include href="xml/label.xml"/>
+ <xi:include href="xml/partition.xml"/>
+ <xi:include href="xml/table.xml"/>
+ <xi:include href="xml/parttype.xml"/>
+ </part>
+ <part>
+ <title>Label specific functions</title>
+ <xi:include href="xml/dos.xml"/>
+ <xi:include href="xml/gpt.xml"/>
+ <xi:include href="xml/sun.xml"/>
+ <xi:include href="xml/sgi.xml"/>
+ <xi:include href="xml/bsd.xml"/>
+ </part>
+ <part>
+ <title>Misc</title>
+ <xi:include href="xml/iter.xml"/>
+ <xi:include href="xml/utils.xml"/>
+ <xi:include href="xml/init.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>
--- /dev/null
+<SECTION>
+<FILE>init</FILE>
+fdisk_init_debug
+</SECTION>
+
+<SECTION>
+<FILE>ask</FILE>
+fdisk_info
+fdisk_warn
+fdisk_warnx
+fdisk_set_ask
+<SUBSECTION>
+fdisk_ask
+fdisk_ask_get_query
+fdisk_ask_get_type
+fdisk_ask_menu_get_default
+fdisk_ask_menu_get_item
+fdisk_ask_menu_get_nitems
+fdisk_ask_menu_get_result
+fdisk_ask_menu_set_result
+fdisk_ask_number
+fdisk_ask_number_get_base
+fdisk_ask_number_get_default
+fdisk_ask_number_get_high
+fdisk_ask_number_get_low
+fdisk_ask_number_get_range
+fdisk_ask_number_get_result
+fdisk_ask_number_get_unit
+fdisk_ask_number_inchars
+fdisk_ask_number_set_relative
+fdisk_ask_number_set_result
+fdisk_ask_partnum
+fdisk_ask_print_get_errno
+fdisk_ask_print_get_mesg
+fdisk_ask_string
+fdisk_ask_string_get_result
+fdisk_ask_string_set_result
+fdisk_ask_yesno
+fdisk_ask_yesno_get_result
+fdisk_ask_yesno_set_result
+fdisk_ref_ask
+fdisk_unref_ask
+</SECTION>
+
+<SECTION>
+<FILE>alignment</FILE>
+fdisk_align_lba
+fdisk_align_lba_in_range
+fdisk_has_user_device_properties
+fdisk_lba_is_phy_aligned
+fdisk_override_geometry
+fdisk_reread_partition_table
+fdisk_reset_alignment
+fdisk_reset_device_properties
+fdisk_save_user_geometry
+fdisk_save_user_sector_size
+</SECTION>
+
+<SECTION>
+<FILE>label</FILE>
+fdisk_create_disklabel
+fdisk_list_disklabel
+fdisk_locate_disklabel
+fdisk_reorder_partitions
+fdisk_set_disklabel_id
+fdisk_set_partition_type
+fdisk_toggle_partition_flag
+fdisk_verify_disklabel
+fdisk_write_disklabel
+<SUBSECTION>
+fdisk_get_disklabel_id
+fdisk_get_label
+fdisk_get_nlabels
+fdisk_next_label
+fdisk_get_npartitions
+<SUBSECTION>
+fdisk_field
+fdisk_field_get_id
+fdisk_field_get_name
+fdisk_field_get_width
+fdisk_field_is_number
+<SUBSECTION>
+fdisk_label
+fdisk_label_get_field
+fdisk_label_get_field_by_name
+fdisk_label_get_fields_ids
+fdisk_label_get_name
+fdisk_label_get_nparttypes
+fdisk_label_get_parttype
+fdisk_label_get_parttype_from_code
+fdisk_label_get_parttype_from_string
+fdisk_label_get_type
+fdisk_label_has_code_parttypes
+fdisk_label_is_changed
+fdisk_label_is_disabled
+fdisk_label_parse_parttype
+fdisk_label_require_geometry
+fdisk_label_set_changed
+fdisk_label_set_disabled
+</SECTION>
+
+<SECTION>
+<FILE>script</FILE>
+fdisk_set_script
+fdisk_get_script
+<SUBSECTION>
+fdisk_apply_script
+fdisk_apply_script_headers
+<SUBSECTION>
+fdisk_script
+fdisk_new_script
+fdisk_new_script_from_file
+fdisk_ref_script
+fdisk_script_get_header
+fdisk_script_get_nlines
+fdisk_script_get_table
+fdisk_script_read_context
+fdisk_script_read_file
+fdisk_script_read_line
+fdisk_script_set_header
+fdisk_script_write_file
+fdisk_unref_script
+</SECTION>
+
+<SECTION>
+<FILE>bsd</FILE>
+fdisk_bsd_edit_disklabel
+fdisk_bsd_link_partition
+fdisk_bsd_write_bootstrap
+</SECTION>
+
+<SECTION>
+<FILE>partition</FILE>
+fdisk_add_partition
+fdisk_delete_all_partitions
+fdisk_delete_partition
+fdisk_get_partition
+fdisk_is_partition_used
+fdisk_set_partition
+<SUBSECTION>
+fdisk_partition
+fdisk_new_partition
+fdisk_partition_cmp_partno
+fdisk_partition_cmp_start
+fdisk_partition_end_follow_default
+fdisk_partition_end_is_default
+fdisk_partition_get_attrs
+fdisk_partition_get_name
+fdisk_partition_get_parent
+fdisk_partition_get_partno
+fdisk_partition_get_size
+fdisk_partition_get_start
+fdisk_partition_get_type
+fdisk_partition_get_uuid
+fdisk_partition_has_partno
+fdisk_partition_has_size
+fdisk_partition_has_start
+fdisk_partition_is_bootable
+fdisk_partition_is_container
+fdisk_partition_is_freespace
+fdisk_partition_is_nested
+fdisk_partition_is_used
+fdisk_partition_next_partno
+fdisk_partition_partno_follow_default
+fdisk_partition_set_attrs
+fdisk_partition_set_name
+fdisk_partition_set_partno
+fdisk_partition_set_size
+fdisk_partition_set_start
+fdisk_partition_set_type
+fdisk_partition_set_uuid
+fdisk_partition_size_explicit
+fdisk_partition_start_follow_default
+fdisk_partition_start_is_default
+fdisk_partition_to_string
+fdisk_partition_unset_partno
+fdisk_partition_unset_size
+fdisk_partition_unset_start
+fdisk_ref_partition
+fdisk_reset_partition
+fdisk_unref_partition
+</SECTION>
+
+<SECTION>
+<FILE>dos</FILE>
+fdisk_dos_enable_compatible
+fdisk_dos_is_compatible
+fdisk_dos_move_begin
+</SECTION>
+
+<SECTION>
+<FILE>sgi</FILE>
+fdisk_sgi_create_info
+fdisk_sgi_set_bootfile
+</SECTION>
+
+<SECTION>
+<FILE>gpt</FILE>
+fdisk_gpt_is_hybrid
+</SECTION>
+
+<SECTION>
+<FILE>sun</FILE>
+fdisk_sun_set_alt_cyl
+fdisk_sun_set_ilfact
+fdisk_sun_set_pcylcount
+fdisk_sun_set_rspeed
+fdisk_sun_set_xcyl
+</SECTION>
+
+<SECTION>
+<FILE>parttype</FILE>
+fdisk_parttype
+fdisk_copy_parttype
+fdisk_new_parttype
+fdisk_new_unknown_parttype
+fdisk_parttype_get_code
+fdisk_parttype_get_name
+fdisk_parttype_get_string
+fdisk_parttype_is_unknown
+fdisk_parttype_set_code
+fdisk_parttype_set_name
+fdisk_parttype_set_typestr
+fdisk_ref_parttype
+fdisk_unref_parttype
+</SECTION>
+
+<SECTION>
+<FILE>table</FILE>
+fdisk_get_freespaces
+fdisk_get_partitions
+<SUBSECTION>
+fdisk_table
+fdisk_apply_table
+fdisk_new_table
+fdisk_ref_table
+fdisk_reset_table
+fdisk_table_add_partition
+fdisk_table_get_nents
+fdisk_table_get_partition
+fdisk_table_is_empty
+fdisk_table_next_partition
+fdisk_table_remove_partition
+fdisk_table_sort_partitions
+fdisk_table_wrong_order
+fdisk_unref_table
+</SECTION>
+
+
+<SECTION>
+<FILE>context</FILE>
+fdisk_context
+fdisk_assign_device
+fdisk_deassign_device
+fdisk_enable_details
+fdisk_enable_listonly
+fdisk_get_alignment_offset
+fdisk_get_devfd
+fdisk_get_devname
+fdisk_get_first_lba
+fdisk_get_geom_cylinders
+fdisk_get_geom_heads
+fdisk_get_geom_sectors
+fdisk_get_grain_size
+fdisk_get_last_lba
+fdisk_get_minimal_iosize
+fdisk_get_nsectors
+fdisk_get_optimal_iosize
+fdisk_get_parent
+fdisk_get_physector_size
+fdisk_get_sector_size
+fdisk_get_unit
+fdisk_get_units_per_sector
+fdisk_has_label
+fdisk_has_user_device_properties
+fdisk_is_details
+fdisk_is_labeltype
+fdisk_is_listonly
+fdisk_is_readonly
+fdisk_new_context
+fdisk_new_nested_context
+fdisk_ref_context
+fdisk_set_first_lba
+fdisk_set_last_lba
+fdisk_set_unit
+fdisk_unref_context
+fdisk_use_cylinders
+</SECTION>
+
+<SECTION>
+<FILE>utils</FILE>
+fdisk_partname
+</SECTION>
+
+<SECTION>
+<FILE>iter</FILE>
+fdisk_free_iter
+fdisk_iter_get_direction
+fdisk_new_iter
+fdisk_reset_iter
+</SECTION>
/**
* SECTION: alignment
- * @title: Align LBA
- * @short_description: function to align partitions and work with disk topology and geometry.
+ * @title: Alignment
+ * @short_description: functions to align partitions and work with disk topology and geometry
*
* The libfdisk aligns the end of the partitions to make it possible to align
* the next partition to the "grain" (see fdisk_get_grain()). The grain is
* fdisk_save_user_geometry:
* @cxt: context
* @cylinders: C
- * @head: H
- * @sector: S
+ * @heads: H
+ * @sectors: S
*
* Save user defined geometry to use it for partitioning.
*
/**
* SECTION: ask
- * @title: Ask callback
- * @short_description: interface for dialog driven partitioning
+ * @title: Ask
+ * @short_description: interface for dialog driven partitioning, warning and info messages
*
*/
}
/**
- * fdisk_ask_number_get_low"
+ * fdisk_ask_number_get_low:
* @ask: ask instance
*
* Returns: minimal possible number when ask for numbers in range
}
/**
- * fdisk_ask_number_get_high"
+ * fdisk_ask_number_get_high:
* @ask: ask instance
*
* Returns: maximal possible number when ask for numbers in range
/**
* fdisk_ask_number_set_result:
* @ask: ask instance
- * @ask: dialog result
+ * @result: dialog result
*
* Returns: 0 on success, <0 on error
*/
* fdisk_ask_number_get_base:
* @ask: ask instance
*
- * Returns: base when user specify number in relative notation (+<size>)
+ * Returns: base when user specify number in relative notation (+size)
*/
uint64_t fdisk_ask_number_get_base(struct fdisk_ask *ask)
{
* fdisk_info:
* @cxt: context
* @fmt: printf-like formatted string
+ * @...: variable parametrs
*
* High-level API to print info messages,
*
* fdisk_info:
* @cxt: context
* @fmt: printf-like formatted string
+ * @...: variable parametrs
*
* High-level API to print warning message (errno expected)
*
* fdisk_warnx:
* @cxt: context
* @fmt: printf-like formatted string
+ * @...: variable options
*
* High-level API to print warning message
*
/**
* SECTION: bsd
- * @title: BSD functions
- * @short_description: BSD disklabel specific libfdisk functions
+ * @title: BSD
+ * @short_description: disk label specific functions
*
*/
/**
* SECTION: context
- * @title: libfdisk handler
- * @short_description: stores infor about device, labels etc.
+ * @title: Context
+ * @short_description: stores info about device, labels etc.
*
* The library distinguish between three types of partitioning objects.
*
*
* See also fdisk_is_label() macro in libfdisk.h.
*
- * Returns: return 1 if the current label is @l
+ * Returns: return 1 if the current label is @id
*/
int fdisk_is_labeltype(struct fdisk_context *cxt, enum fdisk_labeltype id)
{
/**
* fdisk_get_unit:
* @cxt: context
+ * @n: FDISK_PLURAL or FDISK_SINGULAR
*
* Returns: unit name.
*/
/**
* fdisk_use_cylinders:
- * @@cxt: context
+ * @cxt: context
*
- * Returns 1 if user wants to display in cylinders.
+ * Returns: 1 if user wants to display in cylinders.
*/
int fdisk_use_cylinders(struct fdisk_context *cxt)
{
/**
* SECTION: dos
- * @title: MBR (DOS) functions
- * @short_description: MBR disk label specific functions
+ * @title: DOS (MBR)
+ * @short_description: disk label specific functions
*
*/
/**
* SECTION: gpt
- * @title: UEFI GPT functions
- * @short_description: GPT specific functionality
+ * @title: UEFI GPT
+ * @short_description: specific functionality
*/
#define GPT_HEADER_SIGNATURE 0x5452415020494645LL /* EFI PART */
/**
* SECTION: label
- * @title: Label specific driver
- * @short_description: label (PT) specific data and functions
+ * @title: Label
+ * @short_description: disk label (PT) specific data and functions
*
* The fdisk_new_context() initializes all label drivers, and allocate
* per-label specific data struct. This concept allows to store label specific
/**
* fdisk_label_get_fields_ids
* @lb: label (or NULL for the current label)
+ * @cxt: context
* @ids: returns allocated array with FDISK_FIELD_* IDs
* @nids: returns number of items in fields
*
* function. If the details are enabled then this function usually returns more
* fields.
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_label_get_fields_ids(
const struct fdisk_label *lb,
*
* Write in-memory changes to disk. Be careful!
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_write_disklabel(struct fdisk_context *cxt)
{
* This function uses libfdisk ASK interface to print data. The details about
* partitions table are printed by FDISK_ASKTYPE_INFO.
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_list_disklabel(struct fdisk_context *cxt)
{
*
* The function modifies in-memory data only.
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_create_disklabel(struct fdisk_context *cxt, const char *name)
{
* @cxt: fdisk context
* @id: returns pointer to allocated string (MBR Id or GPT dirk UUID)
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_get_disklabel_id(struct fdisk_context *cxt, char **id)
{
* fdisk_set_disklabel_id:
* @cxt: fdisk context
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_set_disklabel_id(struct fdisk_context *cxt)
{
* @partnum: partition number
* @t: new type
*
- * Returns 0 on success, < 0 on error.
+ * Returns: 0 on success, < 0 on error.
*/
int fdisk_set_partition_type(struct fdisk_context *cxt,
size_t partnum,
* fdisk_toggle_partition_flag:
* @cxt: fdisk context
* @partnum: partition number
- * @status: flags
+ * @flag: flag ID
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_toggle_partition_flag(struct fdisk_context *cxt,
size_t partnum,
*
* Sort partitions according to the partition start sector.
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_reorder_partitions(struct fdisk_context *cxt)
{
/**
* fdisk_label_set_disabled:
* @lb: label
+ * @disabled: 0 or 1
*
- * Mark label as disabled, then libfdisk is going to ignore the label when
+ * Mark label as disabled, then libfdisk is going to ignore the label when
* probe device for labels.
*/
void fdisk_label_set_disabled(struct fdisk_label *lb, int disabled)
size_t fdisk_get_nlabels(struct fdisk_context *cxt);
int fdisk_has_label(struct fdisk_context *cxt);
-int fdisk_is_labeltype(struct fdisk_context *cxt, enum fdisk_labeltype l);
+int fdisk_is_labeltype(struct fdisk_context *cxt, enum fdisk_labeltype id);
#define fdisk_is_label(c, x) fdisk_is_labeltype(c, FDISK_DISKLABEL_ ## x)
const struct fdisk_label *lb,
const char *name);
-extern int fdisk_field_get_id(const struct fdisk_field *fl);
-extern const char *fdisk_field_get_name(const struct fdisk_field *fl);
-extern double fdisk_field_get_width(const struct fdisk_field *fl);
-extern int fdisk_field_is_number(const struct fdisk_field *fl);
+extern int fdisk_field_get_id(const struct fdisk_field *field);
+extern const char *fdisk_field_get_name(const struct fdisk_field *field);
+extern double fdisk_field_get_width(const struct fdisk_field *field);
+extern int fdisk_field_is_number(const struct fdisk_field *field);
extern void fdisk_label_set_changed(struct fdisk_label *lb, int changed);
int fdisk_script_read_context(struct fdisk_script *dp, struct fdisk_context *cxt);
int fdisk_script_write_file(struct fdisk_script *dp, FILE *f);
int fdisk_script_read_file(struct fdisk_script *dp, FILE *f);
-int fdisk_script_read_line(struct fdisk_script *dp, FILE *f, char *buf, size_t sz);
+int fdisk_script_read_line(struct fdisk_script *dp, FILE *f, char *buf, size_t bufsz);
int fdisk_set_script(struct fdisk_context *cxt, struct fdisk_script *dp);
struct fdisk_script *fdisk_get_script(struct fdisk_context *cxt);
/**
* SECTION: partition
- * @title: partition abstraction
- * @short_description: generic label independent partition
+ * @title: Partition
+ * @short_description: generic label independent partition abstraction
*
* The fdisk_partition provides label independent abstraction. The partitions
* are not directly connected with partition table (label) data. Any change to
/**
* fdisk_ref_partition:
- * @tb: partition pointer
+ * @pa: partition pointer
*
* Incremparts reference counter.
*/
/**
* fdisk_partition_set_partno:
* @pa: partition
- * @parto: partitin number (0 is the first partition, maximal is SIZE_MAX-1)
+ * @num: partitin number (0 is the first partition, maximal is SIZE_MAX-1)
*
* Note that zero is valid partno too. Use fdisk_partition_unset_partno() to
* undefine the partno.
/**
* fdisk_partition_to_string:
* @pa: partition
+ * @cxt: context
* @id: field (FDISK_FIELD_*)
* @data: returns string with allocated data
*
*
* returns UUID for the first partition.
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_partition_to_string(struct fdisk_partition *pa,
struct fdisk_context *cxt,
/**
* fdisk_is_partition_used:
+ * @cxt: context
* @n: partition number (0 is the first partition)
*
* This is faster than fdisk_get_partition() + fdisk_partition_is_used().
#include "fdiskP.h"
/**
- * SECTION: parttypw
+ * SECTION: parttype
* @title: Partition types
* @short_description: abstraction to partition types
*
/**
* fdisk_parttype_set_code:
* @t: partition type
- * @int: type identificator (e.g. MBR type codes)
+ * @code: type identificator (e.g. MBR type codes)
*
* Sets type code to allocated partition type, for static types it returns
* -EINVAL. Don't use this function for GPT, see fdisk_parttype_set_typestr().
/**
* SECTION: script
- * @title: Partition table script
- * @short_description: text based description of partition table
+ * @title: Script
+ * @short_description: text based sfdisk compatible description of partition table
*
* The libfdisk scripts are based on original sfdisk script (dumps). Each
* script has two parts: script headers and partition table entries
/**
* fdisk_new_script:
+ * @cxt: context
*
* The script hold fdisk_table and additional information to read/write
* script to the file.
* fdisk_script_read_line:
* @dp: script
* @f: file
+ * @buf: buffer to store one line of the file
+ * @bufsz: buffer size
*
* Reads next line into dump.
*
/**
* fdisk_script_read_file:
* @dp: script
- * @f input file
+ * @f: input file
*
* Reads file @f into script @dp.
*
/**
* fdisk_apply_script_headers:
* @cxt: context
- * dp: script
+ * @dp: script
*
* Associte context @cxt with script @dp and creates a new empty disklabel.
*
- * Return: 0 on success, <0 on error.
+ * Returns: 0 on success, <0 on error.
*/
int fdisk_apply_script_headers(struct fdisk_context *cxt, struct fdisk_script *dp)
{
/**
* SECTION: sgi
- * @title: SGI functions
- * @short_description: SGI disk label specific functionality
+ * @title: SGI
+ * @short_description: disk label specific functions
*
*/
/**
* SECTION: sun
- * @title: SUN functions
- * @short_description: SUN disklabel specific functions
+ * @title: SUN
+ * @short_description: disk label specific functions
*
*/
/**
* SECTION: table
- * @title: table
+ * @title: Table
* @short_description: container for fdisk partitions
*
* The fdisk_table is simple container for fdisk_partitions. The table is no
* This function adds partitions from disklabel to @table, it allocates a new
* table if if @table points to NULL.
*
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_get_partitions(struct fdisk_context *cxt, struct fdisk_table **tb)
{
* @cmp: compare function
*
* Sort partition in the table.
+ *
+ * Returns: 0 on success, <0 on error.
*/
int fdisk_table_sort_partitions(struct fdisk_table *tb,
int (*cmp)(struct fdisk_partition *,
*
* Note that free space smaller than grain (see fdisk_get_grain()) is ignored.
- * Returns 0 on success, otherwise, a corresponding error.
+ * Returns: 0 on success, otherwise, a corresponding error.
*/
int fdisk_get_freespaces(struct fdisk_context *cxt, struct fdisk_table **tb)
{
/**
* SECTION: utils
- * @title: Misc utils
+ * @title: Utils
* @short_description: misc fdisk functions
*/
/**
* fdisk_partname:
- * dev: device name
+ * @dev: device name
* @partno: partition name
*
* Return: allocated buffer with partition name, use free() to deallocate.
projects / thirdparty / util-linux.git / commitdiff
