summaryrefslogtreecommitdiffstats
path: root/libfdisk
diff options
context:
space:
mode:
authorKarel Zak2014-11-26 11:13:11 +0100
committerKarel Zak2014-11-26 11:13:11 +0100
commit5d54d9f55b158e697aa0d54e511815c7e8dd5236 (patch)
treec0ba2df67d2b6dbeb0fb51039fff6247912dc08a /libfdisk
parentlibfdisk: add docs for GPT functions (diff)
downloadkernel-qcow2-util-linux-5d54d9f55b158e697aa0d54e511815c7e8dd5236.tar.gz
kernel-qcow2-util-linux-5d54d9f55b158e697aa0d54e511815c7e8dd5236.tar.xz
kernel-qcow2-util-linux-5d54d9f55b158e697aa0d54e511815c7e8dd5236.zip
libfdisk: add docs for init functions
Diffstat (limited to 'libfdisk')
-rw-r--r--libfdisk/src/init.c11
1 files changed, 11 insertions, 0 deletions
diff --git a/libfdisk/src/init.c b/libfdisk/src/init.c
index e147a17aa..61acb0a4f 100644
--- a/libfdisk/src/init.c
+++ b/libfdisk/src/init.c
@@ -1,6 +1,14 @@
#include "fdiskP.h"
+
+/**
+ * SECTION: init
+ * @title: Library initialization
+ * @short_description: initialize debug stuff
+ *
+ */
+
UL_DEBUG_DEFINE_MASK(libfdisk);
UL_DEBUG_DEFINE_MASKNAMES(libfdisk) =
{
@@ -15,6 +23,7 @@ UL_DEBUG_DEFINE_MASKNAMES(libfdisk) =
{ "tab", LIBFDISK_DEBUG_TAB, "table utils"},
{ NULL, 0 }
};
+
/**
* fdisk_init_debug:
* @mask: debug mask (0xffff to enable full debuging)
@@ -24,6 +33,8 @@ UL_DEBUG_DEFINE_MASKNAMES(libfdisk) =
*
* Already initialized debugging stuff cannot be changed. It does not
* have effect to call this function twice.
+ *
+ * It's strongly recommended to use fdisk_init_debug(0) in your code.
*/
void fdisk_init_debug(int mask)
{