Skip to content

Commit

Permalink
Update documentation for layer dependencies declaration
Browse files Browse the repository at this point in the history
Users interested in writing their first configuration layer should be
incentivized to use the configuration-layer/declare-layer-dependencies
function instead of manually declaring a single layer.
  • Loading branch information
2ynn authored and smile13241324 committed May 20, 2024
1 parent ea351ad commit 20e3267
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/LAYERS.org
Original file line number Diff line number Diff line change
Expand Up @@ -289,20 +289,20 @@ path for you.

** layers.el
This file is the first file to be loaded and this is the place where additional
layers can be declared.
layers can be declared as dependencies.

For instance, if layer A depends on some functionality of layer B, then in the
file =layers.el= of layer A, we can add:

#+BEGIN_SRC emacs-lisp
(configuration-layer/declare-layer 'B)
(configuration-layer/declare-layer-dependencies '(B))
#+END_SRC

The effect is that B is considered a used layer and will be loaded as if it
was added to =dotspacemacs-configuration-layers= variables.

** packages.el
It contains this list of packages of the layer and the actual configuration for
It contains the list of packages of the layer and the actual configuration for
the packages included in the layer.

This file is loaded after =layers.el=.
Expand Down

0 comments on commit 20e3267

Please sign in to comment.