libfdisk: fix fdisk_partition_start_follow_default() docs

Unfortunately, the behavior is different between DOS (original docs)
and GPT. Due to the need for backward compatibility, it is likely
impossible to change the default setting ...

Addresses: https://github.com/util-linux/util-linux/issues/3097
Signed-off-by: Karel Zak <kzak@redhat.com>

diff --git a/libfdisk/src/partition.c b/libfdisk/src/partition.c
index 1fd3176a6d9feb1bb27e00a2c9a36a371df05fb7..5b717051d1223084ecae8a15d63bb1c59a2cf49e 100644 (file)
--- a/libfdisk/src/partition.c
+++ b/libfdisk/src/partition.c
@@ -261,8 +261,9 @@ int fdisk_partition_cmp_start(struct fdisk_partition *a,
  * @pa: partition
  * @enable: 0|1
  *
- * When @pa used as a template for fdisk_add_partition() when force label driver
- * to use the first possible space for the new partition.
+ * When @pa is used as a template for fdisk_add_partition(), it follows the driver's default for
+ * the beginning of the partition. For DOS, it is the first usable space, while for GPT, it is
+ * the first sector of the largest area.
  *
  * Returns: 0 on success, <0 on error.
  */