Skip to content

Commit

Permalink
Refine the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Kundert authored and Ken Kundert committed Sep 23, 2019
1 parent 2ee4f92 commit bad521c
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions doc/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ that.
Includes
--------

Any setting may include the contents of another file by using an *include*. You
may either specify a single include file as a string or a collection as a list
of strings::
Any settings file may include the contents of another file by using an
*include*. You may either specify a single include file as a string or
a collection as a list of strings::

include = 'file-to-include'

Expand All @@ -131,15 +131,16 @@ for example, from different prune schedules.
As an example, consider having three configurations that you would like to run
all at once. You can specify these configurations as follows::

configurations = 'root home lamp all=root,home,lamp'
configurations = 'home lamp data all=home,lamp,data'

In this case *root*, *home* and *lamp* are simple configurations and *all* is
a composite configuration. *root*, *home*, and *lamp* would have configuration
files whereas *all* would not.
In this case *home*, *lamp*, and *data* are simple configurations and *all* is
a composite configuration. *home*, *lamp*, and *data* would have configuration
files whereas *all* would not. The composite configuration should be specified
without spaces.

You can run a specific configuration with:

emborg -c root extract ~/bin
emborg -c home extract ~/bin

You can run all three configurations with:

Expand Down

0 comments on commit bad521c

Please sign in to comment.