diff --git a/docs/config-format.md b/docs/config-format.md index 361c95f..5d32131 100644 --- a/docs/config-format.md +++ b/docs/config-format.md @@ -26,8 +26,8 @@ Entry | Description | Default `import_variables` | list of paths to load variables from (absolute path or relative to the config file location see [Import variables from file](config-details.md#entry-import_variables)) | - `instignore` | list of patterns to ignore when installing, apply to all dotfiles (enclose in quotes when using wildcards, see [ignore patterns](config.md#ignore-patterns)) | - `keepdot` | preserve leading dot when importing hidden file in the `dotpath` | false -`link_dotfile_default` | set dotfile's `link` attribute to this value when undefined. Possible values: *nolink*, *link*, *link_children* (see [Symlinking dotfiles](config.md#symlink-dotfiles)) | `nolink` -`link_on_import` | set dotfile's `link` attribute to this value when importing. Possible values: *nolink*, *link*, *link_children* (see [Symlinking dotfiles](config.md#symlink-dotfiles)) | `nolink` +`link_dotfile_default` | set dotfile's `link` attribute to this value when undefined. Possible values: *nolink*, *link* (see [Symlinking dotfiles](config.md#symlink-dotfiles)) | `nolink` +`link_on_import` | set dotfile's `link` attribute to this value when importing. Possible values: *nolink*, *link* [Symlinking dotfiles](config.md#symlink-dotfiles)) | `nolink` `longkey` | use long keys for dotfiles when importing (see [Import dotfiles](usage.md#import-dotfiles)) | false `minversion` | (*for internal use, do not modify*) provides the minimal dotdrop version to use | - `showdiff` | on install show a diff before asking to overwrite (see `--showdiff`) | false diff --git a/docs/howto/symlink-dotfiles.md b/docs/howto/symlink-dotfiles.md index b4f8650..47bf442 100644 --- a/docs/howto/symlink-dotfiles.md +++ b/docs/howto/symlink-dotfiles.md @@ -13,6 +13,10 @@ Note that if the dotfile is using template directives, it will be symlinked into `~/.config/dotdrop` instead of directly into your *dotpath* (see [Templating symlinked dotfiles](#templating-symlinked-dotfiles)) +Although the config entries `link_on_import` and `link_dotfile_default` can be set to `link_children`, it +is not recommended since operations on a dotfile that is not a directory with the option `link_children` +will fail. + ## Symlink a dotfile Below is the ad-hoc way when [link_dotfile_default](https://dotdrop.readthedocs.io/en/latest/config-format/#config-entry) @@ -50,10 +54,12 @@ $ readlink ~/.bashrc ## Link children -This feature can be very useful for dotfiles when you don't want the entire +The `link_children` option can be very useful for dotfiles when you don't want the entire directory to be symlink but still want to keep a clean config files (with a limited number of entries). +This option set on a file that is not a directory will make any operation on the dotfile fail. + *Make sure to do a backup of your dotfiles with something like `cp -r {,.bak}`* A good example of its use is when managing `~/.vim` with dotdrop.