emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/opam-switch-mode e91244a26e: docs(README.md): Mention Tuar


From: ELPA Syncer
Subject: [nongnu] elpa/opam-switch-mode e91244a26e: docs(README.md): Mention Tuareg and Merlin, regarding opam-switch-mode support (#16)
Date: Wed, 26 Jul 2023 07:00:40 -0400 (EDT)

branch: elpa/opam-switch-mode
commit e91244a26ec607a6fbe0e2c9ea61d24cb9a1a258
Author: Erik Martin-Dorel <erik@martin-dorel.org>
Commit: GitHub <noreply@github.com>

    docs(README.md): Mention Tuareg and Merlin, regarding opam-switch-mode 
support (#16)
---
 NEWS.md   |  1 +
 README.md | 20 +++++++++++++-------
 2 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/NEWS.md b/NEWS.md
index 2b01e106bb..b308c4adbd 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -14,6 +14,7 @@ The format is based on [Keep a 
Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ### Changed
 
+- **README.md**: Mention Tuareg and Merlin, regarding opam-switch-mode support
 - **release.sh**: Remove noise (empty headings) in **NEWS.md** at release time
 
 ### Removed
diff --git a/README.md b/README.md
index 6cefbcfb9f..42fdb74cf0 100644
--- a/README.md
+++ b/README.md
@@ -18,23 +18,23 @@ entry "reset" to reset the environment to the state when 
Emacs was started.
 We recommend to install this mode from either the 
 [NonGNU ELPA](https://elpa.nongnu.org/) or the
 [MELPA](https://melpa.org/) repository of Emacs packages.
+In the sequel, we assume you have already set up those in your `.emacs`.
 
 If you use the
 [`use-package`](https://github.com/jwiegley/use-package) macro, the
-recommended configuration is as follows.
-
-Assuming you have already set up those in your `.emacs`, just write:
+recommended configuration is as follows:
 
     (use-package opam-switch-mode
       :ensure t
       :hook
-      (coq-mode . opam-switch-mode))
+      ((coq-mode tuareg-mode) . opam-switch-mode))
 
 If you don't use `use-package`, do the following instead:
 
     (add-hook 'coq-mode-hook #'opam-switch-mode)
+    (add-hook 'tuareg-mode-hook #'opam-switch-mode)
 
-so that the minor mode is automatically enabled when `coq-mode` is on,
+so that the minor mode is automatically enabled when `coq-mode` or 
`tuareg-mode` is on,
 see also [`opam-switch-mode` aware modes](#opam-switch-mode-aware-modes).
 
 ## Command `opam-switch-set-switch`
@@ -67,5 +67,11 @@ any other shells outside Emacs.
 ## `opam-switch-mode` aware modes
 
 - `coq-mode` from [`proof-general`](https://proofgeneral.github.io/)
-  can kill the coq background process when the opam switch changes,
-  see 
[`coq-kill-coq-on-opam-switch`](https://proofgeneral.github.io/doc/master/userman/Coq-Proof-General/#index-coq_002dkill_002dcoq_002don_002dopam_002dswitch).
+  can kill the Coq background process when the opam switch changes,
+  see option 
[`coq-kill-coq-on-opam-switch`](https://proofgeneral.github.io/doc/master/userman/Coq-Proof-General/#index-coq_002dkill_002dcoq_002don_002dopam_002dswitch).
+- `tuareg-mode` from [`tuareg`](https://github.com/ocaml/tuareg)
+  can kill the OCaml background process when the opam switch changes,
+  see option `tuareg-kill-ocaml-on-opam-switch`.
+- `merlin-mode` from [`merlin`](https://github.com/ocaml/merlin)
+  can kill the underlying Merlin server when the opam switch changes,
+  see option `merlin-stop-server-on-opam-switch`.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]