emacs/gnu.emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2026-09-10 07:46:51 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

; Improve and correct documentation of 'getenv'

Browse source 
* lisp/env.el (getenv): Doc fix.

* doc/lispref/frames.texi (Basic Parameters): Document the
'environment' frame parameter.
* doc/lispref/os.texi (System Environment): Document the FRAME
argument to 'getenv'.  (Bug#81591)
This commit is contained in:
Eli Zaretskii 2026-08-10 17:51:12 +03:00
parent 83ec0fd8f3
commit 5f6ffef879
3 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/lispref/frames.texi
View file

@ -1665,6 +1665,12 @@ looking up X resources for the frame.
If the frame name was specified explicitly when the frame was created,
this parameter will be that name. If the frame wasn't explicitly
named, this parameter will be @code{nil}.
@vindex environment@r{, a frame parameter}
@item environment
The list of strings, each one describing one environment variable. This
list is similar to the one in @code{process-environment} (@pxref{System
Environment}), but it lists variables and values specific to the frame.
@end table

12
doc/lispref/os.texi
View file

@ -1023,6 +1023,18 @@ in the environment, @code{getenv} returns @code{nil}. It returns
@samp{""} if @var{var} is set but null. Within Emacs, a list of environment
variables and their values is kept in the variable @code{process-environment}.
Optional argument @var{frame}, if non-@code{nil}, specifies a frame, in
which case the function searches @var{frame}'s parameter
@code{environment} (@pxref{Basic Parameters}) for @var{var} instead of
looking for it in @code{process-environment}.
@cindex DISPLAY environment variable search
The @samp{DISPLAY} environment variable is treated specially when
@var{frame} is omitted or @code{nil}: if that variable is not found in
@code{process-environment}, the function looks at the selected-frame's
@code{display} parameter, and if that is @code{nil}, it also looks in
@code{initial-environment}.
@example
@group
(getenv "USER")

7
lisp/env.el
View file

@ -201,12 +201,13 @@ VARIABLE should be a string. Value is nil if VARIABLE is undefined in
the environment. Otherwise, value is a string.
If optional parameter FRAME is non-nil, then it should be a
frame. This function will look up VARIABLE in its `environment'
frame. This function will look up VARIABLE in FRAME's `environment'
parameter.
Otherwise, this function searches `process-environment' for
VARIABLE. If it is not found there, then it continues the search
in the environment list of the selected frame."
VARIABLE and returns its value if found. If not found, and VARIABLE
is \"DISPLAY\", the function uses the `display' parameter of the selected
frame, and if that is also nil, it searches the `initial-environment' list."
(declare (ftype (function (string &optional frame) (or null string)))
(side-effect-free t))
(interactive (list (read-envvar-name "Get environment variable: " t)))