Make DB and ISCSIHOME directories configurable.

This commit adds two new top-level build options: one
for the "home" directory for open-iscsi called "HOMEDIR",
and one for the "database" directory, called "DBROOT". One can
now override the defaults of "/etc/iscsi" for either or
both of these directories on the make command line.
The README and man pages are updated with details about
these new options.

Some Makefile cleanup/repair was done as well. Installation
of the initiatorname.iscsi file, was moved out of the top-level
Makefile into the etc subdirectory, and installation of man
ages moved from the top-level Makefile to the doc subdirectory.

Also, this fixes some issues from commit fd14dd8316b1 ("Clean
p Makefile build system."), which incorrectly changed the DESTDIR
ariable in the Makefiles. This current commit also fixes the
top-level variable names for moving DBROOT and HOMEDIR.

1 files changed, 27 insertions, 13 deletions

diff --git a/README b/README
index fa66d30..08b2419 100644
--- a/README
+++ b/README
@@ -4,7 +4,7 @@
 
 =================================================================
 
-                                                   Sep 29, 2016
+                                                   Mar 30, 2022
 Contents
 ========
 
@@ -101,10 +101,21 @@ By default the kernel's iSCSI modules will be used. Running:
 	make install
 
 will install the iSCSI tools iscsiadm and iscsid to /sbin, by default,
-though that location can be overridden by passing in "sbindir", e.g. to
+though that location can be overridden by passing in "SBINDIR", e.g. to
 install in /usr/bin instead of /sbin:
 
-	make sbindir="/usr/sbin"
+	make SBINDIR="/usr/sbin"
+
+The default home directory for open-iscsi is /etc/iscsi. This
+directory is used for the open-iscsi database, and for the initiator
+name file initiatorname.iscsi and for the configuration file iscsid.conf.
+You can override these with two "make" parameters "HOMEDIR", for the
+initiator name and configuration files, and "DBROOT" for the open-iscsi
+databases. Both of these default to "/etc/iscsi". For example, the following
+would location the database file under /usr/lib/iscsi and leave the
+configuration and initiator name files in /etc/iscsi:
+
+	make DBROOT=/var/lib/iscsi
 
 To build and install iscsiuio, use something like:
 
@@ -126,7 +137,7 @@ iSCSI database (see next section).
 For help, run:
 	iscsid --help
 
-The output will be similar to the following.
+The output will be similar to the following (assuming a default install):
 
 Usage: iscsid [OPTION]
 
@@ -148,7 +159,8 @@ Usage: iscsid [OPTION]
 Open-iSCSI persistent configuration is stored in a number of
 directories under a configuration root directory, using a flat-file
 format. This configuration root directory is /etc/iscsi by default,
-but may also commonly be in /var/lib/iscsi.
+but may also commonly be in /var/lib/iscsi (see "DBROOT" in the Make
+options discussed earlier).
 
 Configuration is contained in directories for:
 
@@ -188,10 +200,10 @@ The output will be similar to the following.
 
 iscsiadm -m discoverydb [-hV] [-d debug_level] [-P printlevel] [-t type -p ip:port -I ifaceN ... [-Dl]] | [[-p ip:port -t type] [-o operation] [-n name] [-v value] [-lD]]
 iscsiadm -m discovery [-hV] [-d debug_level] [-P printlevel] [-t type -p ip:port -I ifaceN ... [-l]] | [[-p ip:port] [-l | -D]] [-W]
-iscsiadm -m node [-hV] [-d debug_level] [-P printlevel] [-L all,manual,automatic,onboot] [-W] [-U all,manual,automatic,onboot] [-S] [[-T targetname -p ip:port -I ifaceN] [-l | -u | -R | -s]] [[-o  operation ] [-n name] [-v value]]
-iscsiadm -m session [-hV] [-d debug_level] [-P  printlevel] [-r sessionid | sysfsdir [-R | -u | -s] [-o operation] [-n name] [-v value]]
-iscsiadm -m iface [-hV] [-d debug_level] [-P printlevel] [-I ifacename | -H hostno|MAC] [[-o  operation ] [-n name] [-v value]] [-C ping [-a ip] [-b packetsize] [-c count] [-i interval]]
-iscsiadm -m fw [-d debug_level] [-l] [-W]
+iscsiadm -m node [-hV] [-d debug_level] [-P printlevel] [-L all,manual,automatic,onboot] [-W] [-U all,manual,automatic,onboot] [-S] [[-T targetname -p ip:port -I ifaceN] [-l | -u | -R | -s]] [[-o operation ] [-n name] [-v value]]
+iscsiadm -m session [-hV] [-d debug_level] [-P printlevel] [-r sessionid | sysfsdir [-R | -u | -s] [-o operation] [-n name] [-v value]]
+iscsiadm -m iface [-hV] [-d debug_level] [-P printlevel] [-I ifacename | -H hostno|MAC] [[-o operation ] [-n name] [-v value]] [-C ping [-a ip] [-b packetsize] [-c count] [-i interval]]
+iscsiadm -m fw [-d debug_level] [-l] [-W] [[-n name] [-v value]]
 iscsiadm -m host [-P printlevel] [-H hostno|MAC] [[-C chap [-x chap_tbl_idx]] | [-C flashnode [-A portal_type] [-x flashnode_idx]] | [-C stats]] [[-o operation] [-n name] [-v value]]
 iscsiadm -k priority
 
@@ -1097,10 +1109,12 @@ Host mode with stats submode
 6. Configuration
 ================
 
-The default configuration file is /etc/iscsi/iscsid.conf. This file contains
-only configuration that could be overwritten by iSCSI Discovery,
-or manualy updated via iscsiadm utility. Its OK if this file does not
-exist, in which case compiled-in default configuration will take place
+The default configuration file is /etc/iscsi/iscsid.conf, but the
+directory is configurable with the top-level make option "homedir".
+The remainder of this document will assume the /etc/iscsi directory.
+This file contains only configuration that could be overwritten by iSCSI
+discovery, or manualy updated via iscsiadm utility. Its OK if this file
+does not exist, in which case compiled-in default configuration will take place
 for newer discovered Target nodes.
 
 See the man page and the example file for the current syntax.