Re: [PATCH] describe-doc:fix a obscure error description in the git log documentation

From: Bagas Sanjaya <bagasdotme@gmail.com>
Date: May 31, 2021, 06:41 UTC
Message-ID: <b5acad71-af41-ece2-6128-bca243f8f299@gmail.com>
In-Reply-To: <pull.1030.git.git.1622440856607.gitgitgadget@gmail.com>

Hi Andy, welcome to Git mailing list!

On 31/05/21 13.00, Andy AO via GitGitGadget wrote:

Show 6 quoted lines

> 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.
>

Why are info generated with 'short' option (and not 'auto') can be assigned to a variable?

Show 11 quoted lines

> 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'.
>

Looks OK to me, thanks.

-- 
An old man doll... just what I always wanted! - Clara