On 10/10/25 3:05 PM, Martin Wilck wrote:
On Fri, 2025-10-10 at 14:37 +0200, Xose Vazquez Perez wrote:
On 10/10/25 1:20 PM, Martin Wilck wrote:
I believe our man pages have more serious issues; for example, we
use
so deep indentation in multipath.conf.5 that the page is hardly
readable on narrow terminals.
I do not think so:
export LC_ALL=en_US.UTF-8 MANROFFSEQ="" MANWIDTH=80
man ./multipath/multipath.conf.5.in
It is displayed correctly, except for these three lines:
Yes it's "correct". But it's very hard to read. Lots of empty space on
the left and narrow text column on the right.
Martin
Maybe this can help.
From 1ba649e12314aa69952658cd80230ca13f48f974 Mon Sep 17 00:00:00 2001
From: Xose Vazquez Perez <[email protected]>
Date: Wed, 15 Oct 2025 23:55:46 +0200
Subject: [PATCH] alleviate the indent in multipath.conf.5.in
X-Patchwork-Bot: notify
Cc: Martin Wilck <[email protected]>
Cc: Benjamin Marzinski <[email protected]>
Cc: Christophe Varoqui <[email protected]>
Cc: DM_DEVEL-ML <[email protected]>
Signed-off-by: Xose Vazquez Perez <[email protected]>
---
multipath/multipath.conf.5.in | 56 +++++++++++++++++------------------
1 file changed, 28 insertions(+), 28 deletions(-)
diff --git a/multipath/multipath.conf.5.in b/multipath/multipath.conf.5.in
index 3c9ae097..3dc7c65b 100644
--- a/multipath/multipath.conf.5.in
+++ b/multipath/multipath.conf.5.in
@@ -103,7 +103,7 @@ matches, standard regular expression syntax using the special
characters "^" and
.LP
.
The following \fIsection\fP keywords are recognized:
-.TP 17
+.TP
.B defaults
This section defines default values for attributes which are used
whenever no values are given in the appropriate device or multipath
@@ -142,7 +142,7 @@ device-specific settings for all devices.
The \fIdefaults\fR section recognizes the following keywords:
.
.
-.TP 17
+.TP
.B verbosity
Default verbosity. Higher values increase the verbosity level. Valid
levels are between 0 and 6.
@@ -195,7 +195,7 @@ The default is: \fBno\fR
The default path selector algorithm to use; they are offered by the
kernel multipath target:
.RS
-.TP 12
+.TP
.I "round-robin 0"
Choose the path for the next bunch of I/O by looping through every path in the
path group, sending \fBthe same number of I/O requests\fR to each path. Some
@@ -224,7 +224,7 @@ The default is: \fBservice-time 0\fR
(Hardware-dependent) The default path grouping policy to apply to unspecified
multipaths. Possible values are:
.RS
-.TP 12
+.TP
.I failover
One path per priority group.
.TP
@@ -334,7 +334,7 @@ of this path. Higher number have a higher priority.
\fI"none"\fR is a valid value. Currently the following path priority routines
are implemented:
.RS
-.TP 12
+.TP
.I const
Return a constant priority of \fI1\fR.
.TP
@@ -409,12 +409,12 @@ NetAPP E/EF Series, where it is \fBalua\fR). If
\fBdetect_prio\fR is
Arguments to pass to to the prio function. This only applies to certain
prioritizers:
.RS
-.TP 12
+.TP
.I weighted
Needs a value of the form
\fI"<hbtl|devname|serial|wwn> <regex1> <prio1> <regex2> <prio2> ..."\fR
.RS
-.TP 8
+.TP
.I hbtl
Regex can be of SCSI H:B:T:L format. For example: 1:0:.:. , *:0:0:.
.TP
@@ -431,11 +431,11 @@ Regex can be of the form
\fI"host_wwnn:host_wwpn:target_wwnn:target_wwpn"\fR
these values can be looked up through sysfs or by running \fImultipathd show
paths format
"%N:%R:%n:%r"\fR. For example: 0x200100e08ba0aea0:0x210100e08ba0aea0:.*:.* ,
.*:.*:iqn.2009-10.com.redhat.msp.lab.ask-06:.*
.RE
-.TP 12
+.TP
.I path_latency
Needs a value of the form "io_num=\fI<20>\fR base_num=\fI<10>\fR"
.RS
-.TP 8
+.TP
.I io_num
The number of read IOs sent to the current path continuously, used to
calculate the average path latency.
Valid Values: Integer, [20, 200].
@@ -446,7 +446,7 @@ Double-precision floating-point, [1.1, 10]. And Max average
latency value is 100
For example: If base_num=10, the paths will be grouped in priority groups with
path latency <=1us, (1us, 10us],
(10us, 100us], (100us, 1ms], (1ms, 10ms], (10ms, 100ms], (100ms, 1s], (1s, 10s],
(10s, 100s], >100s.
.RE
-.TP 12
+.TP
.I alua
If \fIexclusive_pref_bit\fR is set, paths with the \fIpreferred path\fR bit
set will always be in their own path group.
@@ -457,17 +457,17 @@ set will always be in their own path group.
.TP
.I datacore
.RS
-.TP 8
+.TP
.I preferredsds
(Mandatory) The preferred "SDS name".
.TP
.I timeout
(Optional) The timeout for the INQUIRY, in ms.
.RE
-.TP 12
+.TP
.I iet
.RS
-.TP 8
+.TP
.I preferredip=...
(Mandatory) Th preferred IP address, in dotted decimal notation, for iSCSI
targets.
.RE
@@ -482,7 +482,7 @@ Specify any device-mapper features to be used. Syntax is
\fInum list\fR
where \fInum\fR is the number, between 0 and 8, of features in \fIlist\fR.
Possible values for the feature list are:
.RS
-.TP 12
+.TP
.I queue_if_no_path
(Deprecated, superseded by \fIno_path_retry\fR) Queue I/O if no path is active.
Identical to the \fIno_path_retry\fR with \fIqueue\fR value. If both this
@@ -521,7 +521,7 @@ to respond. The asynchronous checkers (\fItur\fR and
\fIdirectio\fR) will not
pause multipathd. Instead, multipathd will check for a response once per
second, until \fIchecker_timeout\fR seconds have elapsed. Possible values are:
.RS
-.TP 12
+.TP
.I readsector0
(Deprecated) Read the first sector of the device. This checker is being
deprecated, please use \fItur\fR or \fIdirectio\fR instead.
@@ -575,7 +575,7 @@ Tell multipathd how to manage path group failback.
To select \fIimmediate\fR or a \fIvalue\fR, it's mandatory that the device
has support for a working prioritizer.
.RS
-.TP 12
+.TP
.I immediate
Immediately failback to the highest priority pathgroup that contains
active paths.
@@ -650,7 +650,7 @@ The default is: \fBuniform\fR
.B no_path_retry
Specify what to do when all paths are down. Possible values are:
.RS
-.TP 12
+.TP
.I value > 0
Number of retries until disable I/O queueing.
.TP
@@ -1192,7 +1192,7 @@ blocked from further processing by higher layers - such
as LVM - if and only
if it\'s considered a valid multipath device path), and b) when multipathd
detects a new device. The following values are possible:
.RS
-.TP 10
+.TP
.I strict
Both multipath and multipathd treat only such devices as multipath devices
which have been part of a multipath map previously, and which are therefore
@@ -1444,7 +1444,7 @@ by multipath-tools.
.
The following keywords are recognized in both sections. The defaults are empty
unless explicitly stated.
-.TP 17
+.TP
.B devnode
Regular expression matching the device nodes to be excluded/included.
.RS
@@ -1534,7 +1534,7 @@ from later entries take precedence.
.
.
The \fImultipath\fR subsection recognizes the following attributes:
-.TP 17
+.TP
.B wwid
(Mandatory) World Wide Identifier. Detected multipath maps are matched against
this attribute.
Note that, unlike the \fIwwid\fR attribute in the \fIblacklist\fR section,
@@ -1553,7 +1553,7 @@ section:
.sp 1
.PD .1v
.RS
-.TP 18
+.TP
.B path_grouping_policy
.TP
.B path_selector
@@ -1614,7 +1614,7 @@ section:
.SH "devices section"
.\"
----------------------------------------------------------------------------
.
-.TP 4
+.TP
.B Important:
The built-in hardware device table of
.I multipath-tools
@@ -1650,7 +1650,7 @@ for all devices in the system.
.LP
.
The \fIdevice\fR subsection recognizes the following attributes:
-.TP 17
+.TP
.B vendor
(Mandatory) Regular expression to match the vendor name.
.RS
@@ -1693,7 +1693,7 @@ and \fImultipathd show paths format\fR commands.
Currently only the
The hardware handler to use for this device type.
The following hardware handler are implemented:
.RS
-.TP 12
+.TP
.I 1 emc
(Hardware-dependent)
Hardware handler for DGC class arrays as CLARiiON CX/AX and EMC VNX families
@@ -1734,7 +1734,7 @@ section:
.sp 1
.PD .1v
.RS
-.TP 18
+.TP
.B path_grouping_policy
.TP
.B uid_attribute
@@ -1816,7 +1816,7 @@ the values are taken from the \fIdevices\fR or
\fIdefaults\fR sections:
.sp 1
.PD .1v
.RS
-.TP 18
+.TP
.B path_grouping_policy
.TP
.B uid_attribute
@@ -1934,7 +1934,7 @@ which paths belong to the same device. Each path
presenting the same
WWID is assumed to point to the same device.
.LP
The WWID is generated by four methods (in the order of preference):
-.TP 17
+.TP
.B uid_attrs
The WWID is derived from udev attributes by matching the device node name; cf
\fIuid_attrs\fR above.
@@ -1974,7 +1974,7 @@ pathgroups will not be used until all other pathgroups
have been tried. At the
time when the path would normally be reinstated, it will be returned to its
normal pathgroup. The logic of determining \(dqshaky\(dq condition, as well as
the logic when to reinstate, differs between the three methods.
-.TP 8
+.TP
.B \(dqdelay_checks\(dq failure tracking
(Deprecated) This method is \fBdeprecated\fR and mapped to the
\(dqsan_path_err\(dq method.
See the \fIdelay_watch_checks\fR and \fIdelay_wait_checks\fR options above
--
2.51.0
