summaryrefslogtreecommitdiffstats
path: root/shlibs/blkid/src/probe.c
diff options
context:
space:
mode:
authorKarel Zak2010-04-23 13:56:58 +0200
committerKarel Zak2010-04-23 13:56:58 +0200
commite9c2d185619fbcfd91998c312bc29f5eca2047eb (patch)
treec25ec08d6f67e20331cc8eff376472f67e5bbc3b /shlibs/blkid/src/probe.c
parentlibblkid: add blkid_partlist_get_table() (diff)
downloadkernel-qcow2-util-linux-e9c2d185619fbcfd91998c312bc29f5eca2047eb.tar.gz
kernel-qcow2-util-linux-e9c2d185619fbcfd91998c312bc29f5eca2047eb.tar.xz
kernel-qcow2-util-linux-e9c2d185619fbcfd91998c312bc29f5eca2047eb.zip
libblkid: cleanup some docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'shlibs/blkid/src/probe.c')
-rw-r--r--shlibs/blkid/src/probe.c16
1 files changed, 15 insertions, 1 deletions
diff --git a/shlibs/blkid/src/probe.c b/shlibs/blkid/src/probe.c
index 9021a7e84..89c595043 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.
*/
/**