From da09a3eb8c78f8f9d17e01ed42c154dde256fb30 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Sat, 28 Dec 2019 14:00:08 -0500 Subject: [PATCH] Mention commit pinning in docs with package! --- core/templates/packages.example.el | 9 +++++++++ docs/api.org | 13 +++++-------- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/core/templates/packages.example.el b/core/templates/packages.example.el index 2d69479cb70..1329ac57478 100644 --- a/core/templates/packages.example.el +++ b/core/templates/packages.example.el @@ -11,6 +11,15 @@ ;; ;; Here are a couple examples: + +;; All of Doom's packages are pnned to a specific commit, and updated from +;; release to release. To un-pin all packages and live on the edge, do: +;(setq doom-pinned-packages nil) + +;; ...but to unpin a single package: +;(package! pinned-package :pin nil) + + ;; To install SOME-PACKAGE from MELPA, ELPA or emacsmirror: ;(package! some-package) diff --git a/docs/api.org b/docs/api.org index 7a31a7ee5ae..642fb8f47ce 100644 --- a/docs/api.org +++ b/docs/api.org @@ -404,15 +404,12 @@ These are side-by-side comparisons, showing how to bind keys with and without ;; you can tell the package manager not to clone the repo recursively: (package! ansible :recipe (:nonrecursive t)) -;; To install a particular branch, commit or tag: -(package! evil - ;; if :host and :fetcher aren't specified, the package manager will fall back - ;; to evil's default source provided by their (M)ELPA recipes: - :recipe (:commit "e7bc39de2f961505e8e112da8c1b315ae8afce52")) - +;; To pin a package to a specific commit: +(package! evil :pin "e7bc39de2f961505e8e112da8c1b315ae8afce52") +;; ...or branch: (package! evil :recipe (:branch "stable")) - -(package! evil :recipe (:tag "1.2.9")) +;; To unpin a pinned package: +(package! evil :pin nil) ;; If you share your config between two computers, and don't want bin/doom ;; refresh to delete packages used only on one system, use :ignore