summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLukasz Florczak <lukasz.florczak@linux.intel.com>2022-03-18 09:26:04 +0100
committerJes Sorensen <jsorensen@fb.com>2022-04-04 21:12:54 -0400
commite9dd5644843e2013a7dd1a8a5da2b9fa35837416 (patch)
tree56a1e3bebe5e121f7d52afce02e6d3dccdcfaaf9
parent83a379cfbd283b387919fe05d44eb4c49e155ad6 (diff)
downloadmdadm-e9dd5644843e2013a7dd1a8a5da2b9fa35837416.tar.gz
mdadm: Respect config file location in man
Default config file location could differ depending on OS (e.g. Debian family). This patch takes default config file into consideration when creating mdadm.man file as well as mdadm.conf.man. Rename mdadm.conf.5 to mdadm.conf.5.in. Now mdadm.conf.5 is generated automatically. Signed-off-by: Lukasz Florczak <lukasz.florczak@linux.intel.com> Acked-by: Coly Li <colyli@suse.de> Signed-off-by: Jes Sorensen <jsorensen@fb.com>
-rw-r--r--.gitignore1
-rw-r--r--Makefile7
-rw-r--r--mdadm.8.in16
-rw-r--r--mdadm.conf.5.in (renamed from mdadm.conf.5)2
4 files changed, 16 insertions, 10 deletions
diff --git a/.gitignore b/.gitignore
index 217fe76d..8d791c6f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@
/*-stamp
/mdadm
/mdadm.8
+/mdadm.conf.5
/mdadm.udeb
/mdassemble
/mdmon
diff --git a/Makefile b/Makefile
index 2a51d813..bf126033 100644
--- a/Makefile
+++ b/Makefile
@@ -227,7 +227,12 @@ raid6check : raid6check.o mdadm.h $(CHECK_OBJS)
mdadm.8 : mdadm.8.in
sed -e 's/{DEFAULT_METADATA}/$(DEFAULT_METADATA)/g' \
- -e 's,{MAP_PATH},$(MAP_PATH),g' mdadm.8.in > mdadm.8
+ -e 's,{MAP_PATH},$(MAP_PATH),g' -e 's,{CONFFILE},$(CONFFILE),g' \
+ -e 's,{CONFFILE2},$(CONFFILE2),g' mdadm.8.in > mdadm.8
+
+mdadm.conf.5 : mdadm.conf.5.in
+ sed -e 's,{CONFFILE},$(CONFFILE),g' \
+ -e 's,{CONFFILE2},$(CONFFILE2),g' mdadm.conf.5.in > mdadm.conf.5
mdadm.man : mdadm.8
man -l mdadm.8 > mdadm.man
diff --git a/mdadm.8.in b/mdadm.8.in
index e2a42425..8b21ffd4 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -267,13 +267,13 @@ the exact meaning of this option in different contexts.
.TP
.BR \-c ", " \-\-config=
Specify the config file or directory. Default is to use
-.B /etc/mdadm.conf
+.B {CONFFILE}
and
-.BR /etc/mdadm.conf.d ,
+.BR {CONFFILE}.d ,
or if those are missing then
-.B /etc/mdadm/mdadm.conf
+.B {CONFFILE2}
and
-.BR /etc/mdadm/mdadm.conf.d .
+.BR {CONFFILE2}.d .
If the config file given is
.B "partitions"
then nothing will be read, but
@@ -2014,9 +2014,9 @@ The config file is only used if explicitly named with
or requested with (a possibly implicit)
.BR \-\-scan .
In the later case,
-.B /etc/mdadm.conf
+.B {CONFFILE}
or
-.B /etc/mdadm/mdadm.conf
+.B {CONFFILE2}
is used.
If
@@ -3344,7 +3344,7 @@ uses this to find arrays when
is given in Misc mode, and to monitor array reconstruction
on Monitor mode.
-.SS /etc/mdadm.conf
+.SS {CONFFILE} (or {CONFFILE2})
The config file lists which devices may be scanned to see if
they contain MD super block, and gives identifying information
@@ -3352,7 +3352,7 @@ they contain MD super block, and gives identifying information
.BR mdadm.conf (5)
for more details.
-.SS /etc/mdadm.conf.d
+.SS {CONFFILE}.d (or {CONFFILE2}.d)
A directory containing configuration files which are read in lexical
order.
diff --git a/mdadm.conf.5 b/mdadm.conf.5.in
index 74a21c5f..83edd008 100644
--- a/mdadm.conf.5
+++ b/mdadm.conf.5.in
@@ -8,7 +8,7 @@
.SH NAME
mdadm.conf \- configuration for management of Software RAID with mdadm
.SH SYNOPSIS
-/etc/mdadm.conf
+{CONFFILE}
.SH DESCRIPTION
.PP
.I mdadm