mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-15 22:00:05 +00:00
Code Activity

update doc on chmod

Browse Source
This commit is contained in:
deadc0de6
2020-11-21 15:02:47 +01:00
parent 581c82da38
commit d42d810ab1
2 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/config-format.md
View File

@@ -46,7 +46,7 @@ Entry | Description
`src` | dotfile path within the `dotpath` (dotfile with empty `src` are ignored and considered installed, can use `variables` and `dynvariables`, make sure to quote) `src` | dotfile path within the `dotpath` (dotfile with empty `src` are ignored and considered installed, can use `variables` and `dynvariables`, make sure to quote)
`link` | define how this dotfile is installed. Possible values: *nolink*, *link*, *link_children* (see [Symlinking dotfiles](config.md#symlink-dotfiles)) (defaults to value of `link_dotfile_default`) `link` | define how this dotfile is installed. Possible values: *nolink*, *link*, *link_children* (see [Symlinking dotfiles](config.md#symlink-dotfiles)) (defaults to value of `link_dotfile_default`)
`actions` | list of action keys that need to be defined in the **actions** entry below (see [actions](config-details.md#entry-actions)) `actions` | list of action keys that need to be defined in the **actions** entry below (see [actions](config-details.md#entry-actions))
`chmod` | defines the file permission in octal notation to apply during installation (see [permissions](config.md#permissions)) `chmod` | defines the file permissions in octal notation to apply during installation (see [permissions](config.md#permissions))
`cmpignore` | list of patterns to ignore when comparing (enclose in quotes when using wildcards, see [ignore patterns](config.md#ignore-patterns)) `cmpignore` | list of patterns to ignore when comparing (enclose in quotes when using wildcards, see [ignore patterns](config.md#ignore-patterns))
`ignoreempty` | if true empty template will not be deployed (defaults to value of `ignoreempty`) `ignoreempty` | if true empty template will not be deployed (defaults to value of `ignoreempty`)
`instignore` | list of patterns to ignore when installing (enclose in quotes when using wildcards, see [ignore patterns](config.md#ignore-patterns)) `instignore` | list of patterns to ignore when installing (enclose in quotes when using wildcards, see [ignore patterns](config.md#ignore-patterns))
@@ -73,6 +73,7 @@ Entry | Description
actions: actions:
- <action-key> - <action-key>
template: (true|false) template: (true|false)
chmod: '<file-permissions>'
trans_read: <transformation-key> trans_read: <transformation-key>
trans_write: <transformation-key> trans_write: <transformation-key>
``` ```

19
docs/config.md
View File

@@ -61,10 +61,23 @@ Here are some rules on the use of variables in configs:
## Permissions ## Permissions
Dotdrop allows to control the permission applied to a dotfile using the Dotdrop allows to control the permissions applied to a dotfile using the
config dotfile entry [chmod](config-format.md#dotfiles-entry). config dotfile entry [chmod](config-format.md#dotfiles-entry).
A [chmod](config-format.md#dotfiles-entry) entry on a directory is applied to the A [chmod](config-format.md#dotfiles-entry) entry on a directory
directory only, not recursively. is applied to the directory only, not recursively.
For example
```yaml
dotfiles:
f_file:
src: file
dst: ~/file
chmod: 644
f_dir:
src: dir
dst: ~/dir
chmod: 744
```
On `import` the following rules are applied: On `import` the following rules are applied: