From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001

From: Benjamin Marzinski <bmarzins@redhat.com>

Date: Wed, 10 Nov 2021 18:34:08 -0600

Subject: [PATCH] libmultipath: deprecate file and directory config options

Having multipath able to select pathnames for the files and directories

it needs causes unnecessary maintainer headaches. Mark these as

deprecated, but still support them for now.

Signed-off-by: Benjamin Marzinski <bmarzins@redhat.com>

---

 libmultipath/dict.c        | 19 +++++++++++++++----

 multipath/multipath.conf.5 |  5 +++++

 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/libmultipath/dict.c b/libmultipath/dict.c

index 149d3348..d14be340 100644

--- a/libmultipath/dict.c

+++ b/libmultipath/dict.c

@@ -268,6 +268,15 @@ def_ ## option ## _handler (struct config *conf, vector strvec,		\

 	return function (strvec, &conf->option, file, line_nr);		\

 }

+#define declare_def_warn_handler(option, function)			\

+static int								\

+def_ ## option ## _handler (struct config *conf, vector strvec,		\

+			    const char *file, int line_nr)		\

+{									\

+	condlog(2, "%s line %d, \"" #option "\" is deprecated and will be disabled in a future release", file, line_nr);				\

+	return function (strvec, &conf->option, file, line_nr);		\

+}

+

 #define declare_def_range_handler(option, minval, maxval)			\

 static int								\

 def_ ## option ## _handler (struct config *conf, vector strvec,         \

@@ -421,7 +430,7 @@ declare_def_snprint(verbosity, print_int)

 declare_def_handler(reassign_maps, set_yes_no)

 declare_def_snprint(reassign_maps, print_yes_no)

-declare_def_handler(multipath_dir, set_dir)

+declare_def_warn_handler(multipath_dir, set_dir)

 declare_def_snprint(multipath_dir, print_str)

 static int def_partition_delim_handler(struct config *conf, vector strvec,

@@ -654,13 +663,13 @@ declare_hw_snprint(user_friendly_names, print_yes_no_undef)

 declare_mp_handler(user_friendly_names, set_yes_no_undef)

 declare_mp_snprint(user_friendly_names, print_yes_no_undef)

-declare_def_handler(bindings_file, set_path)

+declare_def_warn_handler(bindings_file, set_path)

 declare_def_snprint(bindings_file, print_str)

-declare_def_handler(wwids_file, set_path)

+declare_def_warn_handler(wwids_file, set_path)

 declare_def_snprint(wwids_file, print_str)

-declare_def_handler(prkeys_file, set_path)

+declare_def_warn_handler(prkeys_file, set_path)

 declare_def_snprint(prkeys_file, print_str)

 declare_def_handler(retain_hwhandler, set_yes_no_undef)

@@ -760,6 +769,8 @@ def_config_dir_handler(struct config *conf, vector strvec, const char *file,

 	/* this is only valid in the main config file */

 	if (conf->processed_main_config)

 		return 0;

+	condlog(2, "%s line %d, \"config_dir\" is deprecated and will be disabled in a future release",

+		file, line_nr);

 	return set_path(strvec, &conf->config_dir, file, line_nr);

 }

 declare_def_snprint(config_dir, print_str)

diff --git a/multipath/multipath.conf.5 b/multipath/multipath.conf.5

index dd9f4dc7..7f85f766 100644

--- a/multipath/multipath.conf.5

+++ b/multipath/multipath.conf.5

@@ -178,6 +178,7 @@ The default is: \fBno\fR

 .

 .TP

 .B multipath_dir

+This option is deprecated, and will be removed in a future release.

 Directory where the dynamic shared objects are stored. Defined at compile time,

 commonly \fI/lib64/multipath/\fR or \fI/lib/multipath/\fR.

 .RS

@@ -742,6 +743,7 @@ The default is: \fB<unset>\fR

 .

 .TP

 .B bindings_file

+This option is deprecated, and will be removed in a future release.

 The full pathname of the binding file to be used when the user_friendly_names

 option is set.

 .RS

@@ -752,6 +754,7 @@ The default is: \fB/etc/multipath/bindings\fR

 .

 .TP

 .B wwids_file

+This option is deprecated, and will be removed in a future release.

 The full pathname of the WWIDs file, which is used by multipath to keep track

 of the WWIDs for LUNs it has created multipath devices on in the past.

 .RS

@@ -762,6 +765,7 @@ The default is: \fB/etc/multipath/wwids\fR

 .

 .TP

 .B prkeys_file

+This option is deprecated, and will be removed in a future release.

 The full pathname of the prkeys file, which is used by multipathd to keep

 track of the persistent reservation key used for a specific WWID, when

 \fIreservation_key\fR is set to \fBfile\fR.

@@ -933,6 +937,7 @@ The default is: \fB<unset>\fR

 .

 .TP

 .B config_dir

+This option is deprecated, and will be removed in a future release.

 If set to anything other than "", multipath will search this directory

 alphabetically for file ending in ".conf" and it will read configuration

 information from them, just as if it was in \fI/etc/multipath.conf\fR.