From: "Andy AO via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
Felipe Contreras <felipe.contreras@gmail.com>,
"Robert P. J. Day" <rpjday@crashcourse.ca>,
Derrick Stolee <stolee@gmail.com>, Andy AO <zen96285@gmail.com>,
zen96285 <zen96285@gmail.com>
Subject: [PATCH] describe-doc:fix a obscure error description in the git log documentation
Date: Mon, 31 May 2021 06:00:56 +0000 [thread overview]
Message-ID: <pull.1030.git.git.1622440856607.gitgitgadget@gmail.com> (raw)
From: zen96285 <zen96285@gmail.com>
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@gmail.com
---
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@gmail.com
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
next reply other threads:[~2021-05-31 6:01 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-31 6:00 Andy AO via GitGitGadget [this message]
2021-05-31 6:41 ` [PATCH] describe-doc:fix a obscure error description in the git log documentation Bagas Sanjaya
2021-05-31 6:47 ` Đoàn Trần Công Danh
2021-05-31 6:57 ` Junio C Hamano
2021-05-31 7:18 ` Đoàn Trần Công Danh
2021-05-31 7:49 ` Bagas Sanjaya
2021-05-31 10:00 ` Đoàn Trần Công Danh
2021-06-08 1:58 ` [PATCH] doc/log: correct default for --decorate Đoàn Trần Công Danh
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1030.git.git.1622440856607.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=rpjday@crashcourse.ca \
--cc=stolee@gmail.com \
--cc=zen96285@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).