coliru

commit 0c88a229462e569b36847782d726c149fd7749a9
parent c9c1afb4784b1d3daa651f4ac23e4749633cf65b
Author: Asher Morgan <59518073+ashermorgan@users.noreply.github.com>
Date:   Mon,  8 Jul 2024 16:38:55 -0700

Update README.md and comments in example manifests

Diffstat:
M
README.md
 | 
8
+++++---
M
examples/basic/manifest.yml
 | 
8
++++----
M
examples/test/manifest.yml
 | 
10
+++++-----

3 files changed, 14 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
@@ -38,8 +38,8 @@ Some other helpful options include:
 - `--help`, `-h`: Print full help information
 - `--list-tags`, `-l`: List the tags in the manifest and quit without installing
 - `--dry-run`, `-n`: Do a trial run without any permanent changes
-- `--copy`: Interpret link commands as copy commands
 - `--host <HOST>`: Install dotfiles on another machine over SSH
+- `--copy`: Interpret link commands as copy commands
 
 ### Manifest File
 
@@ -50,9 +50,11 @@ to an array of tags. Each command is run from the directory containing the
 manifest file, or relative to the `~/coliru` directory when installing over SSH.
 
 - The **copy** command copies a dotfile (`src`) to a destination (`dst`).
+  Missing parent directories are created automatically.
 - The **link** command links a dotfile (`src`) to a destination (`dst`) using
-  symbolic links on Unix and hard links on Windows. Coliru will run copy
-  commands in place of link commands when installing over SSH.
+  symbolic links on Unix and hard links on Windows. Missing parent directories
+  are created automatically and coliru will run copy commands in place
+  of link commands when installing over SSH.
 - The **run** command executes a script (`src`) from the command line, using
   `sh` on Unix and `cmd` on Windows, with an optional `prefix` (e.g. `python3`)
   or `postfix` (e.g. `arg1 arg2 arg3`) string. Inside `postfix`, `$COLIRU_RULES`
diff --git a/examples/basic/manifest.yml b/examples/basic/manifest.yml
@@ -7,10 +7,10 @@
 # └── vimrc
 
 # For testing purposes, all files are given the .coliru suffix so they won't
-# overwrite existing dotfiles. The .vimrc file is linked to its destination so
-# that changes are synced with the dotfile repo. In contrast, the .gitconfig
-# file is only copied so that the name & email fields can be modified without
-# changing the version in the dotfile repo.
+# overwrite existing dotfiles. The .bashrc and .vimrc files are linked to their
+# destinations so that changes are synced with the dotfile repo. In contrast,
+# the .gitconfig file is copied so that the name & email fields can be modified
+# without changing the version in the dotfile repo.
 
 steps:
   - copy:
diff --git a/examples/test/manifest.yml b/examples/test/manifest.yml
@@ -1,5 +1,5 @@
 # Note: copy_manifest() updates replaces ~/ and scripts/ with unique paths for
-# ssh e2e tests and Windows tests to ensure test dotfiles are isolated
+# Windows and ssh e2e tests to ensure test dotfiles are isolated
 
 steps:
   - copy:
@@ -8,8 +8,8 @@ steps:
     tags: [ windows, linux, macos ]
 
   - copy:
-    - src: scripts/foo # foo is a "run dependency" for script.sh
-      dst: scripts/foo
+    - src: scripts/foo
+      dst: scripts/foo # foo is a "run dependency" for script.sh
     link:
     - src: bashrc
       dst: ~/.bashrc
@@ -22,8 +22,8 @@ steps:
     tags: [ linux, macos ]
 
   - copy:
-    - src: scripts/foo # foo is a "run dependency" for script.bat
-      dst: scripts/foo
+    - src: scripts/foo
+      dst: scripts/foo # foo is a "run dependency" for script.sh
     link:
     - src: vimrc
       dst: ~/_vimrc