summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCasey Rodarmor <casey@rodarmor.com>2023-12-28 17:04:33 -0800
committerGitHub <noreply@github.com>2023-12-28 17:04:33 -0800
commit85b5a92e69806241d51d0933f619e30261d697dc (patch)
treee7dffe92bc1f931caf0ced0acaaf88a08d70993b
parenta1bd70a030582501aba68418a44e140e76de4ac3 (diff)
Document submodule working directory (#1789)
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1dd9ca43..ee472a51 100644
--- a/README.md
+++ b/README.md
@@ -2405,11 +2405,15 @@ the module file may have any capitalization.
Environment files are loaded for the root justfile.
-Currently, recipes in submodules run with the same working directory as the
-root `justfile`, and the `justfile()` and `justfile_directory()` functions
-return the path to the root `justfile` and its parent directory.
+Recipes in submodules without the `[no-cd]` attribute run with the working
+directory set to the directory containing the submodule source file.
-See the [module stabilization tracking issue](https://github.com/casey/just/issues/929) for more information.
+`justfile()` and `justfile_directory()` always return the path to the root
+justfile and the directory that contains it, even when called from submodule
+recipes.
+
+See the [module stabilization tracking issue](https://github.com/casey/just/issues/929)
+for more information.
### Hiding `justfile`s