[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/opam-switch-mode 7c648a0719 16/31: docs: details (#3)
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/opam-switch-mode 7c648a0719 16/31: docs: details (#3) |
Date: |
Mon, 14 Nov 2022 09:00:00 -0500 (EST) |
branch: elpa/opam-switch-mode
commit 7c648a07190fef3db5ae53bcc00656e23d9be258
Author: Erik Martin-Dorel <erik@martin-dorel.org>
Commit: GitHub <noreply@github.com>
docs: details (#3)
* Add PG URL in README.md
* Fix typos
---
README.md | 13 +++++++------
opam-switch-mode.el | 11 ++++-------
2 files changed, 11 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index eb775ae38c..bc5a44a90a 100644
--- a/README.md
+++ b/README.md
@@ -12,9 +12,9 @@ entry "reset" to reset the environment to the state when
emacs was started.
## Command `opam-switch-set-switch`
-Invoke with `M-x opam-switch-set-switch`.
+Invoke with `M-x opam-switch-set-switch RET`.
-Chose and set an opam switch.
+Choose and set an opam switch.
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,
@@ -33,10 +33,11 @@ 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 resons, `opam-switch-set-switch` will only affect emacs and not
+For obvious reasons, `opam-switch-set-switch` will only affect emacs and not
any other shells outside emacs.
-## Opam mode aware modes
+## opam-switch-mode aware modes
-- Proof General can kill the coq background process, when the opam switch
- changes, see `coq-kill-coq-on-opam-switch`.
+- [Proof General](https://proofgeneral.github.io/)
+ can kill the coq background process, when the opam switch changes,
+ see `coq-kill-coq-on-opam-switch`.
diff --git a/opam-switch-mode.el b/opam-switch-mode.el
index dd27d41882..c0543360b5 100644
--- a/opam-switch-mode.el
+++ b/opam-switch-mode.el
@@ -20,8 +20,8 @@
;;
;; You should have received a copy of the GNU General Public License
;; along with "prooftree". If not, see <http://www.gnu.org/licenses/>.
-;;
-;;
+;;
+;;
;;; Commentary:
;;
;; Provide command `opam-switch-set-switch' to change the opam switch
@@ -43,7 +43,6 @@
;; For obvious reasons, `opam-switch-set-switch' does not change the
;; switch of any other shell.
;;
-;;
(require 'seq)
@@ -53,7 +52,6 @@
"Customization for opam switch support in Emacs"
:group 'external)
-
(defcustom opsw--program-name "opam"
"Name or path of the opam binary."
:group 'opam-switch-mode
@@ -86,7 +84,6 @@ This is used, for instance, to let Proof General kill the coq
background process when the opam switch changes."
:group 'opam-switch-mode
:type '(repeat function))
-
;;; Code
@@ -236,7 +233,7 @@ switch overwrote them."
"<none>")))
(defun opsw--set-switch (switch-name)
- "Chose and set an opam switch.
+ "Choose and set an opam switch.
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
@@ -258,7 +255,7 @@ runs. This a can be used to inform other modes that may run
background processes that depend on the currently active opam
switch.
-For obvious resons, `opsw--set-switch' will only affect emacs and
+For obvious reasons, `opsw--set-switch' will only affect emacs and
not any other shells outside emacs."
(interactive
(let* ((switches (opsw--get-switches))
- [nongnu] branch elpa/opam-switch-mode created (now a306f75d82), ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode dea35145a3 30/31: Merge pull request #7 from ProofGeneral/add-doc, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 515d08dfb3 09/31: check and handle opam errors, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode cad8510077 18/31: refactor: Run `M-x package-lint-current-buffer` and address its feedback, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 0db601100c 17/31: docs: Run `M-x checkdoc` and address its feedback, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 3d63566b0d 04/31: provide README, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode dd6a86ddad 23/31: Add LICENSE, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 16b8276f85 13/31: use -- for internal stuff, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 5f3d2102ae 26/31: Add OCaml keyword and https://opam.ocaml.org URL, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 7c648a0719 16/31: docs: details (#3),
ELPA Syncer <=
- [nongnu] elpa/opam-switch-mode 22fa9efcb6 27/31: docs(README.md): Add install section, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode f62c708225 14/31: typo fix, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 95a3b4225a 15/31: fix: (opam-switch-mode) × 3 bug (#4), ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode a306f75d82 31/31: docs(README.md): detail, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 7306ce0fee 10/31: add separator in menu after current switch, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode e2ed274519 05/31: add emacs code documentation, also delete default switch parsing, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 7de138a0e9 07/31: add minor mode with menu bar menu, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode e681cbdcb7 29/31: chore: Update header and maintainer mailing list, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode a83de84719 19/31: refactor: Replace `opsw--` with `opam-switch--`, ELPA Syncer, 2022/11/14
- [nongnu] elpa/opam-switch-mode 8a021ff128 12/31: rename to opam-switch-mode; use opsw as prefix for internals, ELPA Syncer, 2022/11/14