From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS53758 23.128.96.0/24 X-Spam-Status: No, score=-4.0 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW, SPF_HELO_PASS,SPF_PASS shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by dcvr.yhbt.net (Postfix) with ESMTP id 68A981F5AE for ; Mon, 31 May 2021 06:01:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229970AbhEaGCl (ORCPT ); Mon, 31 May 2021 02:02:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42652 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229752AbhEaGCj (ORCPT ); Mon, 31 May 2021 02:02:39 -0400 Received: from mail-wm1-x334.google.com (mail-wm1-x334.google.com [IPv6:2a00:1450:4864:20::334]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1CEC4C061574 for ; Sun, 30 May 2021 23:00:59 -0700 (PDT) Received: by mail-wm1-x334.google.com with SMTP id m18so5549641wmq.0 for ; Sun, 30 May 2021 23:00:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=message-id:from:date:subject:fcc:content-transfer-encoding :mime-version:to:cc; bh=UFDiDZ5cEckV1Hp9OWqmKNoNlNzC9M1wYI3KqcwKC7Q=; b=JAYJte6kgv7jTNXLaGQKDGbbmdVyRVKS0fPLlg0jmFE9l0jjRhf53EIDyKVt0tkZ3C jSBFWOA3p5YPto4aZL61ENbYZW1rNBBNq3rAsFLQ5WCX7AgDtYYlikdEbScMDnwkBVI5 EmO7sjloTc23+OVDEF4URj6qAqMz2g+xUM5b2pNwsvVxj5fBsjmyN6e1YJAFeLBT9DTo 7GwdBNCVT5rTuNwirBSmtTTPemCMUlcNlkXcbTHdjw28jUuTpyZnThCtoSoirbn58gzO 76r8uWRi2NTGplvw+LyGnBxMYaW9XRoPs4FTYYQFEhSDKRRcumJMqQU6N0XWH9bpmsPb 9HOQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:message-id:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=UFDiDZ5cEckV1Hp9OWqmKNoNlNzC9M1wYI3KqcwKC7Q=; b=l3GoFT12p8hrK7nnfdypCanXn31op7GEjJx082pb9xk2SYY7iynkR7R4i164V0vHEu PGxh+fcbGBAk2QInvM7eNblS8TSV9D9MWGTERQmIE7ay98hB7k0vMOnrICS7bDKq7Cqn ETsvym/ex95vOeK6Ao1lPA195+gNtefh2gD8BTS6Fpl5gfLSofoyLKjic/9mLJw9J2bX paF3QUuaYSNdT/lI8Tgf2OTxTDDvlsHX8CvEGMt67OpJUo2X9cHGpzJfcjLp0tMq+6Ok /zm43uPlVSYdPeXIxexFCjDeCjXF9NVCNLNhRHcGWY9+h6/xe6gpkGnhIniejbWcFvq1 +V6Q== X-Gm-Message-State: AOAM533PkFpaf2K4OH4Z/2OheNJftBkgGvtfiM6x22/tSuYkv6fL3AFX hqss0GMuhZsYdVq8HpFK1eygIvPsjLs= X-Google-Smtp-Source: ABdhPJzUCwcWvsK/o/5Us1jCwajzz3sk2oLXzGk70ch4hg7boTboGKgt6qfmd9ibvbMWaqIJ1Vn1sA== X-Received: by 2002:a1c:f70b:: with SMTP id v11mr19747335wmh.186.1622440857525; Sun, 30 May 2021 23:00:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p5sm17506784wrd.25.2021.05.30.23.00.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 30 May 2021 23:00:57 -0700 (PDT) Message-Id: From: "Andy AO via GitGitGadget" Date: Mon, 31 May 2021 06:00:56 +0000 Subject: [PATCH] describe-doc:fix a obscure error description in the git log documentation Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: Bagas Sanjaya , Felipe Contreras , "Robert P. J. Day" , Derrick Stolee , Andy AO , zen96285 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: zen96285 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=:: --decorate-refs-exclude=:: base-commit: 4e42405f00ecbbee412846f48cb0253efeebe726 -- gitgitgadget