Skip to content

Commit

Permalink
docs: Clarify requirement to set sourceDir when used in Codespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Aug 6, 2024
1 parent 7a68dfc commit d5579c7
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit d5579c7

Please sign in to comment.