Update documentation and parameters for the portable dumper
This commit is contained in:
parent
ce30353b52
commit
cfd2b110f2
|
@ -18,23 +18,20 @@
|
|||
- [[#usage][Usage]]
|
||||
|
||||
* Spacemacs dumps using the portable dumper
|
||||
The portable dumper is a feature that may be available with Emacs 27.1, for now
|
||||
its code is in the =pdumper= branch of the Emacs Git repository, it has not been
|
||||
merged to master yet.
|
||||
|
||||
This should theoretically work on all the three major OSes: GNU/Linux, MacOS and
|
||||
Windows.
|
||||
The portable dumper is a feature that will be available with Emacs 27. This new
|
||||
dumper should theoretically work on all the three major OSes: GNU/Linux, MacOS
|
||||
and Windows.
|
||||
|
||||
** Setup
|
||||
To test the portable dumper with Spacemacs, follow these steps:
|
||||
|
||||
*** =emacs-plus= users
|
||||
In case you are using =d12frosted/emacs-plus= on macOS, you can skip manual
|
||||
Emacs installation instructions and just use =--with-pdumper= option passed to
|
||||
Emacs installation instructions and just use =--HEAD= option passed to
|
||||
=brew=.
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
brew install emacs-plus --HEAD --with-pdumper
|
||||
brew install emacs-plus --HEAD
|
||||
#+END_SRC
|
||||
|
||||
*** Clone Emacs
|
||||
|
@ -69,8 +66,8 @@ This step depends on your OS (please create a PR to add the instructions for
|
|||
your OS).
|
||||
|
||||
**** MacOS
|
||||
In the root directory of your freshly cloned Emacs repository and with the
|
||||
=pdumper= branch as the current branch:
|
||||
In the root directory of your freshly cloned Emacs repository in the =master=
|
||||
branch as the current branch:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
./autogen.sh
|
||||
|
@ -81,8 +78,8 @@ In the root directory of your freshly cloned Emacs repository and with the
|
|||
**** Ubuntu
|
||||
/Note: This is tested on Ubuntu 17.10./
|
||||
|
||||
In the root directory of your freshly cloned Emacs repository and with the
|
||||
=pdumper= branch as the current branch:
|
||||
In the root directory of your freshly cloned Emacs repository in the =master=
|
||||
branch as the current branch:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
./autogen.sh
|
||||
|
@ -175,15 +172,15 @@ have them already and initialize them:
|
|||
;; (default nil)
|
||||
dotspacemacs-enable-emacs-pdumper t
|
||||
|
||||
;; File path pointing to emacs 27.1 executable compiled with support
|
||||
;; for the portable dumper (this is currently the branch pdumper).
|
||||
;; (default "emacs")
|
||||
dotspacemacs-emacs-pdumper-executable-file "/path/to/emacs27"
|
||||
;; Name of executable file pointing to emacs 27+. This executable must be
|
||||
;; in your PATH.
|
||||
;; (default "emacs")
|
||||
dotspacemacs-emacs-pdumper-executable-file "emacs"
|
||||
|
||||
;; Name of the Spacemacs dump file. This is the file will be created by the
|
||||
;; portable dumper in the cache directory under dumps sub-directory.
|
||||
;; To load it when starting Emacs add the parameter `--dump-file'
|
||||
;; when invoking Emacs 27.1 executable on the command line, for instance:
|
||||
;; when invoking Emacs 27 executable on the command line, for instance:
|
||||
;; ./emacs --dump-file=~/.emacs.d/.cache/dumps/spacemacs.pdmp
|
||||
;; (default spacemacs.pdmp)
|
||||
dotspacemacs-emacs-dumper-dump-file "spacemacs.pdmp"))
|
||||
|
@ -220,7 +217,7 @@ named =*spacemacs dumper*=.
|
|||
|
||||
If you have no error during the dump you can test it out!
|
||||
|
||||
To actually start Spacemacs with the compiled Emacs 27.1 and the Spacemacs dump,
|
||||
To actually start Spacemacs with the compiled Emacs 27 and the Spacemacs dump,
|
||||
on the command line in the =src= directory of the cloned Emacs source:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
|
@ -236,7 +233,7 @@ All the related issues can be found with [[https://github.com/syl20bnr/spacemacs
|
|||
** Usage
|
||||
Once =dotspacemacs-enable-emacs-pdumper= is set to =t= and
|
||||
=dotspacemacs-emacs-pdumper-executable-file= is set to a valid file path to an
|
||||
Emacs 27.1 executable, Emacs will be redumped automatically each time the layer
|
||||
Emacs 27 executable, Emacs will be redumped automatically each time the layer
|
||||
list changes or the =--force-dump= parameter is passed on the command line.
|
||||
|
||||
To use the created dump file, open a shell in the =src= directory of the cloned
|
||||
|
|
|
@ -65,9 +65,8 @@ or `spacemacs'.")
|
|||
to compile Emacs 27 from source following the instructions in file
|
||||
EXPERIMENTAL.org at to root of the git repository.")
|
||||
|
||||
(defvar dotspacemacs-emacs-pdumper-executable-file "emacs-27.0.50"
|
||||
"File path pointing to emacs 27.1 executable compiled with support for the
|
||||
portable dumper (this is currently the branch pdumper.")
|
||||
(defvar dotspacemacs-emacs-pdumper-executable-file "emacs"
|
||||
"File path pointing to emacs 27 or later executable.")
|
||||
|
||||
(defvar dotspacemacs-emacs-dumper-dump-file "spacemacs.pdmp"
|
||||
"Name of the Spacemacs dump file. This is the file will be created by the
|
||||
|
|
|
@ -62,7 +62,7 @@ You should not used this function, it is reserved for some specific process."
|
|||
"Return non-nil if a portable dumper capable emacs executable is set."
|
||||
(and dotspacemacs-enable-emacs-pdumper
|
||||
(file-exists-p
|
||||
(locate-file dotspacemacs-emacs-pdumper-executable-file
|
||||
(locate-file (or dotspacemacs-emacs-pdumper-executable-file "emacs")
|
||||
exec-path exec-suffixes 'file-executable-p))))
|
||||
|
||||
(defun spacemacs/dump-emacs ()
|
||||
|
|
|
@ -94,10 +94,10 @@ It should only modify the values of Spacemacs settings."
|
|||
;; (default nil)
|
||||
dotspacemacs-enable-emacs-pdumper nil
|
||||
|
||||
;; File path pointing to emacs 27.1 executable compiled with support
|
||||
;; for the portable dumper (this is currently the branch pdumper).
|
||||
;; (default "emacs-27.0.50")
|
||||
dotspacemacs-emacs-pdumper-executable-file "emacs-27.0.50"
|
||||
;; Name of executable file pointing to emacs 27+. This executable must be
|
||||
;; in your PATH.
|
||||
;; (default "emacs")
|
||||
dotspacemacs-emacs-pdumper-executable-file "emacs"
|
||||
|
||||
;; Name of the Spacemacs dump file. This is the file will be created by the
|
||||
;; portable dumper in the cache directory under dumps sub-directory.
|
||||
|
|
|
@ -248,7 +248,8 @@ and bugs are fixed quickly.
|
|||
- *Minimalistic and nice graphical UI* keeps your available screen space for
|
||||
what matters: your text files.
|
||||
- *Fast boot time*: packages and configuration are lazy-loaded as much as
|
||||
possible.
|
||||
possible. For even faster boot time, Spacemacs now provides full support for
|
||||
the new portable dumper available in Emacs 27 and later.
|
||||
- *Lower the risk of RSI* by heavily using the space bar instead of modifiers.
|
||||
If you have issues with your thumbs you can still use Spacemacs using
|
||||
modifiers.
|
||||
|
|
Loading…
Reference in New Issue