[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/opam-switch-mode ac9ef486e6: docs(README.md): Improve deta
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/opam-switch-mode ac9ef486e6: docs(README.md): Improve details |
Date: |
Tue, 15 Nov 2022 08:59:15 -0500 (EST) |
branch: elpa/opam-switch-mode
commit ac9ef486e67d3d5a0ce2e7bb628a4e32474dc7f7
Author: Erik Martin-Dorel <erik@martin-dorel.org>
Commit: Erik Martin-Dorel <erik@martin-dorel.org>
docs(README.md): Improve details
---
README.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 295d533338..05c5e410a8 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,14 @@
[](https://melpa.org/#/opam-switch-mode)
-Provide command `opam-switch-set-switch` to change the opam switch of the
-running emacs session and minor mode `opam-switch-mode` to select the opam
-switch via a menu bar menu.
+Provide a command `opam-switch-set-switch` to change the opam switch
+of the running Emacs session, and a minor mode `opam-switch-mode` to
+select the opam switch via a (menu-bar or mode-bar) menu.
The menu is generated each time the minor mode is enabled and contains the
switches that are known at that time. If you create a new switch, re-enable
the minor mode to get it added to the menu. The menu contains an additional
-entry "reset" to reset the environment to the state when emacs was started.
+entry "reset" to reset the environment to the state when Emacs was started.
## Installing `opam-switch-mode`
@@ -38,21 +38,21 @@ Set opam switch SWITCH-NAME, which must be a valid opam
switch name. When
called interactively, the switch name must be entered in the minibuffer,
which forces completion to a valid switch name or the empty string.
-Setting the opam switch for the first time inside emacs will save the
+Setting the opam switch for the first time inside Emacs will save the
current environment. Using the empty string for SWITCH-NAME will reset the
environment to the saved values.
-The switch is set such that all process invocations from emacs respect the
+The switch is set such that all process invocations from Emacs respect the
newly set opam switch. In addition to setting environment variables such as
PATH and CAML_LD_LIBRARY_PATH, this also sets `exec-path`, which controls
-emacs' subprocesses (`call-process`, `make-process` and similar functions).
+Emacs' subprocesses (`call-process`, `make-process` and similar functions).
When the switch is changed, `opam-switch-change-opam-switch-hook` runs.
This can be used to inform other modes that may run background processes
that depend on the currently active opam switch.
-For obvious reasons, `opam-switch-set-switch` will only affect emacs and not
-any other shells outside emacs.
+For obvious reasons, `opam-switch-set-switch` will only affect Emacs and not
+any other shells outside Emacs.
## `opam-switch-mode` aware modes
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [nongnu] elpa/opam-switch-mode ac9ef486e6: docs(README.md): Improve details,
ELPA Syncer <=