Skip to content

Commit

Permalink
docs: Add admonitions linking remove and forget
Browse files Browse the repository at this point in the history
As suggested in #3362, this should improve discoverability by
cross-linking between the two types of target removal.
  • Loading branch information
halostatue committed Nov 22, 2023
1 parent 7cd0423 commit 47609a3
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
5 changes: 5 additions & 0 deletions assets/chezmoi.io/docs/reference/commands/forget.md
Expand Up @@ -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).
5 changes: 5 additions & 0 deletions assets/chezmoi.io/docs/reference/commands/remove.md
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion 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).

0 comments on commit 47609a3

Please sign in to comment.