threads / patch / 7866

patch, 8 partsRemoving -n option from git-diff-files documentation

Subject: [PATCH 1/8] Removing -n option from git-diff-files documentation

## tl;dr

10 messages between Apr 27, 2007 and Apr 29, 2007. Diffs are folded; open one to read it.

replies: 9people: 3as markdown or json

Andrew Ruder· Apr 27, 2007, 05:05 UTC · lore

-n is not a short form of --no-index as the documentation suggests. Removing it from the documentation and command usage string.

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/git-diff-files.txt |    4 ++--
 builtin-diff-files.c             |    2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)
Show changes to 2 files +3 −3

Documentation/git-diff-files.txt, builtin-diff-files.c

diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index b78c4c6..2e1e29e 100644
--- a/Documentation/git-diff-files.txt
+++ b/Documentation/git-diff-files.txt
@@ -8,7 +8,7 @@ git-diff-files - Compares files in the working tree and the index
 
 SYNOPSIS
 --------
-'git-diff-files' [-q] [-0|-1|-2|-3|-c|--cc|-n|--no-index] [<common diff options>] [<path>...]
+'git-diff-files' [-q] [-0|-1|-2|-3|-c|--cc|--no-index] [<common diff options>] [<path>...]
 
 DESCRIPTION
 -----------
@@ -36,7 +36,7 @@ omit diff output for unmerged entries and just show "Unmerged".
 	diff, similar to the way 'diff-tree' shows a merge
 	commit with these flags.
 
-\-n,\--no-index::
+--no-index::
 	Compare the two given files / directories.
 
 -q::
diff --git a/builtin-diff-files.c b/builtin-diff-files.c
index 6ba5077..6cb30c8 100644
--- a/builtin-diff-files.c
+++ b/builtin-diff-files.c
@@ -10,7 +10,7 @@
 #include "builtin.h"
 
 static const char diff_files_usage[] =
-"git-diff-files [-q] [-0/-1/2/3 |-c|--cc|-n|--no-index] [<common diff options>] [<path>...]"
+"git-diff-files [-q] [-0/-1/2/3 |-c|--cc|--no-index] [<common diff options>] [<path>...]"
 COMMON_DIFF_OPTIONS_HELP;
 
 int cmd_diff_files(int argc, const char **argv, const char *prefix)
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:09 UTC · re: Andrew Ruder · lore

[PATCH 2/8] Document additional options for git-fetch

Document --quiet/-q and --verbose/-v Add -n as an alternate for --no-tags Fix some whitespace issues

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/fetch-options.txt |   17 ++++++++++++-----
 1 files changed, 12 insertions(+), 5 deletions(-)
Show changes to Documentation/fetch-options.txt +12 −5
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 5b4d184..bdc7332 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -1,13 +1,20 @@
+-q, \--quiet::
+	Pass --quiet to git-fetch-pack and silence any other internally
+	used programs.
+
+-v, \--verbose::
+	Be verbose.
+
 -a, \--append::
 	Append ref names and object names of fetched refs to the
 	existing contents of `.git/FETCH_HEAD`.  Without this
 	option old data in `.git/FETCH_HEAD` will be overwritten.
 
 \--upload-pack <upload-pack>::
-        When given, and the repository to fetch from is handled
-        by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
-        the command to specify non-default path for the command
-        run on the other end.
+	When given, and the repository to fetch from is handled
+	by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
+	the command to specify non-default path for the command
+	run on the other end.
 
 -f, \--force::
 	When `git-fetch` is used with `<rbranch>:<lbranch>`
@@ -16,7 +23,7 @@
 	fetches is a descendant of `<lbranch>`.  This option
 	overrides that check.
 
-\--no-tags::
+-n, \--no-tags::
 	By default, `git-fetch` fetches tags that point at
 	objects that are downloaded from the remote repository
 	and stores them locally.  This option disables this
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:09 UTC · re: Andrew Ruder · lore

[PATCH 3/8] Update git-fmt-merge documentation

Documentation/git-fmt-merge-msg.txt:
	--summary to list commit summaries on merge
	--no-summary
	--file to take merged objects from a file.
	Configuration option merge.summary
Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/git-fmt-merge-msg.txt |   25 ++++++++++++++++++++++++-
 1 files changed, 24 insertions(+), 1 deletions(-)
Show changes to Documentation/git-fmt-merge-msg.txt +24 −1
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index a70eb39..e560b30 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -8,7 +8,8 @@ git-fmt-merge-msg - Produce a merge commit message
 
 SYNOPSIS
 --------
-'git-fmt-merge-msg' <$GIT_DIR/FETCH_HEAD
+git-fmt-merge-msg [--summary | --no-summary] <$GIT_DIR/FETCH_HEAD
+git-fmt-merge-msg [--summary | --no-summray] -F <file>
 
 DESCRIPTION
 -----------
@@ -19,6 +20,28 @@ passed as the '<merge-message>' argument of `git-merge`.
 This script is intended mostly for internal use by scripts
 automatically invoking `git-merge`.
 
+OPTIONS
+-------
+
+--summary::
+	In addition to branch names, populate the log message with
+	one-line descriptions from the actual commits that are being
+	merged.
+
+--no-summary::
+	Do not list one-line descriptions from the actual commits being
+	merged.
+
+--file <file>, -F <file>::
+	Take the list of merged objects from <file> instead of
+	stdin.
+
+CONFIGURATION
+-------------
+
+merge.summary::
+	Whether to include summaries of merged commits in newly
+	merge commit messages. False by default.
 
 SEE ALSO
 --------
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:09 UTC · re: Andrew Ruder · lore

[PATCH 4/8] Update git-grep documentation

Documentation/git-grep.txt: Document -F/--fixed-strings to search for non-regexp patterns. Document -I to not search binary files. Document -<num> as a shortcut for -C<num>.

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/git-grep.txt |   19 +++++++++++++++----
 1 files changed, 15 insertions(+), 4 deletions(-)
Show changes to Documentation/git-grep.txt +15 −4
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 0140c8e..c5a5dad 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -12,12 +12,13 @@ SYNOPSIS
 'git-grep' [--cached]
 	   [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
 	   [-v | --invert-match] [-h|-H] [--full-name]
-	   [-E | --extended-regexp] [-G | --basic-regexp] [-F | --fixed-strings]
-	   [-n] [-l | --files-with-matches] [-L | --files-without-match]
+	   [-E | --extended-regexp] [-G | --basic-regexp]
+	   [-F | --fixed-strings] [-n]
+	   [-l | --files-with-matches] [-L | --files-without-match]
 	   [-c | --count] [--all-match]
 	   [-A <post-context>] [-B <pre-context>] [-C <context>]
-	   [-f <file>] [-e] <pattern> [--and|--or|--not|(|)|-e <pattern>...]
-	   [<tree>...]
+	   [-f <file>] [-e] <pattern>
+	   [--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
 	   [--] [<path>...]
 
 DESCRIPTION
@@ -39,6 +40,9 @@ OPTIONS
 	Ignore case differences between the patterns and the
 	files.
 
+-I::
+	Don't match the pattern in binary files.
+
 -w | --word-regexp::
 	Match the pattern only at word boundary (either begin at the
 	beginning of a line, or preceded by a non-word character; end at
@@ -64,6 +68,10 @@ OPTIONS
 	Use POSIX extended/basic regexp for patterns.  Default
 	is to use basic regexp.
 
+-F | --fixed-strings::
+	Use fixed strings for patterns (don't interpret pattern
+	as a regex).
+
 -n::
 	Prefix the line number to matching lines.
 
@@ -81,6 +89,9 @@ OPTIONS
 	line containing `--` between contiguous groups of
 	matches.
 
+-<num>::
+	A shortcut for specifying -C<num>.
+
 -f <file>::
 	Read patterns from <file>, one per line.
 
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:09 UTC · re: Andrew Ruder · lore

[PATCH 5/8] Update -L documentation for git-blame/git-annotate

Documenting alternate ways to use -L:

-L /regex/,end -L start,+offset

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/blame-options.txt |   24 ++++++++++++++++++++++--
 1 files changed, 22 insertions(+), 2 deletions(-)
Show changes to Documentation/blame-options.txt +22 −2
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 331f161..0099bb2 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -9,8 +9,28 @@
 --show-stats::
 	Include additional statistics at the end of blame output.
 
--L n,m::
-	Annotate only the specified line range (lines count from 1).
+-L <start>,<end>::
+	Annotate only the given line range.  <start> and <end> can take
+	one of these forms:
+
+	- number
++
+	If <start> or <end> is a number, it specifies an
+	absolute line number (lines count from 1).
++
+
+	- /regex/
++
+	This form will use the first line matching the given
+	POSIX regex.  If <end> is a regex, it will search
+	starting at the line given by <start>.
++
+
+	- +offset or -offset
++
+	This is only valid for <end> and will specify a number
+	of lines before or after the line given by <start>.
++
 
 -l::
 	Show long rev (Default: off).
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:09 UTC · re: Andrew Ruder · lore

[PATCH 6/8] Update git-http-push documentation

Documentation/git-http-push.txt: Changing --complete to --all. Added documentation for -d and -D to remote remote refs.

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/git-http-push.txt |   13 +++++++++++--
 1 files changed, 11 insertions(+), 2 deletions(-)
Show changes to Documentation/git-http-push.txt +11 −1
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index 4b4a461..a15cf5b 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -8,7 +8,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
 
 SYNOPSIS
 --------
-'git-http-push' [--complete] [--force] [--verbose] <url> <ref> [<ref>...]
+'git-http-push' [--all] [--force] [--verbose] <url> <ref> [<ref>...]
 
 DESCRIPTION
 -----------
@@ -18,7 +18,7 @@ remote branch.
 
 OPTIONS
 -------
---complete::
+--all::
 	Do not assume that the remote repository is complete in its
 	current state, and verify all objects in the entire local
 	ref's history exist in the remote repository.
@@ -34,6 +34,15 @@ OPTIONS
 	Report the list of objects being walked locally and the
 	list of objects successfully sent to the remote repository.
 
+-d, -D::
+	Remove <ref> from remote repository.  The specified branch
+	cannot be the remote HEAD.  If -d is specified the following
+	other conditions must also be met:
+
+	- Remote HEAD must resolve to an object that exists locally
+	- Specified branch resolves to an object that exists locally
+	- Specified branch is an ancestor of the remote HEAD
+
 <ref>...::
 	The remote refs to update.
 
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:09 UTC · re: Andrew Ruder · lore

[PATCH 7/8] Update git-local-fetch documentation

Documentation/git-local-fetch.txt: -s to use symbolic links instead of file-to-file copy, -l to use hardlinks, -n to never use file-to-file copies, --recover to resume a failed fetch.

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/git-local-fetch.txt |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
Show changes to Documentation/git-local-fetch.txt +14 −0
diff --git a/Documentation/git-local-fetch.txt b/Documentation/git-local-fetch.txt
index 22048d8..dd9e238 100644
--- a/Documentation/git-local-fetch.txt
+++ b/Documentation/git-local-fetch.txt
@@ -24,6 +24,16 @@ OPTIONS
 	Get all the objects.
 -v::
 	Report what is downloaded.
+-s::
+	Instead of regular file-to-file copying use symbolic links to the objects
+	in the remote repository.
+-l::
+	Before attempting symlinks (if -s is specified) or file-to-file copying the
+	remote objects, try to hardlink the remote objects into the local
+	repository.
+-n::
+	Never attempt to file-to-file copy remote objects.  Only useful with
+	-s or -l command-line options.
 
 -w <filename>::
         Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on
@@ -35,6 +45,10 @@ OPTIONS
 
 		<commit-id>['\t'<filename-as-in--w>]
 
+--recover::
+	Verify that everything reachable from target is fetched.  Used after
+	an earlier fetch is interrupted.
+
 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>
-- 
1.5.2.rc0.64.g8476
Andrew Ruder· Apr 27, 2007, 05:10 UTC · re: Andrew Ruder · lore

[PATCH 8/8] Update git-http-fetch documentation

Documentation/git-http-fetch.txt: --recover to resume a failed fetch operation.

Signed-off-by: Andrew Ruder <andy@aeruder.net>
---
 Documentation/git-http-fetch.txt |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
Show changes to Documentation/git-http-fetch.txt +4 −0
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 7dc2df3..4deabc3 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -39,6 +39,10 @@ commit-id::
 
 		<commit-id>['\t'<filename-as-in--w>]
 
+--recover::
+	Verify that everything reachable from target is fetched.  Used after
+	an earlier fetch is interrupted.
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
-- 
1.5.2.rc0.64.g8476
Petr Baudis· Apr 27, 2007, 18:05 UTC · re: Andrew Ruder · lore

Re: [PATCH 1/8] Removing -n option from git-diff-files documentation

On Fri, Apr 27, 2007 at 07:05:50AM CEST, Andrew Ruder wrote:
> -n is not a short form of --no-index as the documentation
> suggests.  Removing it from the documentation and command
> usage string.

Nevertheless, git-diff-files does accept -n, apparently to limit the number of outputted entries or something. Where is it documented?

-- 
				Petr "Pasky" Baudis
Stuff: http://pasky.or.cz/
Ever try. Ever fail. No matter. // Try again. Fail again. Fail better.
		-- Samuel Beckett
Junio C Hamano· Apr 29, 2007, 07:05 UTC · re: Petr Baudis · lore

Re: [PATCH 1/8] Removing -n option from git-diff-files documentation

Petr Baudis <pasky@suse.cz> writes:
Show 7 quoted lines
> On Fri, Apr 27, 2007 at 07:05:50AM CEST, Andrew Ruder wrote:
>> -n is not a short form of --no-index as the documentation
>> suggests.  Removing it from the documentation and command
>> usage string.
>
> Nevertheless, git-diff-files does accept -n, apparently to limit the
> number of outputted entries or something. Where is it documented?

It is not "accept" but more like "absorb and ignore". We (ab)use the option parser from revision traversal machinery when parsing "git-diff" options, but obviously options such as max-count that relate to commit limiting do not have any meaning to "git-diff-files" or "git-diff".

← back to recent threads