comparison src/callproc.c @ 83430:10f26433fe3f

Update environment-related doc strings. * lisp/env.el (setenv, getenv): Update doc strings. * src/callproc.c (Fgetenv_internal, syms_of_callproc): Update doc strings. git-archimport-id: [e-mail]--2004/emacs--multi-tty--0--patch-470

83429:ec395f552d45

If optional parameter FRAME is non-nil, then it should be a frame.  If
that frame has its own set of environment variables, this function
will look up VARIABLE in there.

Otherwise, this function searches `process-environment' for VARIABLE.
If it was not found there, then it continues the search in either
`global-environment' or the local environment list of the current
frame, depending on the value of `local-environment-variables'.  */)
     (variable, frame)
     Lisp_Object variable, frame;
{
  char *value;
  int valuelen;

The environment which Emacs inherits is placed in this variable when
Emacs starts.

Some frames may have their own local list of environment variables in
their 'environment parameter, which may override this global list; see
`local-environment-variables'.  See `process-environment' for a way to
modify an environment variable on all frames.

If multiple entries define the same variable, the first one always
takes precedence.

Non-ASCII characters are encoded according to the initial value of

  DEFVAR_LISP ("process-environment", &Vprocess_environment,
	       doc: /* List of overridden environment variables for subprocesses to inherit.
Each element should be a string of the form ENVVARNAME=VALUE.

Entries in this list take precedence to those in `global-environment'
or the frame-local environment.  (See `local-environment-variables'.)
Therefore, let-binding `process-environment' is an easy way to
temporarily change the value of an environment variable, irrespective
of where it comes from.  To use `process-environment' to remove an
environment variable, include only its name in the list, without
"=VALUE".

This variable is set to nil when Emacs starts.

If multiple entries define the same variable, the first one always
takes precedence.

If set to nil, Emacs uses `global-environment' and ignores the
frame-local environment.

Otherwise, `local-environment-variables' should be a list of variable
names (represented by Lisp strings) to look up in the frame's
environment.  The rest will come from `global-environment'.  */);
  Vlocal_environment_variables = Qnil;
}

/* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
   (do not change this comment) */

83430:10f26433fe3f

If optional parameter FRAME is non-nil, then it should be a frame.  If
that frame has its own set of environment variables, this function
will look up VARIABLE in there.

Otherwise, this function searches `process-environment' for VARIABLE.
If it is not found there, then it continues the search in either
`global-environment' or the environment list of the selected frame,
depending on the value of `local-environment-variables'.  */)
     (variable, frame)
     Lisp_Object variable, frame;
{
  char *value;
  int valuelen;

The environment which Emacs inherits is placed in this variable when
Emacs starts.

Some frames may have their own local list of environment variables in
their 'environment parameter, which may override this global list; see
`local-environment-variables' and `frame-with-environment'.  See
`process-environment' for a way to modify an environment variable on
all frames.

If multiple entries define the same variable, the first one always
takes precedence.

Non-ASCII characters are encoded according to the initial value of

  DEFVAR_LISP ("process-environment", &Vprocess_environment,
	       doc: /* List of overridden environment variables for subprocesses to inherit.
Each element should be a string of the form ENVVARNAME=VALUE.

Entries in this list take precedence to those in `global-environment'
or the frame-local environments.  (See `local-environment-variables'
and `frame-with-environment'.)  Therefore, let-binding
`process-environment' is an easy way to temporarily change the value
of an environment variable, irrespective of where it comes from.  To
use `process-environment' to remove an environment variable, include
only its name in the list, without "=VALUE".

This variable is set to nil when Emacs starts.

If multiple entries define the same variable, the first one always
takes precedence.

If set to nil, Emacs uses `global-environment' and ignores the
frame-local environment.

Otherwise, `local-environment-variables' should be a list of variable
names (represented by Lisp strings) to look up in the frame's
environment.  The rest will come from `global-environment'.

The frame-local environment is stored in the 'environment frame
parameter.  See `frame-with-environment'.  */);
  Vlocal_environment_variables = Qnil;
}

/* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
   (do not change this comment) */