[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/exec-path-from-shell 900d98a912 005/114: Improve docstring
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/exec-path-from-shell 900d98a912 005/114: Improve docstrings |
Date: |
Tue, 5 Sep 2023 03:59:56 -0400 (EDT) |
branch: elpa/exec-path-from-shell
commit 900d98a912300247685250a67185d974cd32b4f7
Author: Sebastian Wiesner <lunaryorn@gmail.com>
Commit: Sebastian Wiesner <lunaryorn@gmail.com>
Improve docstrings
---
exec-path-from-shell.el | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/exec-path-from-shell.el b/exec-path-from-shell.el
index f68251cfc3..c507a750b0 100644
--- a/exec-path-from-shell.el
+++ b/exec-path-from-shell.el
@@ -57,6 +57,10 @@
;;; Code:
(defun exec-path-from-shell-getenv (name)
+ "Get the environment variable NAME from the user's shell.
+
+Execute $SHELL as interactive login shell, have it output the
+variable of NAME and return this output as string."
(with-temp-buffer
(call-process (getenv "SHELL") nil (current-buffer) nil
"--login" "-i" "-c" (concat "echo __RESULT=$" name))
@@ -65,13 +69,15 @@
;;;###autoload
(defun exec-path-from-shell-copy-env (name)
- "Set the environment variable with `NAME' to match the value seen in the
user's shell."
+ "Set the environment variable $NAME from the user's shell.
+
+Return the value of the environment variable."
(interactive "sCopy value of which environment variable from shell? ")
(setenv name (exec-path-from-shell-getenv name)))
;;;###autoload
(defun exec-path-from-shell-initialize ()
- "Set the PATH environment variable and `exec-path' to match that seen in the
user's shell."
+ "Set $PATH and `exec-path' from the user's shell."
(interactive)
(let ((path-from-shell (exec-path-from-shell-getenv "PATH")))
(setenv "PATH" path-from-shell)
- [nongnu] elpa/exec-path-from-shell 9f034cdb97 022/114: Explicitly double-quote args, so empty var values don't mess things up, (continued)
- [nongnu] elpa/exec-path-from-shell 9f034cdb97 022/114: Explicitly double-quote args, so empty var values don't mess things up, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 95b7aee732 025/114: Use -d in place of --login for tcsh (fixes #7), ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 96afc511bb 030/114: Add missing custom type, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell bfaa02106e 031/114: [Fix #13] Make shell arguments customizable, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell a5162e6f99 032/114: Merge pull request #14 from lunaryorn/customizable-args, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 0e0af3907a 040/114: For non-POSIX shells (mainly fish and tcsh), print vars in a standard "sh" subshell, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell dccbb54b18 041/114: Add note about fish and tcsh to README, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 7f77aa6dfb 052/114: Revert "Remove unnecessary dash to appease old csh", ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell e88cce5a93 067/114: Fix checkdoc warnings, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 51d0931c2a 003/114: Improve suggested condition for initialization on OS X, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 900d98a912 005/114: Improve docstrings,
ELPA Syncer <=
- [nongnu] elpa/exec-path-from-shell 1115e59539 033/114: Provide better info when the shell doesn't printf vars as expected, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell ad5eda1649 034/114: Require non-zero exit code, and allow debug output, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 345ba9cb71 036/114: Don't fail when printing undefined vars if shell -e option is set, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell b09a42885c 037/114: tcsh doesn't support the ${VAR-default} syntax, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell e4af0e9b44 043/114: Add MELPA badges, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell ba09c3419f 046/114: Note necessity of calling `package-initialize` (closes #19), ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell bb20b46f6a 051/114: Treat csh like tcsh (closes #29), ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 673f1fc060 058/114: Better warning message, and allow the check to be suppressed, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell 5e80a4159b 059/114: Use a more sane package version placeholder, ELPA Syncer, 2023/09/05
- [nongnu] elpa/exec-path-from-shell c2ca275d32 061/114: Clarify incompatibility with cmdproxy.exe et al, ELPA Syncer, 2023/09/05