Skip to content

Commit d0de0a4

Browse files
xosevpmwilck
authored andcommitted
multipath-tools: specify file paths using variables and add FILES section in multipath.conf.5
Replace hardcoded file name references with their dynamic build variables. Also, add a dedicated FILES section at the end of the man page to clearly document configuration files/dirs. Suggested-by: Benjamin Marzinski <bmarzins@redhat.com> Cc: Martin Wilck <mwilck@suse.com> Cc: Benjamin Marzinski <bmarzins@redhat.com> Cc: Christophe Varoqui <christophe.varoqui@opensvc.com> Cc: DM_DEVEL-ML <dm-devel@lists.linux.dev> Signed-off-by: Xose Vazquez Perez <xose.vazquez@gmail.com> Reviewed-by: Martin Wilck <mwilck@suse.com>
1 parent ee3380e commit d0de0a4

1 file changed

Lines changed: 42 additions & 13 deletions

File tree

multipath/multipath.conf.5.in

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ or \fBmultipathd show config\fR command.
2727
.
2828
.PP
2929
Additional configuration can be made in drop-in files under
30-
.B @CONFIGDIR@.
30+
.BR @CONFIGDIR@/ .
3131
Files ending in \fI.conf\fR in this directory are read
3232
in alphabetical order, after reading \fI@CONFIGFILE@\fR.
3333
They use the same syntax as \fI@CONFIGFILE@\fR itself,
@@ -864,11 +864,11 @@ to the end of the reservation key.
864864
.RS
865865
.PP
866866
Alternatively, this can be set to \fBfile\fR, which will store the RESERVATION
867-
KEY registered by mpathpersist in the \fIprkeys_file\fR. multipathd will then
868-
use this key to register additional paths as they appear. When the
867+
KEY registered by mpathpersist in the \fI@STATE_DIR@/prkeys\fR file. multipathd
868+
will then use this key to register additional paths as they appear. When the
869869
registration is removed, the RESERVATION KEY is removed from the
870-
\fIprkeys_file\fR. The prkeys file will automatically keep track of whether
871-
the key was registered with \fI--param-aptpl\fR.
870+
\fI@STATE_DIR@/prkeys\fR file. The prkeys file will automatically keep track of
871+
whether the key was registered with \fI--param-aptpl\fR.
872872
.TP
873873
The default is: \fB<unset>\fR
874874
.RE
@@ -1189,9 +1189,9 @@ detects a new device. The following values are possible:
11891189
.I strict
11901190
Both multipath and multipathd treat only such devices as multipath devices
11911191
which have been part of a multipath map previously, and which are therefore
1192-
listed in the \fBwwids_file\fR. Users can manually set up multipath maps using the
1193-
\fBmultipathd add map\fR command. Once set up manually, the map is
1194-
remembered in the wwids file and will be set up automatically in the future.
1192+
listed in the \fI@STATE_DIR@/wwids\fR file. Users can manually set up multipath
1193+
maps using the \fBmultipathd add map\fR command. Once set up manually, the map is
1194+
remembered in the WWIDs file and will be set up automatically in the future.
11951195
.TP
11961196
.I off
11971197
Multipath behaves like \fBstrict\fR. Multipathd behaves like \fBgreedy\fR.
@@ -1551,8 +1551,8 @@ this is \fBnot\fR a regular expression or a substring; WWIDs must match
15511551
exactly inside the multipaths section.
15521552
.TP
15531553
.B alias
1554-
Symbolic name for the multipath map. This takes precedence over a an entry for
1555-
the same WWID in the \fIbindings_file\fR.
1554+
Symbolic name for the multipath map. This takes precedence over an entry for
1555+
the same WWID in the \fI@STATE_DIR@/bindings\fR file.
15561556
.LP
15571557
.
15581558
.
@@ -1642,9 +1642,9 @@ for more than 100 known multipath-capable storage devices. The devices section
16421642
can be used to override these settings. If there are multiple matches for a
16431643
given device, the attributes of all matching entries are applied to it.
16441644
If an attribute is specified in several matching device subsections,
1645-
later entries take precedence. Thus, entries in files under \fIconfig_dir\fR (in
1646-
reverse alphabetical order) have the highest precedence, followed by entries
1647-
in \fI@CONFIGFILE@\fR; the built-in hardware table has the lowest
1645+
later entries take precedence. Thus, entries in files under the \fI@CONFIGDIR@/\fR
1646+
directory (in reverse alphabetical order) have the highest precedence, followed
1647+
by entries in \fI@CONFIGFILE@\fR; the built-in hardware table has the lowest
16481648
precedence. Inside a configuration file, later entries have higher precedence
16491649
than earlier ones.
16501650
.LP
@@ -2084,6 +2084,35 @@ specified the order of precedence is \fIno_path_retry, queue_if_no_path, dev_los
20842084
.
20852085
.
20862086
.\" ----------------------------------------------------------------------------
2087+
.SH "FILES"
2088+
.\" ----------------------------------------------------------------------------
2089+
.
2090+
Default paths for configuration files and directories:
2091+
.TP
2092+
.I @CONFIGFILE@
2093+
Main configuration file.
2094+
.TP
2095+
.I @CONFIGDIR@/
2096+
Directory for configuration drop-in files.
2097+
.TP
2098+
.I @STATE_DIR@/bindings
2099+
Bindings file, used when the \fBuser_friendly_names\fR option is set to
2100+
\fByes\fR to assign a persistent and unique alias to each multipath device.
2101+
.TP
2102+
.I @STATE_DIR@/prkeys
2103+
Persistent reservation keys file, used by multipathd to keep track of the
2104+
reservation key used for a specific WWID when \fBreservation_key\fR is set
2105+
to \fBfile\fR.
2106+
.TP
2107+
.I @STATE_DIR@/wwids
2108+
WWIDs file, used by multipath to keep track of the WWIDs of LUNs for which
2109+
multipath devices have been created in the past.
2110+
.TP
2111+
.I @RUNTIME_DIR@/multipathd.pid
2112+
PID file.
2113+
.
2114+
.
2115+
.\" ----------------------------------------------------------------------------
20872116
.SH "SEE ALSO"
20882117
.\" ----------------------------------------------------------------------------
20892118
.

0 commit comments

Comments
 (0)