git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Eric N. Vander Weele" <ericvw@gmail.com>
To: git@vger.kernel.org
Cc: "Eric N. Vander Weele" <ericvw@gmail.com>,
	dturner@twopensource.com, gitster@pobox.com
Subject: [PATCH] log: Update log.follow doc and add to config.txt
Date: Tue,  6 Oct 2015 21:14:33 -0400	[thread overview]
Message-ID: <1444180473-8518-1-git-send-email-ericvw@gmail.com> (raw)

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

             reply	other threads:[~2015-10-07  1:14 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-07  1:14 Eric N. Vander Weele [this message]
2015-10-07  1:20 ` [PATCH] log: Update log.follow doc and add to config.txt David Turner

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1444180473-8518-1-git-send-email-ericvw@gmail.com \
    --to=ericvw@gmail.com \
    --cc=dturner@twopensource.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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.
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 NNTP newsgroup(s).