Skip to content

Commit 3b0eb04

Browse files
committed
Merge branch 'future-doc'
2 parents 8a1e6cc + 68af3cb commit 3b0eb04

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

doc/README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
:uri-docker-emacs: https://github.com/Silex/docker-emacs
4949
:uri-release-it: https://github.com/release-it/release-it
5050
:uri-emacs-forwarding: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=56745
51+
:uri-guix: https://guix.gnu.org/
5152
:since-0-1-1: image:https://img.shields.io/badge/since-0.1.1-8be[Since 0.1.1,float=right]
5253
:since-0-2: image:https://img.shields.io/badge/since-0.2-8be[Since 0.2,float=right]
5354
:since-0-2-1: image:https://img.shields.io/badge/since-0.2.1-8be[Since 0.2.1,float=right]
@@ -70,6 +71,7 @@
7071
:since-1-6: image:https://img.shields.io/badge/since-1.6-8be[Since 1.6,float=right]
7172
:since-1-7: image:https://img.shields.io/badge/since-1.7-8be[Since 1.7,float=right]
7273
:since-1-8: image:https://img.shields.io/badge/since-1.8-8be[Since 1.8,float=right]
74+
:since-1-9: image:https://img.shields.io/badge/since-1.9-8be[Since 1.9,float=right]
7375

7476

7577
toc::[]

doc/project-dependencies.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,42 @@ Current list of the known tools:
297297
* `elisp-lint`
298298
* `undercover`
299299

300+
[#disabling-dependencies]
301+
=== Disabling dependency management
302+
303+
CAUTION: This operation mode is *not recommended*. It exists only to
304+
support special usecases that “insist” on setting Emacs’ `load-path`
305+
directly and cannot be customized (with reasonable effort).
306+
307+
{since-1-9} Eldev has limited support for operating _without
308+
dependency management_. This mode can be activated using global
309+
option `--disable-dependencies` (there is no short version to
310+
emphasize that _it is not recommended_). It exists to support certain
311+
environments that themselves provide a suitable value for Emacs
312+
variable `load-path` via environment variable `EMACSLOADPATH`. An
313+
example of such an environment is {uri-guix}[GUIX] package building.
314+
315+
Unlike in <<preinstalled-dependencies,preinstalled-dependency mode>>
316+
described earlier, here Eldev doesn’t work with dependencies (and
317+
<<development-tool-sources,tools>>) as standard Emacs packages at all.
318+
Instead, everything is expected to be loadable using `require` form
319+
without any further setup. For this, variable `load-path` must be set
320+
appropriately, most likely using `EMACSLOADPATH` (though you could, in
321+
principle, set its value in e.g. `Eldev-local`).
322+
323+
One consequence of this mode is that Emacs package system won’t
324+
consider dependency packages installed at all, see
325+
`package-installed-p`. <<autoloads,Autoloads>> are not supported in
326+
this mode (neither for dependencies nor for the project itself), so
327+
you must explicitly require all features before using them. There
328+
might be other, unexpected, limitations as well, as this mode is not
329+
thoroughly tested.
330+
331+
Unless you need to build packages for GUIX or have some comparable
332+
environment that computes `load-path` on its own and doesn’t let Eldev
333+
manage dependencies normally by accessing standard package archives,
334+
you shouldn’t use this mode.
335+
300336
[#global-cache]
301337
=== Global package archive cache
302338

doc/setup-procedure.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ from affecting your Emacs and, finally, to simplify testing of certain
7171
* Eldev supports <<different-emacs-versions,executing on different
7272
Emacs version>> for the same project without any additional steps.
7373
74+
[#preinstalled-dependencies]
7475
=== Using preinstalled dependencies
7576

7677
{since-0-8} Starting with version 0.8 you can opt out of some of the
@@ -102,3 +103,7 @@ to test on <<different-emacs-versions,different Emacs versions>> in
102103
external directory mode. Therefore, it is not the default. But, as
103104
usual in Eldev, you can make it the default in file
104105
`~/.config/eldev/config` if you want.
106+
107+
There is also a way to <<disabling-dependencies,disable dependency
108+
management>> _completely_. However, other than in few very special
109+
cases you should prefer normal operation.

0 commit comments

Comments
 (0)