From: Karel Zak <kzak@redhat.com>
Date: Wed, 26 Nov 2014 10:45:00 +0000 (+0100)
Subject: libfdisk: add docs for SGI functions
X-Git-Tag: v2.26-rc1~170
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=77e46d1c06f6c5c3abf0812826822f5c16442b1e;p=thirdparty%2Futil-linux.git

libfdisk: add docs for SGI functions
---

diff --git a/libfdisk/src/sgi.c b/libfdisk/src/sgi.c
index 436ec1f6d7..b065569760 100644
--- a/libfdisk/src/sgi.c
+++ b/libfdisk/src/sgi.c
@@ -22,6 +22,13 @@
 #include "pt-mbr.h"
 #include "fdiskP.h"
 
+/**
+ * SECTION: sgi
+ * @title: SGI functions
+ * @short_description: SGI disk label specific functionality
+ *
+ */
+
 /*
  * in-memory fdisk SGI stuff
  */
@@ -130,6 +137,16 @@ static void sgi_free_info(struct sgi_info *info)
 	free(info);
 }
 
+/**
+ * fdisk_sgi_create_info:
+ * @cxt: context
+ *
+ * This function add hint about SGI label (e.g. set "sgilabel" as volume name)
+ * to the first SGI volume. This is probably old SGI convention without any
+ * effect to the device partitioning.
+ *
+ * Returns: 0 on success, <0 on error
+ */
 int fdisk_sgi_create_info(struct fdisk_context *cxt)
 {
 	struct sgi_disklabel *sgilabel = self_disklabel(cxt);
@@ -378,6 +395,15 @@ static int sgi_check_bootfile(struct fdisk_context *cxt, const char *name)
 	return 1;	/* filename did not change */
 }
 
+/**
+ * fdisk_sgi_set_bootfile:
+ * @cxt: context
+ *
+ * Allows to set SGI boot file. The function uses Ask API for dialog with
+ * user.
+ *
+ * Returns: 0 on success, <0 on error
+ */
 int fdisk_sgi_set_bootfile(struct fdisk_context *cxt)
 {
 	int rc = 0;