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

improve doc

Browse Source
This commit is contained in:
deadc0de6
2022-09-01 23:59:51 +02:00
parent 31300ba9d5
commit 9083624354
1 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/howto/symlink-dotfiles.md vendored
View File

@@ -6,11 +6,11 @@ which are controlled by the `link` config attribute of each dotfile:
* `link: nolink`: The dotfile (file or directory) is copied to its destination * `link: nolink`: The dotfile (file or directory) is copied to its destination
* `link: absolute`: The dotfile (file or directory) is linked to its destination using an absolute symlink * `link: absolute`: The dotfile (file or directory) is linked to its destination using an absolute symlink
* `link: relative`: The dotfile (file or directory) is linked to its destination using a relative symlink * `link: relative`: The dotfile (file or directory) is linked to its destination using a relative symlink
* `link: link_children`: The files/directories found under the dotfile (directory) are symlinked to their destination. For every direct child of `src`, symlink `dst/<childrenX>` to `src/<childrenX>` (See [Link children](#link-children)) * `link: link_children`: The direct children of the dotfile (directory only) are symlinked to their destination. For every direct child of `src`, symlink `dst/<childrenX>` to `src/<childrenX>` (See [Link children](#link-children))
Note that if the dotfile uses template directives, it will be symlinked into Note that if the dotfile uses template directives, it will first be installed to your
`~/.config/dotdrop` instead of directly into your *dotpath* `workdir` (defaults to `~/.config/dotdrop`) and then symlinked
(see [Templating symlinked dotfiles](#templating-symlinked-dotfiles)) (see [Templating symlinked dotfiles](#templating-symlinked-dotfiles)).
Although the config entries `link_on_import` and `link_dotfile_default` can be set to the value `link_children`, Although the config entries `link_on_import` and `link_dotfile_default` can be set to the value `link_children`,
it is not recommended, since operations on a dotfile that is not a directory with the option `link_children` it is not recommended, since operations on a dotfile that is not a directory with the option `link_children`
@@ -55,15 +55,12 @@ $ readlink ~/.bashrc
The `link_children` option 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 symlinked but still want to keep a clean config file (with a directory to be symlinked but still want to keep a clean config file (with a
limited number of entries). limited number of entries). Note that `link_children` can only be applied to directories.
Setting this option 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 <my-important-dotfile>{,.bak}`.* *Make sure to do a backup of your dotfiles with something like `cp -r <my-important-dotfile>{,.bak}`.*
A good example of its use is when managing `~/.vim` with dotdrop. A good example of its use is when managing `~/.vim` with dotdrop.
First let's see what it looks like when using `link: absolute`:
Here's what it looks like when using `link: absolute`:
```yaml ```yaml
config: config:
dotpath: dotfiles dotpath: dotfiles
@@ -85,8 +82,8 @@ after autoload plugged plugin snippets spell swap vimrc
As a result, all files under `~/.vim` will be managed by As a result, all files under `~/.vim` will be managed by
dotdrop (including unwanted directories like `spell`, `swap`, etc.). dotdrop (including unwanted directories like `spell`, `swap`, etc.).
A cleaner solution is to use `link_children` which allows to only symlink Now with `link_children` dotdrop allows to only symlink
files under the dotfile directory. Let's say only `after`, `plugin`, `snippets`, and `vimrc` direct children of the dotfile directory. Let's say only `after`, `plugin`, `snippets`, and `vimrc`
need to be managed in dotdrop. `~/.vim` is imported in dotdrop and cleaned of all unwanted need to be managed in dotdrop. `~/.vim` is imported in dotdrop and cleaned of all unwanted
files/directories, and then the `link` entry is set to `link_children` in the config file: files/directories, and then the `link` entry is set to `link_children` in the config file:
```yaml ```yaml