[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/opam-switch-mode d710b350da 4/4: docs(README.md): Document
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/opam-switch-mode d710b350da 4/4: docs(README.md): Document opam-switch-before-change-opam-switch-hook |
Date: |
Tue, 11 Jul 2023 13:00:07 -0400 (EDT) |
branch: elpa/opam-switch-mode
commit d710b350da6b8101e284d0250776e89f47a55eef
Author: Erik Martin-Dorel <erik@martin-dorel.org>
Commit: Erik Martin-Dorel <erik@martin-dorel.org>
docs(README.md): Document opam-switch-before-change-opam-switch-hook
---
NEWS.md | 2 ++
README.md | 8 +++++---
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/NEWS.md b/NEWS.md
index 1348ab60af..7f761e96c4 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -13,6 +13,8 @@ The format is based on [Keep a
Changelog](https://keepachangelog.com/en/1.0.0/).
### Changed
+- **README.md**: Document the feature from [1.3]
+
### Removed
## [1.3] - 2023-07-11
diff --git a/README.md b/README.md
index 72ddbcca1b..973c60cfe7 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,8 @@ We recommend to install this mode from either the
If you use the
[`use-package`](https://github.com/jwiegley/use-package) macro, the
-recommended configuration is:
+recommended configuration is as follows.
+
Assuming you have already set up those in your `.emacs`, just write:
```elisp
@@ -57,8 +58,9 @@ 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).
-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
+Just before the switch is changed,
`opam-switch-before-change-opam-switch-hook` runs.
+After the switch is changed, `opam-switch-change-opam-switch-hook` runs.
+One of these can be used to inform other modes that run background processes
that depend on the currently active opam switch.
For obvious reasons, `opam-switch-set-switch` will only affect Emacs and not