threads / patch / 40506

patchlog: Update log.follow doc and add to config.txt

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

## tl;dr

2 messages between Oct 7, 2015 and Oct 7, 2015. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Eric N. Vander Weele· Oct 7, 2015, 01:14 UTC · lore

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@gmail.com>
---
 Documentation/config.txt  | 6 ++++++
 Documentation/git-log.txt | 8 ++++----
 2 files changed, 10 insertions(+), 4 deletions(-)

Show changes to 2 files +10 −4

Documentation/config.txt, Documentation/git-log.txt

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

-- 
2.6.0

David Turner· Oct 7, 2015, 01:20 UTC · re: Eric N. Vander Weele · lore

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

On Tue, 2015-10-06 at 21:14 -0400, Eric N. Vander Weele wrote:

Show 48 quoted lines

> 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@gmail.com>
> ---
>  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.