[PATCH] documentation: camel case of config option, and "no" instead of "false"

Jonas Wunderlich via GitGitGadget· Mar 12, 2024, 21:34 UTC · lore

From: Jonas Wunderlich <git@03j.de>

The `status.showUntrackedFiles` config option only accepts the values "no", "normal" or "all", but not as this part of the man page suggested "false".

Signed-off-by: Jonas Wunderlich <git@03j.de>
---
    documentation: camel case of config option, and "no" instead of "false"

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1686%2Fjonas-w%2Fpatch-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1686/jonas-w/patch-1-v1
Pull-Request: https://github.com/git/git/pull/1686

 Documentation/git-status.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/git-status.txt +1 −1

diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 4dbb88373bc..b0f36fabfb3 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -472,7 +472,7 @@ again, because your configuration may already be caching `git status`
 results, so it could be faster on subsequent runs.
 
 * The `--untracked-files=no` flag or the
-	`status.showUntrackedfiles=false` config (see above for both):
+	`status.showUntrackedFiles=no` config (see above for both):
 	indicate that `git status` should not report untracked
 	files. This is the fastest option. `git status` will not list
 	the untracked files, so you need to be careful to remember if

base-commit: 945115026aa63df4ab849ab14a04da31623abece

-- 
gitgitgadget

Junio C Hamano· Mar 13, 2024, 16:14 UTC · re: Jonas Wunderlich via GitGitGadget · lore

Re: [PATCH] documentation: camel case of config option, and "no" instead of "false"

"Jonas Wunderlich via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 8 quoted lines

> From: Jonas Wunderlich <git@03j.de>
>
> The `status.showUntrackedFiles` config option only accepts the values "no",
> "normal" or "all", but not as this part of the man page suggested "false".
>
> Signed-off-by: Jonas Wunderlich <git@03j.de>
> ---
>     documentation: camel case of config option, and "no" instead of "false"

The title does not say what variable was broken, and might be better to pick one that does so, perhaps

	documentation: status.showUntrackedFiles does not take 'false'

or something.

The name of the configuration variable does make it sound that it is a Boolean ("do you want me to show untracked files?") and the code may want to be updated to do accept any string that we recognise as a Boolean and take 'false' as "no", take 'true' as "normal", and treat all other input with the current logic. But documenting the long-established behaviour correctly is the right thing to do no matter what we will do next.

Thanks.  Will apply.

Show 22 quoted lines

> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1686%2Fjonas-w%2Fpatch-1-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1686/jonas-w/patch-1-v1
> Pull-Request: https://github.com/git/git/pull/1686
>
>  Documentation/git-status.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index 4dbb88373bc..b0f36fabfb3 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -472,7 +472,7 @@ again, because your configuration may already be caching `git status`
>  results, so it could be faster on subsequent runs.
>  
>  * The `--untracked-files=no` flag or the
> -	`status.showUntrackedfiles=false` config (see above for both):
> +	`status.showUntrackedFiles=no` config (see above for both):
>  	indicate that `git status` should not report untracked
>  	files. This is the fastest option. `git status` will not list
>  	the untracked files, so you need to be careful to remember if
>
> base-commit: 945115026aa63df4ab849ab14a04da31623abece

patchdocumentation: camel case of config option, and "no" instead of "false"