dcavalca / rpms / util-linux

Forked from rpms/util-linux 2 years ago
Clone
5f5089
From d7725fb45fe8d4fcb67cb9fbc117bc1cf66fcd56 Mon Sep 17 00:00:00 2001
5f5089
From: Karel Zak <kzak@redhat.com>
5f5089
Date: Tue, 17 Oct 2017 10:44:01 +0200
5f5089
Subject: [PATCH 136/141] blkid: update man page about lsblk and ambivalent
5f5089
 probing
5f5089
5f5089
Upstream: http://github.com/karelzak/util-linux/commit/12786a901520d7b30ff75ee8727221bf8a3089cb
5f5089
Upstream: http://github.com/karelzak/util-linux/commit/27fbfef33c1f23b5448b6cee856bcb3500b33c42
5f5089
Addresses: https://bugzilla.redhat.com/show_bug.cgi?id=1501953
5f5089
Signed-off-by: Karel Zak <kzak@redhat.com>
5f5089
---
5f5089
 misc-utils/blkid.8 | 39 +++++++++++++++++++++++++++------------
5f5089
 1 file changed, 27 insertions(+), 12 deletions(-)
5f5089
5f5089
diff --git a/misc-utils/blkid.8 b/misc-utils/blkid.8
5f5089
index a974b8e99..1f12d202a 100644
5f5089
--- a/misc-utils/blkid.8
5f5089
+++ b/misc-utils/blkid.8
5f5089
@@ -61,6 +61,23 @@ library.  It can determine the type of content (e.g. filesystem or swap)
5f5089
 that a block device holds, and also the attributes (tokens, NAME=value pairs)
5f5089
 from the content metadata (e.g. LABEL or UUID fields).
5f5089
 .PP
5f5089
+.B It is recommended to use
5f5089
+.BR lsblk (8)
5f5089
+.B command to get information about block devices, or lsblk --fs to get an overview of filesystems, or
5f5089
+.BR findmnt (8)
5f5089
+.B to search in already mounted filesystems.
5f5089
+.PP
5f5089
+.RS
5f5089
+.BR lsblk (8)
5f5089
+provides more information, better control on output formatting, easy to use in
5f5089
+scripts and it does not require root permissions to get actual information.
5f5089
+.B blkid
5f5089
+reads information directly from devices and for non-root users
5f5089
+it returns cached unverified information.
5f5089
+.B blkid
5f5089
+is mostly designed for system services and to test libblkid functionality.
5f5089
+.RE
5f5089
+.PP
5f5089
 When
5f5089
 .I device
5f5089
 is specified, tokens from only this device are displayed.
5f5089
@@ -71,21 +88,19 @@ If none is given, all devices which appear in
5f5089
 .I /proc/partitions
5f5089
 are shown, if they are recognized.
5f5089
 .PP
5f5089
-Note that
5f5089
-.B blkid
5f5089
-reads information directly from devices and for non-root users
5f5089
-it returns cached unverified information.  It is better to use
5f5089
-.B lsblk --fs
5f5089
-to get a user-friendly overview of filesystems and devices.
5f5089
-.BR lsblk (8)
5f5089
-is also easy to use in scripts.
5f5089
-.B blkid
5f5089
-is mostly designed for system services and to test libblkid functionality.
5f5089
-.PP
5f5089
 .B blkid
5f5089
 has two main forms of operation: either searching for a device with a
5f5089
 specific NAME=value pair, or displaying NAME=value pairs for one or
5f5089
 more specified devices.
5f5089
+.PP
5f5089
+For security reasons
5f5089
+.B blkid
5f5089
+silently ignores all devices where the probing result is ambivalent (multiple
5f5089
+colliding filesystems are detected).  The low-level probing mode (\fB-p\fR)
5f5089
+provides more information and extra return code in this case.
5f5089
+It's recommended to use
5f5089
+.BR wipefs (8)
5f5089
+to get a detailed overview and to erase obsolete stuff (magic strings) from the device.
5f5089
 .SH OPTIONS
5f5089
 The \fIsize\fR and \fIoffset\fR arguments may be followed by the multiplicative
5f5089
 suffixes like KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB
5f5089
@@ -264,7 +279,7 @@ identified, an exit code of 2 is returned.
5f5089
 
5f5089
 For usage or other errors, an exit code of 4 is returned.
5f5089
 
5f5089
-If an ambivalent low-level probing result was detected, an exit code of 8 is
5f5089
+If an ambivalent probing result was detected by low-level probing mode (\fB\-p\fR), an exit code of 8 is
5f5089
 returned.
5f5089
 .SH CONFIGURATION FILE
5f5089
 The standard location of the
5f5089
-- 
5f5089
2.13.6
5f5089