Merge branch 'maint'

* maint:
  Update git-http-fetch documentation
  Update git-local-fetch documentation
  Update git-http-push documentation
  Update -L documentation for git-blame/git-annotate
  Update git-grep documentation
  Update git-fmt-merge documentation
  Document additional options for git-fetch
  Removing -n option from git-diff-files documentation
This commit is contained in:
Junio C Hamano 2007-04-26 23:29:09 -07:00
commit 4342572600
9 changed files with 105 additions and 17 deletions

View File

@ -9,8 +9,28 @@
--show-stats:: --show-stats::
Include additional statistics at the end of blame output. Include additional statistics at the end of blame output.
-L n,m:: -L <start>,<end>::
Annotate only the specified line range (lines count from 1). 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:: -l::
Show long rev (Default: off). Show long rev (Default: off).

View File

@ -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:: -a, \--append::
Append ref names and object names of fetched refs to the Append ref names and object names of fetched refs to the
existing contents of `.git/FETCH_HEAD`. Without this existing contents of `.git/FETCH_HEAD`. Without this
option old data in `.git/FETCH_HEAD` will be overwritten. option old data in `.git/FETCH_HEAD` will be overwritten.
\--upload-pack <upload-pack>:: \--upload-pack <upload-pack>::
When given, and the repository to fetch from is handled When given, and the repository to fetch from is handled
by 'git-fetch-pack', '--exec=<upload-pack>' is passed to by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
the command to specify non-default path for the command the command to specify non-default path for the command
run on the other end. run on the other end.
-f, \--force:: -f, \--force::
When `git-fetch` is used with `<rbranch>:<lbranch>` When `git-fetch` is used with `<rbranch>:<lbranch>`
@ -16,7 +23,7 @@
fetches is a descendant of `<lbranch>`. This option fetches is a descendant of `<lbranch>`. This option
overrides that check. overrides that check.
\--no-tags:: -n, \--no-tags::
By default, `git-fetch` fetches tags that point at By default, `git-fetch` fetches tags that point at
objects that are downloaded from the remote repository objects that are downloaded from the remote repository
and stores them locally. This option disables this and stores them locally. This option disables this

View File

@ -8,7 +8,7 @@ git-diff-files - Compares files in the working tree and the index
SYNOPSIS 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 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 diff, similar to the way 'diff-tree' shows a merge
commit with these flags. commit with these flags.
\-n,\--no-index:: --no-index::
Compare the two given files / directories. Compare the two given files / directories.
-q:: -q::

View File

@ -8,7 +8,8 @@ git-fmt-merge-msg - Produce a merge commit message
SYNOPSIS 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 DESCRIPTION
----------- -----------
@ -19,6 +20,28 @@ passed as the '<merge-message>' argument of `git-merge`.
This script is intended mostly for internal use by scripts This script is intended mostly for internal use by scripts
automatically invoking `git-merge`. 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 SEE ALSO
-------- --------

View File

@ -12,12 +12,13 @@ SYNOPSIS
'git-grep' [--cached] 'git-grep' [--cached]
[-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp] [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
[-v | --invert-match] [-h|-H] [--full-name] [-v | --invert-match] [-h|-H] [--full-name]
[-E | --extended-regexp] [-G | --basic-regexp] [-F | --fixed-strings] [-E | --extended-regexp] [-G | --basic-regexp]
[-n] [-l | --files-with-matches] [-L | --files-without-match] [-F | --fixed-strings] [-n]
[-l | --files-with-matches] [-L | --files-without-match]
[-c | --count] [--all-match] [-c | --count] [--all-match]
[-A <post-context>] [-B <pre-context>] [-C <context>] [-A <post-context>] [-B <pre-context>] [-C <context>]
[-f <file>] [-e] <pattern> [--and|--or|--not|(|)|-e <pattern>...] [-f <file>] [-e] <pattern>
[<tree>...] [--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
[--] [<path>...] [--] [<path>...]
DESCRIPTION DESCRIPTION
@ -39,6 +40,9 @@ OPTIONS
Ignore case differences between the patterns and the Ignore case differences between the patterns and the
files. files.
-I::
Don't match the pattern in binary files.
-w | --word-regexp:: -w | --word-regexp::
Match the pattern only at word boundary (either begin at the Match the pattern only at word boundary (either begin at the
beginning of a line, or preceded by a non-word character; end at 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 Use POSIX extended/basic regexp for patterns. Default
is to use basic regexp. is to use basic regexp.
-F | --fixed-strings::
Use fixed strings for patterns (don't interpret pattern
as a regex).
-n:: -n::
Prefix the line number to matching lines. Prefix the line number to matching lines.
@ -81,6 +89,9 @@ OPTIONS
line containing `--` between contiguous groups of line containing `--` between contiguous groups of
matches. matches.
-<num>::
A shortcut for specifying -C<num>.
-f <file>:: -f <file>::
Read patterns from <file>, one per line. Read patterns from <file>, one per line.

View File

@ -39,6 +39,10 @@ commit-id::
<commit-id>['\t'<filename-as-in--w>] <commit-id>['\t'<filename-as-in--w>]
--recover::
Verify that everything reachable from target is fetched. Used after
an earlier fetch is interrupted.
Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org> Written by Linus Torvalds <torvalds@osdl.org>

View File

@ -8,7 +8,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
SYNOPSIS SYNOPSIS
-------- --------
'git-http-push' [--complete] [--force] [--verbose] <url> <ref> [<ref>...] 'git-http-push' [--all] [--force] [--verbose] <url> <ref> [<ref>...]
DESCRIPTION DESCRIPTION
----------- -----------
@ -18,7 +18,7 @@ remote branch.
OPTIONS OPTIONS
------- -------
--complete:: --all::
Do not assume that the remote repository is complete in its Do not assume that the remote repository is complete in its
current state, and verify all objects in the entire local current state, and verify all objects in the entire local
ref's history exist in the remote repository. ref's history exist in the remote repository.
@ -34,6 +34,15 @@ OPTIONS
Report the list of objects being walked locally and the Report the list of objects being walked locally and the
list of objects successfully sent to the remote repository. 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>...:: <ref>...::
The remote refs to update. The remote refs to update.

View File

@ -24,6 +24,16 @@ OPTIONS
Get all the objects. Get all the objects.
-v:: -v::
Report what is downloaded. 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>:: -w <filename>::
Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on 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>] <commit-id>['\t'<filename-as-in--w>]
--recover::
Verify that everything reachable from target is fetched. Used after
an earlier fetch is interrupted.
Author Author
------ ------
Written by Junio C Hamano <junkio@cox.net> Written by Junio C Hamano <junkio@cox.net>

View File

@ -10,7 +10,7 @@
#include "builtin.h" #include "builtin.h"
static const char diff_files_usage[] = 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; COMMON_DIFF_OPTIONS_HELP;
int cmd_diff_files(int argc, const char **argv, const char *prefix) int cmd_diff_files(int argc, const char **argv, const char *prefix)