From 015414ae8c6b29873c401af57284a165c52c2102 Mon Sep 17 00:00:00 2001 From: syl20bnr Date: Wed, 21 Aug 2019 22:29:21 -0400 Subject: [PATCH] [Github] Do not install forge pacakge on Windows by default --- CHANGELOG.develop | 2 ++ layers/+source-control/github/README.org | 18 ++++++++++++++++-- layers/+source-control/github/packages.el | 4 +++- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.develop b/CHANGELOG.develop index 5a6c54499..c32823536 100644 --- a/CHANGELOG.develop +++ b/CHANGELOG.develop @@ -1490,6 +1490,8 @@ Other: **** GitHub - Packages: - Added new packages =forge= (thanks to Miciah Dashiel Butler Masters) + - Do not install =forge= on Windows by default, see =README.org= of the layer + (thanks to Sylvain Benner) - Remove package =github-browse-file= which has been replaced by =browse-at-remote= in =version-control= layer - Key bindings: diff --git a/layers/+source-control/github/README.org b/layers/+source-control/github/README.org index 105d24d5c..9a6fed01a 100644 --- a/layers/+source-control/github/README.org +++ b/layers/+source-control/github/README.org @@ -10,8 +10,9 @@ - [[#install][Install]] - [[#layer][Layer]] - [[#git-configuration][Git configuration]] + - [[#forge][Forge]] - [[#key-bindings][Key bindings]] - - [[#forge][forge]] + - [[#forge-1][Forge]] - [[#gistel][gist.el]] - [[#clone-repositories][Clone repositories]] @@ -41,8 +42,21 @@ You will also need to [[https://help.github.com/articles/generating-a-new-ssh-ke git config --global github.oauth-token #+END_SRC +** Forge +The =forge= package uses =emacsql= which requires a C compiler to be available +on MS Windows, see issue https://github.com/skeeto/emacsql/issues/46. + +For this reason the =forge= package is not installed on MS Windows by default. +If you still want to install it (which means you do have a C compiler available +in your PATH) then use the =dotspacemacs-additional-packages= variable in your +dotfile: + +#+BEGIN_SRC emacs-lisp + (dotspacemacs-additional-packages '((forge :toggle t))) +#+END_SRC + * Key bindings -** forge +** Forge In a =magit-status= buffer (~SPC g s~): | Key binding | Description | diff --git a/layers/+source-control/github/packages.el b/layers/+source-control/github/packages.el index 35fa35441..1b5cfd1fe 100644 --- a/layers/+source-control/github/packages.el +++ b/layers/+source-control/github/packages.el @@ -11,7 +11,9 @@ (setq github-packages '( - forge + ;; forge requires a C compiler on Windows so we disable + ;; it by default on Windows. + (forge :toggle (not (spacemacs/system-is-mswindows))) gist github-clone github-search