libfdisk: update docs
Signed-off-by: Karel Zak <kzak@redhat.com>
diff --git a/libfdisk/docs/libfdisk-docs.xml b/libfdisk/docs/libfdisk-docs.xml
index 577b3e6..c1de89f 100644
--- a/libfdisk/docs/libfdisk-docs.xml
+++ b/libfdisk/docs/libfdisk-docs.xml
@@ -9,7 +9,7 @@
<title>libfdisk Reference Manual</title>
<releaseinfo>for libfdisk version &version;</releaseinfo>
<copyright>
- <year>2014-2015</year>
+ <year>2014-2017</year>
<holder>Karel Zak <kzak@redhat.com></holder>
</copyright>
</bookinfo>
diff --git a/libfdisk/docs/libfdisk-sections.txt b/libfdisk/docs/libfdisk-sections.txt
index 81fa83a..ad8f148 100644
--- a/libfdisk/docs/libfdisk-sections.txt
+++ b/libfdisk/docs/libfdisk-sections.txt
@@ -129,6 +129,7 @@
fdisk_script_get_header
fdisk_script_get_nlines
fdisk_script_get_table
+fdisk_script_has_force_label
fdisk_script_read_context
fdisk_script_read_file
fdisk_script_read_line
@@ -294,6 +295,7 @@
fdisk_get_collision
fdisk_get_devfd
fdisk_get_devname
+fdisk_get_disklabel_item
fdisk_get_first_lba
fdisk_get_geom_cylinders
fdisk_get_geom_heads
@@ -357,6 +359,12 @@
fdisk_labelitem_get_data_string
fdisk_labelitem_is_string
fdisk_labelitem_is_number
+fdisk_labelitem
+fdisk_labelitem_bsd
+fdisk_labelitem_gen
+fdisk_labelitem_gpt
+fdisk_labelitem_sgi
+fdisk_labelitem_sun
</SECTION>
<SECTION>
diff --git a/libfdisk/src/label.c b/libfdisk/src/label.c
index 1319284..c1afdf1 100644
--- a/libfdisk/src/label.c
+++ b/libfdisk/src/label.c
@@ -442,14 +442,14 @@
/**
* fdisk_get_disklabel_item:
* @cxt: fdisk context
- * @id: item ID (FDISK_LABELITEM_* or {GPT,MBR,...}_LABELITEM_*)
+ * @id: item ID (FDISK_LABELITEM_* or *_LABELITEM_*)
* @item: specifies and returns the item
*
* Note that @id is always in range 0..N. It's fine to use the function in loop
* until it returns error or 2, the result in @item should be ignored when
* function returns 1. Don't forget to use fdisk_reset_labelitem() or fdisk_unref_labelitem().
*
- * Returns: 0 on success, < 0 on error, 1 on unsupported item, 2 @id out of range
+ * Returns: 0 on success, < 0 on error, 1 on unsupported item, 2 id out of range
*/
int fdisk_get_disklabel_item(struct fdisk_context *cxt, int id, struct fdisk_labelitem *item)
{
diff --git a/libfdisk/src/libfdisk.h.in b/libfdisk/src/libfdisk.h.in
index 74c72b4..26dfe58 100644
--- a/libfdisk/src/libfdisk.h.in
+++ b/libfdisk/src/libfdisk.h.in
@@ -266,7 +266,7 @@
/* label.c */
/**
- * fdisk_fieldtype
+ * fdisk_fieldtype:
*
* Types of fdisk_field. The fields describe a partition.
*/
@@ -316,7 +316,7 @@
size_t *size);
/**
- * fdisk_labelitem_gen
+ * fdisk_labelitem_gen:
*
* Generic disklabel items
*/
@@ -527,6 +527,11 @@
extern int fdisk_sun_set_rspeed(struct fdisk_context *cxt);
extern int fdisk_sun_set_pcylcount(struct fdisk_context *cxt);
+/**
+ * fdisk_labelitem_sun:
+ *
+ * SUN specific label items.
+ */
enum fdisk_labelitem_sun {
SUN_LABELITEM_LABELID = __FDISK_NLABELITEMS,
SUN_LABELITEM_VTOCID,
@@ -542,6 +547,11 @@
extern int fdisk_bsd_write_bootstrap(struct fdisk_context *cxt);
extern int fdisk_bsd_link_partition(struct fdisk_context *cxt);
+/**
+ * fdisk_labelitem_bsd:
+ *
+ * BSD specific label items.
+ */
enum fdisk_labelitem_bsd {
/* specific */
BSD_LABELITEM_TYPE = __FDISK_NLABELITEMS,
@@ -566,6 +576,11 @@
extern int fdisk_sgi_set_bootfile(struct fdisk_context *cxt);
extern int fdisk_sgi_create_info(struct fdisk_context *cxt);
+/**
+ * fdisk_labelitem_sgi:
+ *
+ * SGI specific label items.
+ */
enum fdisk_labelitem_sgi {
SGI_LABELITEM_PCYLCOUNT = __FDISK_NLABELITEMS,
SGI_LABELITEM_SPARECYL,
@@ -625,6 +640,11 @@
extern int fdisk_gpt_get_partition_attrs(struct fdisk_context *cxt, size_t partnum, uint64_t *attrs);
extern int fdisk_gpt_set_partition_attrs(struct fdisk_context *cxt, size_t partnum, uint64_t attrs);
+/**
+ * fdisk_labelitem_gpt:
+ *
+ * GPT specific label items.
+ */
enum fdisk_labelitem_gpt {
/* generic */
GPT_LABELITEM_ID = FDISK_LABELITEM_ID, /* GPT disklabel UUID (!= partition UUID) */
diff --git a/libfdisk/src/script.c b/libfdisk/src/script.c
index 2a2eea6..198e9ed 100644
--- a/libfdisk/src/script.c
+++ b/libfdisk/src/script.c
@@ -358,12 +358,11 @@
* fdisk_script_has_force_label:
* @dp: script
*
- * Note that fdisk_script_set_header(dp, "label", name) does not modify
- * force_label status. The label has to be specified by script.
+ * Label has been explicitly specified in the script.
*
* Since: 2.30
*
- * Returns: true if "label: <name>" has been parsed.
+ * Returns: true if "label: name" has been parsed.
*/
int fdisk_script_has_force_label(struct fdisk_script *dp)
{
