mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-04 19:09:44 +00:00
Code Activity

fixing doc

Browse Source
This commit is contained in:
deadc0de6
2022-05-19 23:44:59 +02:00
committed by deadc0de
parent 4e4a2016f2
commit ceb2b7ad73
2 changed files with 31 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/config-dynvars.md
View File

@@ -7,7 +7,15 @@ dynvariables:
<variable-name>: <shell-oneliner> <variable-name>: <shell-oneliner>
``` ```
Dynvariables (*dynamic* variables) will be interpreted by the shell before being substituted. You can also use multi-line (see [yaml related doc](https://yaml-multiline.info/)).
For example:
```yaml
dynvariables:
<variable-name>: >-
<line1>
<line2>
<line3>
```
For example: For example:
```yaml ```yaml
@@ -16,10 +24,13 @@ dynvariables:
dvar2: "echo 'this is some test' | rev | tr ' ' ','" dvar2: "echo 'this is some test' | rev | tr ' ' ','"
dvar3: /tmp/my_shell_script.sh dvar3: /tmp/my_shell_script.sh
user: "echo $USER" user: "echo $USER"
config_file: test -f "{{@@ user_config @@}}" && echo "{{@@ user_config @@}}" || echo "{{@@ dfl_config @@}}" config_file: >-
test -f "{{@@ base_config @@}}" &&
echo "{{@@ base_config @@}}" ||
echo "{{@@ dfl_config @@}}"
variables: variables:
user_config: "profile_{{@@ user @@}}_uid.yaml" base_config: "profile_base.yaml"
dfl_config: "profile_default.yaml" dfl_config: "profile_default.yaml"
``` ```
They have the same properties as [Variables](config-file.md#variables). They have the same properties as [Variables](config-variables.md).

25
docs/config-file.md
View File

@@ -29,9 +29,11 @@ parametrize the following elements of the config:
* `import_configs` * `import_configs`
* Profiles' `import` * Profiles' `import`
* Profiles' `include` * Profiles' `include`
* `actions`
* `transformations`
`actions` and `transformations` also support the use of variables, Note that variables used in `actions` and `transformations`
but those are resolved when the action/transformation is executed are resolved when the action/transformation is executed
(See [Dynamic actions](config-actions.md#dynamic-actions), (See [Dynamic actions](config-actions.md#dynamic-actions),
[Dynamic transformations](config-transformations.md#dynamic-transformations) and [Templating](templating.md)). [Dynamic transformations](config-transformations.md#dynamic-transformations) and [Templating](templating.md)).
@@ -51,19 +53,24 @@ then be available during [templating](templating.md).
Here are some rules on the use of variables in configs: Here are some rules on the use of variables in configs:
* [Interpreted variables](config-dynvars.md) are executed in their own file. * [dynvariables](config-dynvars.md) are executed in their own file.
* [Interpreted variables](config-dynvars.md) and * [dynvariables](config-dynvars.md) and
[variables](config-dynvars.md) are templated before [variables](config-variables.md) are templated before
[interpreted variables](config-dynvars.md) are executed. [dynvariables](config-dynvars.md) are executed.
* Config files do not have access to variables defined above in the import tree. * Config files do not have access to variables defined above in the import tree
* `dynvariables` take precedence over `variables`. (variables defined in importing config are not seen by the imported config file,
where *import* can be any of `import_configs`, `import_variables`, `import_actions`,
profile's `import` and profile's `include`)
* [dynvariables](config-dynvars.md) take precedence over [variables](config-variables.md).
* Profile `(dyn)variables` take precedence over any other `(dyn)variables`. * Profile `(dyn)variables` take precedence over any other `(dyn)variables`.
* Profile `(dyn)variables` take precedence over profile's included `(dyn)variables`. * Profile `(dyn)variables` take precedence over profile's included `(dyn)variables`.
* External/imported `(dyn)variables` take precedence over * External/imported `(dyn)variables` take precedence over
`(dyn)variables` defined inside the main config file. `(dyn)variables` defined inside the main config file.
* [User variables](config-uservars.md) are ignored if * [uservariables](config-uservars.md) are ignored if
any other variable with the same key is defined. any other variable with the same key is defined.
For more see the [CONTRIBUTING doc](/CONTRIBUTING.md).
## Permissions ## Permissions
Dotdrop allows to control the permissions applied to a dotfile using the Dotdrop allows to control the permissions applied to a dotfile using the