]> rtime.felk.cvut.cz Git - novaboot.git/commitdiff
Document that configuration file should not be used
authorMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 15 Oct 2013 12:13:03 +0000 (14:13 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Tue, 15 Oct 2013 12:13:03 +0000 (14:13 +0200)
README.md
novaboot

index d565f8adc41523e6d391589867b5c46a159e5281..410dcbdb5261ab3a8ca557df137cdd978ebf9ef2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -330,17 +330,20 @@ The following variables are interpreted in the novaboot script:
 
 # CONFIGURATION FILE
 
-novaboot can read its configuration from ~/.novaboot file (or another
-file specified with __\-c__ parameter or NOVABOOT\_CONFIG environment
-variable). It is a file with perl syntax, which sets values of certain
-variables. The current configuration can be dumped with
-__\--dump-config__ switch. Use
-
-    novaboot --dump-config > ~/.novaboot
-
-to create a default configuration file and modify it to your needs.
-Some configuration variables can be overriden by environment variables
-(see below) or by command line switches.
+Novaboot can read its configuration from a file. Configuration file
+was necessary in early days of novaboot. Nowadays, the attempt is made
+to not use the configuration file because it makes certain novaboot
+scripts unusable on systems without (or with different) configuration
+file. The only recommended use of the configuration file is to specify
+custom\_options (see bellow).
+
+If you decide to use the configuration file, its default location is
+~/.novaboot, other location can be specified __\-c__ parameter or with
+NOVABOOT\_CONFIG environment variable. The configuration has perl
+syntax and sets values of certain variables. The current configuration
+can be dumped with __\--dump-config__ switch. Some configuration
+variables can be overriden by environment variables (see below) or by
+command line switches.
 
 Documentation of some configuration variables follows:
 
index 698655772beaa8d1ba2514cb9d8d584a06f0e08d..c7b76111f28e0ac3164193bb38231f843c09996c 100755 (executable)
--- a/novaboot
+++ b/novaboot
@@ -1075,17 +1075,20 @@ defined and non-empty, the variable HYPERVISOR_PARAMS is not used.
 
 =head1 CONFIGURATION FILE
 
-novaboot can read its configuration from ~/.novaboot file (or another
-file specified with B<-c> parameter or NOVABOOT_CONFIG environment
-variable). It is a file with perl syntax, which sets values of certain
-variables. The current configuration can be dumped with
-B<--dump-config> switch. Use
-
-    novaboot --dump-config > ~/.novaboot
-
-to create a default configuration file and modify it to your needs.
-Some configuration variables can be overriden by environment variables
-(see below) or by command line switches.
+Novaboot can read its configuration from a file. Configuration file
+was necessary in early days of novaboot. Nowadays, the attempt is made
+to not use the configuration file because it makes certain novaboot
+scripts unusable on systems without (or with different) configuration
+file. The only recommended use of the configuration file is to specify
+custom_options (see bellow).
+
+If you decide to use the configuration file, its default location is
+~/.novaboot, other location can be specified B<-c> parameter or with
+NOVABOOT_CONFIG environment variable. The configuration has perl
+syntax and sets values of certain variables. The current configuration
+can be dumped with B<--dump-config> switch. Some configuration
+variables can be overriden by environment variables (see below) or by
+command line switches.
 
 Documentation of some configuration variables follows: