Skip to content

Commit c25bf17

Browse files
author
Thierry Volpiatto
committed
Document async compilation of packages in README.
1 parent 5c61408 commit c25bf17

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
# Install
1111

12+
## Install dired-async
13+
1214
Add to your `.emacs.el`:
1315

1416
(autoload 'dired-async-mode "dired-async.el" nil t)
@@ -23,6 +25,23 @@ you can disable this by running the copy, rename etc... commands with a prefix a
2325

2426
If you don't want to make dired/helm asynchronous disable it with `dired-async-mode`.
2527

28+
## Enable asynchronous compilation of your (M)elpa packages
29+
30+
By default emacs package.el compile packages in its running emacs session.
31+
This is not a problem when installing a new package (which is not actually loaded in current emacs)
32+
but it may create errors and bad compilation when upgrading a package (old version of package is already loaded
33+
and running in current emacs).
34+
You can remedy to this by allowing async to compile your packages asynchronously,
35+
(helm and magit actually do this by default,
36+
so if you are using these packages they will compile asynchronously)
37+
to do this, add to your init file:
38+
39+
(async-bytecomp-package-mode 1)
40+
41+
42+
You can control which packages will compile async with `async-bytecomp-allowed-packages`.
43+
Set it to `'(all)` to be sure you will compile all packages asynchronously.
44+
2645
# Usage
2746

2847
The interface is intended to be very easy to use:

0 commit comments

Comments
 (0)