From 5e1f794158aaee1e4d6f69f6ce9bd076a1b4a657 Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Tue, 15 Oct 2013 14:13:03 +0200 Subject: [PATCH] Document that configuration file should not be used --- README.md | 25 ++++++++++++++----------- novaboot | 25 ++++++++++++++----------- 2 files changed, 28 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d565f8a..410dcbd 100644 --- 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: diff --git a/novaboot b/novaboot index 6986557..c7b7611 100755 --- 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: -- 2.39.2