Re: [PATCH] log: Update log.follow doc and add to config.txt

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, 2015-10-06 at 21:14 -0400, Eric N. Vander Weele wrote:
> Documentation/config.txt does not include the documentation for
> log.follow that is in Documentation/git-log.txt.  This commit adds the
> log.follow documentation to config.txt and also updates the wording to
> be consistent with the format that is followed by other boolean
> configuration variables.
> 
> Signed-off-by: Eric N. Vander Weele <ericvw@xxxxxxxxx>
> ---
>  Documentation/config.txt  | 6 ++++++
>  Documentation/git-log.txt | 8 ++++----
>  2 files changed, 10 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 4d3cb10..391a0c3 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1838,6 +1838,12 @@ log.decorate::
>  	specified, the full ref name (including prefix) will be printed.
>  	This is the same as the log commands '--decorate' option.
>  
> +log.follow::
> +	If `true`, `git log` will act as if the `--follow` option was used when
> +	a single <path> is given.  This has the same limitations as `--follow`,
> +	i.e. it cannot be used to follow multiple files and does not work well
> +	on non-linear history.
> +
>  log.showRoot::
>  	If true, the initial commit will be shown as a big creation event.
>  	This is equivalent to a diff against an empty tree.
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 97b9993..03f9580 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -185,10 +185,10 @@ log.date::
>  	dates like `Sat May 8 19:35:34 2010 -0500`.
>  
>  log.follow::
> -	If a single <path> is given to git log, it will act as
> -	if the `--follow` option was also used.  This has the same
> -	limitations as `--follow`, i.e. it cannot be used to follow
> -	multiple files and does not work well on non-linear history.
> +	If `true`, `git log` will act as if the `--follow` option was used when
> +	a single <path> is given.  This has the same limitations as `--follow`,
> +	i.e. it cannot be used to follow multiple files and does not work well
> +	on non-linear history.
>  
>  log.showRoot::
>  	If `false`, `git log` and related commands will not treat the


LGTM.

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]