From dca58219584c1163a9fbf88fccea885eb53bf2af Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Mon, 4 Mar 2019 14:19:55 +0100 Subject: environment: Rename '--inherit' to '--preserve'. Suggested by Eric Bavier and Ricardo Wurmus. * guix/scripts/environment.scm (show-help, %options): Emit a deprecation warning for "--inherit" and add -E/--preserve. * tests/guix-environment.sh: Adjust accordingly. * doc/guix.texi (Invoking guix environment): Update accordingly. --- doc/guix.texi | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/guix.texi b/doc/guix.texi index 7fcfcb1454..1b77881eb6 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -4456,17 +4456,18 @@ that will be added to the environment directly. @item --pure Unset existing environment variables when building the new environment, except -those specified with @option{--inherit} (see below.) This has the effect of +those specified with @option{--preserve} (see below.) This has the effect of creating an environment in which search paths only contain package inputs. -@item --inherit=@var{regexp} -When used alongside @option{--pure}, inherit all the environment variables +@item --preserve=@var{regexp} +@itemx -E @var{regexp} +When used alongside @option{--pure}, preserve the environment variables matching @var{regexp}---in other words, put them on a ``white list'' of environment variables that must be preserved. This option can be repeated several times. @example -guix environment --pure --inherit=^SLURM --ad-hoc openmpi @dots{} \ +guix environment --pure --preserve=^SLURM --ad-hoc openmpi @dots{} \ -- mpirun @dots{} @end example -- cgit v1.2.3