From b9ead752d4edfedb72dff96ef4097f2f4e567839 Mon Sep 17 00:00:00 2001 From: Austin Ziegler Date: Wed, 22 Nov 2023 11:04:25 -0500 Subject: [PATCH] docs: Add admonitions linking remove and forget As suggested in #3362, this should improve discoverability by cross-linking between the two types of target removal. --- assets/chezmoi.io/docs/reference/commands/forget.md | 5 +++++ assets/chezmoi.io/docs/reference/commands/remove.md | 5 +++++ assets/chezmoi.io/docs/reference/commands/rm.md | 2 +- 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/assets/chezmoi.io/docs/reference/commands/forget.md b/assets/chezmoi.io/docs/reference/commands/forget.md index 64cbdf1ecff..86c804e2fa0 100644 --- a/assets/chezmoi.io/docs/reference/commands/forget.md +++ b/assets/chezmoi.io/docs/reference/commands/forget.md @@ -8,3 +8,8 @@ have entries in the source state. They cannot be externals. ```console $ chezmoi forget ~/.bashrc ``` + +!!! info + + To remove targets from both the source state and destination directory, use + [`remove`](/reference/commands/remov). diff --git a/assets/chezmoi.io/docs/reference/commands/remove.md b/assets/chezmoi.io/docs/reference/commands/remove.md index ee832f43fef..76c91fd1571 100644 --- a/assets/chezmoi.io/docs/reference/commands/remove.md +++ b/assets/chezmoi.io/docs/reference/commands/remove.md @@ -5,3 +5,8 @@ Remove *target*s from both the source state and the destination directory. ## `-f`, `--force` Remove without prompting. + +!!! info + + To remove targets only from the source state, use + [`forget`](/reference/commands/forget). diff --git a/assets/chezmoi.io/docs/reference/commands/rm.md b/assets/chezmoi.io/docs/reference/commands/rm.md index 76f3f87b23b..d6ae7e0c506 100644 --- a/assets/chezmoi.io/docs/reference/commands/rm.md +++ b/assets/chezmoi.io/docs/reference/commands/rm.md @@ -1,3 +1,3 @@ # `rm` *target*... -`rm` is an alias for `remove`. +`rm` is an alias for [`remove`](/reference/commands/remove).