Skip to content

Commit f4c4614

Browse files
committed
glossary: improve the description for variables and gardens
Signed-off-by: David Aguilar <[email protected]>
1 parent bfdd619 commit f4c4614

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/src/glossary.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,22 @@
1818
commands and gardens. Groups are lighter-weight than a garden and group
1919
trees together into named collections that can be referenced by gardens
2020
and commands. In contrast to gardens, groups *do not* provide a scope
21-
in which variables, commands environment variables can be defined.
21+
in which variables, commands, and environment variables can be defined.
2222

2323
* ***garden*** -- a composite of trees and groups for defining project-level
24-
variables, commands and environment variables. Gardens help create
25-
environments for working on projects composed of multiple Git repositories.
24+
variables, commands and environment variables. Gardens can be used to manage
25+
environment variables when working on projects composed of multiple Git repositories.
2626
The `gardens` YAML key/value block defines named gardens with a scope
2727
in which garden-specific variables, commands and environment variables
2828
can be defined.
2929

3030
* **variables**
31-
A YAML key/value table defines named variables that can be used in
32-
YAML strings by using braced `shell ${expressions}` to provide dynamic
33-
values that can be used to provide modularity and configurability to a garden
34-
file. Variables defined in a garden file are overridden on the
35-
command-line by using the `-D / --define key=value` option.
31+
A key/value YAML string table that is used to define values that can be used in
32+
garden commands and other variables definitions. String expressions and exec
33+
expressions can be used to provide a variable's value.
34+
35+
Variables defined in a garden file in all scopes are overridden on the command-line by
36+
using the `--define | -D key=value` option.
3637

3738
* **commands**
3839
The `commands` YAML key/value table defines named commands that can be run

0 commit comments

Comments
 (0)