[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnuastro-commits] master 381634b1: Book: minor edits/clarifications to
From: |
Mohammad Akhlaghi |
Subject: |
[gnuastro-commits] master 381634b1: Book: minor edits/clarifications to description of --config-prefix |
Date: |
Sun, 7 May 2023 19:33:31 -0400 (EDT) |
branch: master
commit 381634b1292474036f0c85dc63f39ff8b6f39290
Author: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Book: minor edits/clarifications to description of --config-prefix
Until now, the description was not too clear in a few points.
With this commit, it has been edited to help in clarity.
---
doc/gnuastro.texi | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index b8e577fd..95d21a65 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -11221,18 +11221,18 @@ Only options that are parsed after this option are
printed, so to see the parsin
This is a very good option to confirm where the value of each option is has
been defined in scenarios where there are multiple configuration files (for
debugging).
@item --config-prefix=STR
-Accept option names in configuration files that start with the given prefix
and ignore the prefix when comparing options within the configuration file with
the program's option names.
-This gives unique features to Gnuastro's configuration files, especially in
large pipelines.
-
-Since order matters when reading custom configuration files, this option
should be called @strong{before} the @option{--config} option(s).
+Accept option names in configuration files that start with the given prefix.
+Since order matters when reading custom configuration files, this option
should be called @strong{before} the @option{--config} option(s) that contain
options with the given prefix.
+This option does not affect the options within configuration files that have
the standard name (without a prefix).
+This gives unique features to Gnuastro's configuration files, especially in
large pipelines.
Let's demonstrate this with the simple scenario below.
You have multiple configuration files for different instances of one program
(let's assume @file{nc-a.conf} and @file{nc-b.conf}).
-At the same time, want to load all the option names/values into your shell as
environment variables (for example with @code{source nc-*.conf}).
-This happens when you want to use the options value in other parts of the your
script also.
+At the same time, want to load all the option names/values into your shell as
environment variables (for example with @code{source}).
+This happens when you want to use the options as shell variables in other
parts of the your pipeline.
-If you don't use @code{--config-prefix}, the shell will over-write the common
option values between the configuration files.
-But thanks to @code{--config-prefix}, you can give a different prefix to the
different instances of the same option in different configuration files.
+If the two configuration files have different values for the same option (as
shown below), and you don't use @code{--config-prefix}, the shell will
over-write the common option values between the configuration files.
+But thanks to @code{--config-prefix}, you can give a different prefix for the
different instances of the same option in different configuration files.
@example
$ cat nc-a.conf
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [gnuastro-commits] master 381634b1: Book: minor edits/clarifications to description of --config-prefix,
Mohammad Akhlaghi <=