aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaroly Lorentey2005-12-29 04:57:14 +0000
committerKaroly Lorentey2005-12-29 04:57:14 +0000
commit17ccbd91f620a84e7524b99b74077b4ddb736283 (patch)
treec74a9173a86d8dfb3f227deca1c9fcdc1d867b5d
parent01999e9d53e4e8d12314b16ce7d0e3d7785bfbe3 (diff)
downloademacs-17ccbd91f620a84e7524b99b74077b4ddb736283.tar.gz
emacs-17ccbd91f620a84e7524b99b74077b4ddb736283.zip
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: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-470
-rw-r--r--lisp/env.el19
-rw-r--r--src/callproc.c28
2 files changed, 26 insertions, 21 deletions
diff --git a/lisp/env.el b/lisp/env.el
index 38a9e865283..54bd0cdfb33 100644
--- a/lisp/env.el
+++ b/lisp/env.el
@@ -97,17 +97,18 @@ Use `$$' to insert a single dollar sign."
97(defun setenv (variable &optional value unset substitute-env-vars frame) 97(defun setenv (variable &optional value unset substitute-env-vars frame)
98 "Set the value of the environment variable named VARIABLE to VALUE. 98 "Set the value of the environment variable named VARIABLE to VALUE.
99VARIABLE should be a string. VALUE is optional; if not provided or 99VARIABLE should be a string. VALUE is optional; if not provided or
100nil, the environment variable VARIABLE will be removed. UNSET 100nil, the environment variable VARIABLE will be removed.
101if non-nil means to remove VARIABLE from the environment. 101UNSET if non-nil means to remove VARIABLE from the environment.
102SUBSTITUTE-ENV-VARS, if non-nil, means to substitute environment 102SUBSTITUTE-ENV-VARS, if non-nil, means to substitute environment
103variables in VALUE with `substitute-env-vars', where see. 103variables in VALUE with `substitute-env-vars', where see.
104Value is the new value if VARIABLE, or nil if removed from the 104Value is the new value if VARIABLE, or nil if removed from the
105environment. 105environment.
106 106
107Interactively, a prefix argument means to unset the variable. 107Interactively, a prefix argument means to unset the variable, and
108Interactively, the current value (if any) of the variable 108otherwise the current value (if any) of the variable appears at
109appears at the front of the history list when you type in the new value. 109the front of the history list when you type in the new value.
110Interactively, always replace environment variables in the new value. 110This function always replaces environment variables in the new
111value when called interactively.
111 112
112If VARIABLE is set in `process-environment', then this function 113If VARIABLE is set in `process-environment', then this function
113modifies its value there. Otherwise, this function works by 114modifies its value there. Otherwise, this function works by
@@ -212,11 +213,11 @@ VARIABLE should be a string. Value is nil if VARIABLE is undefined in
212the environment. Otherwise, value is a string. 213the environment. Otherwise, value is a string.
213 214
214If optional parameter FRAME is non-nil, then it should be a 215If optional parameter FRAME is non-nil, then it should be a
215frame. If the specified terminal device has its own set of 216frame. If that frame has its own set of environment variables,
216environment variables, this function will look up VARIABLE in it. 217this function will look up VARIABLE in there.
217 218
218Otherwise, this function searches `process-environment' for 219Otherwise, this function searches `process-environment' for
219VARIABLE. If it was not found there, then it continues the 220VARIABLE. If it is not found there, then it continues the
220search in either `global-environment' or the environment list of 221search in either `global-environment' or the environment list of
221the selected frame, depending on the value of 222the selected frame, depending on the value of
222`local-environment-variables'." 223`local-environment-variables'."
diff --git a/src/callproc.c b/src/callproc.c
index 715178f8fb2..3f7ce3ad5a5 100644
--- a/src/callproc.c
+++ b/src/callproc.c
@@ -1600,9 +1600,9 @@ that frame has its own set of environment variables, this function
1600will look up VARIABLE in there. 1600will look up VARIABLE in there.
1601 1601
1602Otherwise, this function searches `process-environment' for VARIABLE. 1602Otherwise, this function searches `process-environment' for VARIABLE.
1603If it was not found there, then it continues the search in either 1603If it is not found there, then it continues the search in either
1604`global-environment' or the local environment list of the current 1604`global-environment' or the environment list of the selected frame,
1605frame, depending on the value of `local-environment-variables'. */) 1605depending on the value of `local-environment-variables'. */)
1606 (variable, frame) 1606 (variable, frame)
1607 Lisp_Object variable, frame; 1607 Lisp_Object variable, frame;
1608{ 1608{
@@ -1843,8 +1843,9 @@ Emacs starts.
1843 1843
1844Some frames may have their own local list of environment variables in 1844Some frames may have their own local list of environment variables in
1845their 'environment parameter, which may override this global list; see 1845their 'environment parameter, which may override this global list; see
1846`local-environment-variables'. See `process-environment' for a way to 1846`local-environment-variables' and `frame-with-environment'. See
1847modify an environment variable on all frames. 1847`process-environment' for a way to modify an environment variable on
1848all frames.
1848 1849
1849If multiple entries define the same variable, the first one always 1850If multiple entries define the same variable, the first one always
1850takes precedence. 1851takes precedence.
@@ -1858,12 +1859,12 @@ See `setenv' and `getenv'. */);
1858Each element should be a string of the form ENVVARNAME=VALUE. 1859Each element should be a string of the form ENVVARNAME=VALUE.
1859 1860
1860Entries in this list take precedence to those in `global-environment' 1861Entries in this list take precedence to those in `global-environment'
1861or the frame-local environment. (See `local-environment-variables'.) 1862or the frame-local environments. (See `local-environment-variables'
1862Therefore, let-binding `process-environment' is an easy way to 1863and `frame-with-environment'.) Therefore, let-binding
1863temporarily change the value of an environment variable, irrespective 1864`process-environment' is an easy way to temporarily change the value
1864of where it comes from. To use `process-environment' to remove an 1865of an environment variable, irrespective of where it comes from. To
1865environment variable, include only its name in the list, without 1866use `process-environment' to remove an environment variable, include
1866"=VALUE". 1867only its name in the list, without "=VALUE".
1867 1868
1868This variable is set to nil when Emacs starts. 1869This variable is set to nil when Emacs starts.
1869 1870
@@ -1894,7 +1895,10 @@ frame-local environment.
1894 1895
1895Otherwise, `local-environment-variables' should be a list of variable 1896Otherwise, `local-environment-variables' should be a list of variable
1896names (represented by Lisp strings) to look up in the frame's 1897names (represented by Lisp strings) to look up in the frame's
1897environment. The rest will come from `global-environment'. */); 1898environment. The rest will come from `global-environment'.
1899
1900The frame-local environment is stored in the 'environment frame
1901parameter. See `frame-with-environment'. */);
1898 Vlocal_environment_variables = Qnil; 1902 Vlocal_environment_variables = Qnil;
1899} 1903}
1900 1904