From d414e0fc7839ca97d20b82904a290ff444c4575c Mon Sep 17 00:00:00 2001 From: Tom Payne Date: Mon, 9 Sep 2024 19:47:59 +0000 Subject: [PATCH] docs: Add warning on using externals for large files or archives --- .../docs/user-guide/include-files-from-elsewhere.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/assets/chezmoi.io/docs/user-guide/include-files-from-elsewhere.md b/assets/chezmoi.io/docs/user-guide/include-files-from-elsewhere.md index 21f464d9e7d..8185f2c2b09 100644 --- a/assets/chezmoi.io/docs/user-guide/include-files-from-elsewhere.md +++ b/assets/chezmoi.io/docs/user-guide/include-files-from-elsewhere.md @@ -84,6 +84,13 @@ update Oh My Zsh and its plugins, refresh the downloaded archives. For example, Oh My Zsh may cache completions in `.oh-my-zsh/cache/completions/`, which should be added to your `.chezmoiignore` file. +!!! warning + + Do not use externals for large files or archives. chezmoi validates the exact + contents of externals every time you run `chezmoi diff`, `chezmoi apply`, or + `chezmoi verify`. For large externals, use a `run_once_` or `run_onchange_` + script to unpack the archive or file once instead. + ## Include a subdirectory with selected files from a URL Use `include` pattern filters to include only selected files from an archive