Skip to content

Commit 0dcbed2

Browse files
committed
Document new external dependency directory mode.
1 parent cc43574 commit 0dcbed2

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ endif::[]
4646
:since-0-4: image:https://img.shields.io/badge/since-0.4-8be[Since 0.4,float=right]
4747
:since-0-5: image:https://img.shields.io/badge/since-0.5-8be[Since 0.5,float=right]
4848
:since-0-6: image:https://img.shields.io/badge/since-0.6-8be[Since 0.6,float=right]
49+
:since-0-8: image:https://img.shields.io/badge/since-0.8-8be[Since 0.8,float=right]
4950

5051
= Eldev
5152

@@ -399,6 +400,38 @@ from affecting your Emacs and, finally, to simplify testing of certain
399400
* Eldev supports <<different-emacs-versions,executing on different
400401
Emacs version>> for the same project without any additional steps.
401402

403+
=== Using preinstalled dependencies
404+
405+
{since-0-8} Starting with version 0.8 you can opt out of some of the
406+
default project isolation features and use preinstalled dependencies,
407+
e.g. those from your normal Emacs. To activate this mode, use global
408+
option `--external` (`-X`), e.g.:
409+
410+
$ eldev -X test
411+
412+
In this mode Eldev will expect dependencies to be installed in given
413+
directory (standard Emacs location — `~/.emacs.d/elpa` — is only the
414+
default: you can use another directory). If a dependency is not
415+
installed, Eldev _will not_ install it on its own: it doesn’t know
416+
which package archives should be used. Likewise, it will not upgrade
417+
anything. In all such cases, i.e. when required dependencies are not
418+
correctly preinstalled in the specified external directory, Eldev will
419+
simply fail.
420+
421+
<<local-dependencies,Local dependencies>> discussed later take
422+
precedence even in this mode: anything declared as local will override
423+
dependencies available from an external directory, just like it will
424+
in usual full isolation mode.
425+
426+
This mode can be useful to load exactly the same dependency versions
427+
as those installed in your normal Emacs. However, it is not suitable
428+
for continuous integration or for working on packages that you do not
429+
have — for whatever reason — installed normally. It is also difficult
430+
to test on <<different-emacs-versions,different Emacs versions>> in
431+
external directory mode. Therefore, it is not the default. But, as
432+
usual in Eldev, you can make it the default in file `~/.eldev/config`
433+
if you want.
434+
402435

403436
== Project dependencies
404437

0 commit comments

Comments
 (0)