summaryrefslogtreecommitdiffstats
path: root/shlibs/blkid/src/probe.c
diff options
context:
space:
mode:
authorKarel Zak2009-09-16 16:42:12 +0200
committerKarel Zak2009-09-16 21:39:06 +0200
commit488e52be1ec986112f304d0f6ee019f186ff3d1d (patch)
tree2465a768444764b1b656a14ad107b906899f96d6 /shlibs/blkid/src/probe.c
parentlibblkid: add mkfs sample (diff)
downloadkernel-qcow2-util-linux-488e52be1ec986112f304d0f6ee019f186ff3d1d.tar.gz
kernel-qcow2-util-linux-488e52be1ec986112f304d0f6ee019f186ff3d1d.tar.xz
kernel-qcow2-util-linux-488e52be1ec986112f304d0f6ee019f186ff3d1d.zip
libblkid: add missing comments
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'shlibs/blkid/src/probe.c')
-rw-r--r--shlibs/blkid/src/probe.c11
1 files changed, 8 insertions, 3 deletions
diff --git a/shlibs/blkid/src/probe.c b/shlibs/blkid/src/probe.c
index 834259290..421e9f165 100644
--- a/shlibs/blkid/src/probe.c
+++ b/shlibs/blkid/src/probe.c
@@ -20,8 +20,12 @@
*
* 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).
- * These filters are per-chain. For more details see the chain specific
- * documenation.
+ * These filters are per-chain. Note that always when you touch the chain
+ * filter the current probing position is reseted and probing starts from
+ * scratch. It means that the chain filter should not be modified during
+ * probing, for example in loop where you call blkid_do_probe().
+ *
+ * For more details see the chain specific documentation.
*
* The low-level API provides two ways how access to probing results.
*
@@ -30,6 +34,7 @@
*
* 2. The binary interfaces. These interfaces return data in the native formats.
* The interface is always specific to the probing chain.
+ *
*/
/**
@@ -44,7 +49,7 @@
*
* The SUPERBLOCKS chain is enabled by default. The all others chains is
* necessary to enable by blkid_probe_enable_'CHAINNAME'(). See chains specific
- * documenation.
+ * documentation.
*
* The blkid_do_probe() function returns a result from only one probing
* routine, and the next call from the next probing routine. It means you need