Document interaction of root with glob

evilmartians · Feb 3, 2025 · 81b313b · 81b313b
1 parent 5fde6d6
commit 81b313b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/mdbook/configuration/glob.md b/docs/mdbook/configuration/glob.md
@@ -31,6 +31,10 @@ pre-commit:
 
 For patterns that you can use see [this](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm) reference. We use [glob](https://github.com/gobwas/glob) library.
 
+***When using `root:`***
+
+Globs are still calculated from the actual root of the git repo, `root` is ignored.
+
 ***Behaviour of `**`***
 
 Note that the behaviour of `**` is different from typical glob implementations, like `ls` or tools like `lint-staged` in that a double-asterisk matches 1+ directories deep, not zero or more directories.

diff --git a/docs/mdbook/configuration/root.md b/docs/mdbook/configuration/root.md
@@ -33,3 +33,9 @@ pre-commit:
       glob: "*.{js,ts}"
       run: yarn eslint --fix {staged_files} && git add {staged_files}
 ```
+
+**Notes**
+
+***When using `root:`***
+
+Globs are still calculated from the actual root of the git repo, `root` is ignored.