From d5579c7837ff61426e4df3768bbf1a0f64700242 Mon Sep 17 00:00:00 2001 From: Tom Payne Date: Tue, 6 Aug 2024 00:23:35 +0000 Subject: [PATCH] docs: Clarify requirement to set sourceDir when used in Codespaces --- .../docs/user-guide/machines/containers-and-vms.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/assets/chezmoi.io/docs/user-guide/machines/containers-and-vms.md b/assets/chezmoi.io/docs/user-guide/machines/containers-and-vms.md index 63e2521e2d8..3f67c96b2a3 100644 --- a/assets/chezmoi.io/docs/user-guide/machines/containers-and-vms.md +++ b/assets/chezmoi.io/docs/user-guide/machines/containers-and-vms.md @@ -40,6 +40,12 @@ sourceDir = {{ .chezmoi.sourceDir | quote }} {{- end }} ``` +!!! warning + + Setting the `sourceDir` configuration variable to `.chezmoi.sourceDir` is + required because Codespaces clones your dotfiles repo to a different one to + chezmoi's default. + This sets the `codespaces` template variable, so you don't have to repeat `(env "CODESPACES")` in your templates. It also sets the `sourceDir` configuration to the `--source` argument passed in `chezmoi init`.