From 2ef59e2299c866db8f127454022153ca0cd67fbb Mon Sep 17 00:00:00 2001 From: Andrei Ciobanu Date: Wed, 14 May 2025 15:33:59 +0300 Subject: [PATCH] Add note about the diff dependency on the fmt command (#2801) Signed-off-by: Andrei Ciobanu --- website/docs/cli/commands/fmt.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/docs/cli/commands/fmt.mdx b/website/docs/cli/commands/fmt.mdx index a764bcf2c1..e8f1d6fd6f 100644 --- a/website/docs/cli/commands/fmt.mdx +++ b/website/docs/cli/commands/fmt.mdx @@ -57,5 +57,8 @@ The command-line flags are all optional. The following flags are available: * `-list=false` - Don't list the files containing formatting inconsistencies. * `-write=false` - Don't overwrite the input files. (This is implied by `-check` or when the input is STDIN.) * `-diff` - Display diffs of formatting changes. + * When using this flag, ensure that `diff` tool is installed. This is used internally for providing a better user experience. * `-check` - Check if the input is formatted. Exit status will be 0 if all input is properly formatted. If not, exit status will be non-zero and the command will output a list of filenames whose files are not properly formatted. * `-recursive` - Also process files in subdirectories. By default, only the given directory (or current directory) is processed. + +