git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/3] Document GIT_MERGE_VERBOSITY environmental variable
@ 2007-07-12 23:54 Jakub Narebski
  2007-07-12 23:54 ` [PATCH 2/3] Document long options '--message=<msg>' and '--no-commit' Jakub Narebski
  2007-07-12 23:54 ` [PATCH 3/3] Document git commit --untracked-files and --verbose Jakub Narebski
  0 siblings, 2 replies; 3+ messages in thread
From: Jakub Narebski @ 2007-07-12 23:54 UTC (permalink / raw)
  To: git; +Cc: Junio C Hamano, Jakub Narebski

While at it, add "Configuration" section mentioning merge.summary
configuration variable (which is mentioned in git-fmt-merge-msg(1)
man page, but it is a plumbing command), and merge.verbosity
configuration variable (so there is a place to make reference
from "Environment Variables" section of git(7) man page) to the
git-merge(1) man page.

The configuration variable merge.verbosity and environmental variable
GIT_MERGE_VERBOSITY were introduced in commit 8c3275ab, which also
documented configuration variable but not environmental variable.

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
The alternative to adding "Configuration" section to git-merge(1)
man page, and referring to it in the description of GIT_MERGE_VERBOSITY
environmental variable in git(7), would be to either refer to
git-config(1), or add full description similar to description of
merge.verbosity to git(7).

Perhaps above paragraph should be added to commit message?

I have put shortened sha1 of commit which introduced setting of
a merge verbosity to be able to go to it from graphical UI
like for example gitweb.

 Documentation/config.txt    |    1 +
 Documentation/git-merge.txt |   15 +++++++++++++++
 Documentation/git.txt       |    5 +++++
 3 files changed, 21 insertions(+), 0 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 4b67f0a..6cd0ff0 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -567,6 +567,7 @@ merge.verbosity::
 	message if conflicts were detected. Level 1 outputs only
 	conflicts, 2 outputs conflicts and file changes.  Level 5 and
 	above outputs debugging information.  The default is level 2.
+	Can be overriden by 'GIT_MERGE_VERBOSITY' environment variable.
 
 merge.<driver>.name::
 	Defines a human readable name for a custom low-level
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index d285cba..1442e06 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -43,6 +43,21 @@ If you tried a merge which resulted in a complex conflicts and
 would want to start over, you can recover with
 gitlink:git-reset[1].
 
+CONFIGURATION
+-------------
+
+merge.summary::
+        Whether to include summaries of merged commits in newly
+        merge commit messages. False by default.
+
+merge.verbosity::
+	Controls the amount of output shown by the recursive merge
+	strategy.  Level 0 outputs nothing except a final error
+	message if conflicts were detected. Level 1 outputs only
+	conflicts, 2 outputs conflicts and file changes.  Level 5 and
+	above outputs debugging information.  The default is level 2.
+	Can be overriden by 'GIT_MERGE_VERBOSITY' environment variable.
+
 
 HOW MERGE WORKS
 ---------------
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 10c7bb3..895c25c 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -410,6 +410,11 @@ parameter, <path>.
 
 other
 ~~~~~
+'GIT_MERGE_VERBOSITY'::
+	A number controlling the amount of output shown by
+	the recursive merge strategy.  Overrides merge.verbosity.
+	See gitlink:git-merge[1]
+
 'GIT_PAGER'::
 	This environment variable overrides `$PAGER`.
 
-- 
1.5.2.2

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH 2/3] Document long options '--message=<msg>' and '--no-commit'
  2007-07-12 23:54 [PATCH 1/3] Document GIT_MERGE_VERBOSITY environmental variable Jakub Narebski
@ 2007-07-12 23:54 ` Jakub Narebski
  2007-07-12 23:54 ` [PATCH 3/3] Document git commit --untracked-files and --verbose Jakub Narebski
  1 sibling, 0 replies; 3+ messages in thread
From: Jakub Narebski @ 2007-07-12 23:54 UTC (permalink / raw)
  To: git; +Cc: Junio C Hamano, Jakub Narebski

Document that '--message=<msg>' is long version of '-m <msg>' in
git-commit, and that '--no-checkout' is long version of '-n' in
git-clone.

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
This patch was silently skipped in the 11 patches long series
of documenting undocumented long options
  "[PATCH 00/11] Document missing options"
(or rather two patches which are concatenated into this one).

 Documentation/git-clone.txt  |    1 +
 Documentation/git-commit.txt |    2 +-
 2 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 2f39864..a0a10e3 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -64,6 +64,7 @@ OPTIONS
 	Operate quietly.  This flag is passed to "rsync" and
 	"git-fetch-pack" commands when given.
 
+--no-checkout::
 -n::
 	No checkout of HEAD is performed after the clone is complete.
 
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 53a7bb0..352a494 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -71,7 +71,7 @@ OPTIONS
 	Override the author name used in the commit.  Use
 	`A U Thor <author@example.com>` format.
 
--m <msg>::
+-m <msg>|--message=<msg>::
 	Use the given <msg> as the commit message.
 
 -s|--signoff::
-- 
1.5.2.2

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH 3/3] Document git commit --untracked-files and --verbose
  2007-07-12 23:54 [PATCH 1/3] Document GIT_MERGE_VERBOSITY environmental variable Jakub Narebski
  2007-07-12 23:54 ` [PATCH 2/3] Document long options '--message=<msg>' and '--no-commit' Jakub Narebski
@ 2007-07-12 23:54 ` Jakub Narebski
  1 sibling, 0 replies; 3+ messages in thread
From: Jakub Narebski @ 2007-07-12 23:54 UTC (permalink / raw)
  To: git; +Cc: Junio C Hamano, Jakub Narebski

Documentation based on description of commit 443f8338 which added
'-u'|'--untracked-files' option to git-status, and on git-runstatus(1)
man page.

Note that those options apply also to git-status.

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
Junio C Hamano wrote:
> Jakub Narebski <jnareb@gmail.com> writes:
> 
>> +-u|--untracked-files::
>> +    Show all untracked files, also those in uninteresting
>> +    directories.
>> +
>> +-v|--verbose::
>> +    Show the diff output between the HEAD commit and what
>> +    would be committed.
>> +
> 
> Thanks -- "show" sounds a bit funny, though, don't you think?

Is this one, with a longer description of options, better?
The previous version of this patch got skipped...

 Documentation/git-commit.txt |   15 ++++++++++++++-
 1 files changed, 14 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 352a494..f96142f 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -8,7 +8,7 @@ git-commit - Record changes to the repository
 SYNOPSIS
 --------
 [verse]
-'git-commit' [-a | --interactive] [-s] [-v]
+'git-commit' [-a | --interactive] [-s] [-v] [-u]
 	   [(-c | -C) <commit> | -F <file> | -m <msg> | --amend]
 	   [--no-verify] [-e] [--author <author>]
 	   [--] [[-i | -o ]<file>...]
@@ -115,6 +115,19 @@ but can be used to amend a merge commit.
 	as well.  This is usually not what you want unless you
 	are concluding a conflicted merge.
 
+-u|--untracked-files::
+	Show all untracked files, also those in uninteresting
+	directories, in the "Untracked files:" section of commit
+	message template.  Without this option only its name and
+	a trailing slash are displayed for each untracked
+	directory.
+
+-v|--verbose::
+	Show unified diff between the HEAD commit and what
+	would be committed at the bottom of the commit message
+	template.  Note that this diff output doesn't have its
+	lines prefixed with '#'.
+
 -q|--quiet::
 	Suppress commit summary message.
 
-- 
1.5.2.2

^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2007-07-12 23:54 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-07-12 23:54 [PATCH 1/3] Document GIT_MERGE_VERBOSITY environmental variable Jakub Narebski
2007-07-12 23:54 ` [PATCH 2/3] Document long options '--message=<msg>' and '--no-commit' Jakub Narebski
2007-07-12 23:54 ` [PATCH 3/3] Document git commit --untracked-files and --verbose Jakub Narebski

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