From: Karel Zak <kzak@redhat.com>
Date: Fri, 23 Apr 2010 11:56:58 +0000 (+0200)
Subject: libblkid: cleanup some docs
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e9c2d185619fbcfd91998c312bc29f5eca2047eb;p=util-linux

libblkid: cleanup some docs

Signed-off-by: Karel Zak <kzak@redhat.com>
---

diff --git a/shlibs/blkid/src/partitions/partitions.c b/shlibs/blkid/src/partitions/partitions.c
index 9c151ef6..c670cc18 100644
--- a/shlibs/blkid/src/partitions/partitions.c
+++ b/shlibs/blkid/src/partitions/partitions.c
@@ -899,8 +899,9 @@ blkid_parttable blkid_partlist_get_table(blkid_partlist ls)
  *
  * It's possible that the list of partitions is *empty*, but there is a valid
  * partition table on the disk. This happen when on-disk details about
- * partitions are unknown or the partition table is empty. The nice example is
- * AIX. See also blkid_partlist_get_table().
+ * partitions are unknown or the partition table is empty.
+ *
+ * See also blkid_partlist_get_table().
  *
  * Returns: partition object or NULL in case or error.
  */
diff --git a/shlibs/blkid/src/probe.c b/shlibs/blkid/src/probe.c
index 9021a7e8..89c59504 100644
--- a/shlibs/blkid/src/probe.c
+++ b/shlibs/blkid/src/probe.c
@@ -16,7 +16,7 @@
  * the selected (see blkid_probe_set_device()) device.
  *
  * The probing routines are grouped together into separate chains. Currently,
- * the librray provides superblocks, partitions and topology chains.
+ * the library provides superblocks, partitions and topology chains.
  *
  * The probing routines is possible to filter (enable/disable) by type (e.g.
  * fstype "vfat" or partype "gpt") or by usage flags (e.g. BLKID_USAGE_RAID).
@@ -35,6 +35,20 @@
  *   2. The binary interfaces. These interfaces return data in the native formats.
  *      The interface is always specific to the probing chain.
  *
+ *  Note that the previous probing result (binary or NAME=value) is always
+ *  zeroized when a chain probing function is called. For example
+ *
+ * <informalexample>
+ *   <programlisting>
+ *     blkid_probe_enable_partitions(pr, TRUE);
+ *     blkid_probe_enable_superblocks(pr, FALSE);
+ *
+ *     blkid_do_safeprobe(pr);
+ *   </programlisting>
+ * </informalexample>
+ *
+ * overwrites the previous probing result for the partitions chain, the superblocks
+ * result is not modified.
  */
 
 /**