From: zen96285 <zen96285@xxxxxxxxx>
The git log documentation says "The default option is 'short'." This is wrong. After testing, the default value of '--decorate' is 'auto', not 'short'.
There is no difference between 'auto' and 'short' in terminal, but there is a significant difference in how they behave in the shell.The information generated by the 'short' can be saved in shell variables, while the 'auto' can't.
Signed-off-by: AndyAo Zen96285@xxxxxxxxx
---
describe-doc:fix a obscure error description in the git log documenta…
The git log documentation says "The default option is 'short'." This is
wrong. After testing, the default value of '--decorate' is 'auto', not
'short'.
There is no difference between 'auto' and 'short' in terminal, but there
is a significant difference in how they behave in the shell.The
information generated by the 'short' can be saved in shell variables,
while the 'auto' can't.
Signed-off-by: AndyAo Zen96285@xxxxxxxxx
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1030%2FAndy-AO%2Ffix_a_obscure_error_description_in_the_git_log_documentation-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1030/Andy-AO/fix_a_obscure_error_description_in_the_git_log_documentation-v1
Pull-Request: https://github.com/git/git/pull/1030
Documentation/git-log.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 1bbf865a1b2d..37a4694b060a 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -39,7 +39,7 @@ OPTIONS
full ref name (including prefix) will be printed. If 'auto' is
specified, then if the output is going to a terminal, the ref names
are shown as if 'short' were given, otherwise no ref names are
- shown. The default option is 'short'.
+ shown. The default option is 'auto'.
--decorate-refs=<pattern>::
--decorate-refs-exclude=<pattern>::
base-commit: 4e42405f00ecbbee412846f48cb0253efeebe726
--
gitgitgadget
