From 9e7ba14ac9d628cc70e60b64f1c966b7abe5c62d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mart=C3=AD?= Date: Fri, 13 Oct 2023 16:48:53 +0100 Subject: [PATCH] cmd/shfmt: document how EditorConfig's "ignore" works In particular, that it only applies when formatting directories. When directly formatting files, we don't ignore anything. For #1037. --- cmd/shfmt/shfmt.1.scd | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cmd/shfmt/shfmt.1.scd b/cmd/shfmt/shfmt.1.scd index 859e4a9b..07cfc374 100644 --- a/cmd/shfmt/shfmt.1.scd +++ b/cmd/shfmt/shfmt.1.scd @@ -131,7 +131,10 @@ keep_padding = true # --func-next-line function_next_line = true -# Ignore the entire "third_party" directory. +# Ignore the entire "third_party" directory when formatting directories, +# such as "shfmt -l -w .". +# When formatting regular files explicitly, like "shfmt -w third_party/foo.sh", +# the files are always formatted regardless of this setting. [third_party/**] ignore = true ```