aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorShawn O. Pearce <spearce@spearce.org>2007-04-28 20:05:20 -0400
committerShawn O. Pearce <spearce@spearce.org>2007-04-28 20:05:20 -0400
commitec771a7084ed9352ac6b14ed6ff437e67aba0f0b (patch)
treebc463afbbf8039dfba2c8f025c09f6b5cfa93fd1 /Documentation
parent475d1b333a03b0c13cbbc4ebf395fe11c989f931 (diff)
parent71e2e5993b6f2afdfda0cc92e0d55e84c9f876b0 (diff)
downloadgit-ec771a7084ed9352ac6b14ed6ff437e67aba0f0b.tar.xz
Merge commit 'jc/maint' into gfi-maint
* commit 'jc/maint': (35 commits) 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 Start preparing for 1.5.1.3 Sanitize @to recipients. git-svn: Ignore usernames in URLs in find_by_url Document --dry-run and envelope-sender for git-send-email. Allow users to optionally specify their envelope sender. Ensure clean addresses are always used with Net::SMTP Validate @recipients before using it for sendmail and Net::SMTP. Perform correct quoting of recipient names. Change the scope of the $cc variable as it is not needed outside of send_message. Debugging cleanup improvements Prefix Dry- to the message status to denote dry-runs. Document --dry-run parameter to send-email. ...
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/.gitignore3
-rw-r--r--Documentation/RelNotes-1.5.1.2.txt27
-rw-r--r--Documentation/RelNotes-1.5.1.3.txt38
-rw-r--r--Documentation/blame-options.txt24
-rw-r--r--Documentation/fetch-options.txt17
-rw-r--r--Documentation/git-checkout.txt2
-rw-r--r--Documentation/git-diff-files.txt4
-rw-r--r--Documentation/git-fmt-merge-msg.txt25
-rw-r--r--Documentation/git-grep.txt19
-rw-r--r--Documentation/git-http-fetch.txt4
-rw-r--r--Documentation/git-http-push.txt13
-rw-r--r--Documentation/git-local-fetch.txt14
-rw-r--r--Documentation/git-reset.txt2
-rw-r--r--Documentation/git-send-email.txt9
14 files changed, 175 insertions, 26 deletions
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index b98d21e98e..a37b2152bd 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -1,7 +1,6 @@
*.xml
*.html
-*.1
-*.7
+*.[1-8]
*.made
howto-index.txt
doc.dep
diff --git a/Documentation/RelNotes-1.5.1.2.txt b/Documentation/RelNotes-1.5.1.2.txt
index f58268f6be..d88456306c 100644
--- a/Documentation/RelNotes-1.5.1.2.txt
+++ b/Documentation/RelNotes-1.5.1.2.txt
@@ -1,4 +1,4 @@
-GIT v1.5.1.2 Release Notes (draft)
+GIT v1.5.1.2 Release Notes
==========================
Fixes since v1.5.1.1
@@ -6,6 +6,11 @@ Fixes since v1.5.1.1
* Bugfixes
+ - "git clone" over http from a repository that has lost the
+ loose refs by running "git pack-refs" were broken (a code to
+ deal with this was added to "git fetch" in v1.5.0, but it
+ was missing from "git clone").
+
- "git diff a/ b/" incorrectly fell in "diff between two
filesystem objects" codepath, when the user most likely
wanted to limit the extent of output to two tracked
@@ -24,14 +29,22 @@ Fixes since v1.5.1.1
- git-blame on a very long working tree path had buffer
overrun problem.
+ - git-apply did not like to be fed two patches in a row that created
+ and then modified the same file.
+
+ - git-svn was confused when a non-project was stored directly under
+ trunk/, branches/ and tags/.
+
+ - git-svn wants the Error.pm module that was at least as new
+ as what we ship as part of git; install ours in our private
+ installation location if the one on the system is older.
+
+ - An earlier update to command line integer parameter parser was
+ botched and made 'update-index --cacheinfo' completely useless.
+
+
* Documentation updates
- Various documentation updates from J. Bruce Fields, Frank
Lichtenheld, Alex Riesen and others. Andrew Ruder started a
war on undocumented options.
-
----
-exec >/var/tmp/1
-O=v1.5.1.1-31-g0220f1e
-echo O=`git describe refs/heads/maint`
-git shortlog --no-merges $O..refs/heads/maint
diff --git a/Documentation/RelNotes-1.5.1.3.txt b/Documentation/RelNotes-1.5.1.3.txt
new file mode 100644
index 0000000000..9a4b069ccc
--- /dev/null
+++ b/Documentation/RelNotes-1.5.1.3.txt
@@ -0,0 +1,38 @@
+GIT v1.5.1.3 Release Notes (draft)
+==========================
+
+Fixes since v1.5.1.2
+--------------------
+
+* Bugfixes
+
+ - git-add tried to optimize by finding common leading
+ directories across its arguments but botched, causing very
+ confused behaviour.
+
+ - unofficial rpm.spec file shipped with git was letting
+ ETC_GITCONFIG set to /usr/etc/gitconfig. Tweak the official
+ Makefile to make it harder for distro people to make the
+ same mistake, by setting the variable to /etc/gitconfig if
+ prefix is set to /usr.
+
+ - git-svn inconsistently stripped away username from the URL
+ only when svnsync_props was in use.
+
+ - git-send-email was not quoting recipient names that have
+ period '.' in them. Also it did not allow overriding
+ envelope sender, which made it impossible to send patches to
+ certain subscriber-only lists.
+
+ - built-in write_tree() routine had a sequence that renamed a
+ file that is still open, which some systems did not like.
+
+ - when memory is very tight, sliding mmap code to read
+ packfiles incorrectly closed the fd that was still being
+ used to read the pack.
+
+---
+exec >/var/tmp/1
+O=v1.5.1.2-23-gbf7af11
+echo O=`git describe refs/heads/maint`
+git shortlog --no-merges $O..refs/heads/maint
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 331f161c77..a46bf6ce70 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).
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 5b4d184a73..bdc7332c7b 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
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 4f2e847dc3..918d8ee720 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -8,7 +8,7 @@ git-checkout - Checkout and switch to a branch
SYNOPSIS
--------
[verse]
-'git-checkout' [-q] [-f] [-b [--track | --no-track] <new_branch> [-l]] [-m] [<branch>]
+'git-checkout' [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>]
'git-checkout' [<tree-ish>] <paths>...
DESCRIPTION
diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index b78c4c64f1..2e1e29ef5a 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/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index a70eb3994a..e560b30c57 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
--------
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 0140c8e358..c5a5dad1ce 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.
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 7dc2df3044..4deabc376c 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>
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index 4b4a46169c..a15cf5b2a3 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.
diff --git a/Documentation/git-local-fetch.txt b/Documentation/git-local-fetch.txt
index 22048d82bd..dd9e2387fc 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>
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 5b55cda512..19c5b9bbda 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -67,6 +67,8 @@ message, or both. Leaves working tree as it was before "reset".
<3> "reset" copies the old head to .git/ORIG_HEAD; redo the
commit by starting with its log message. If you do not need to
edit the message further, you can give -C option instead.
++
+See also the --amend option to gitlink:git-commit[1].
Undo commits permanently::
+
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 682313e95d..795db873fc 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -85,6 +85,15 @@ The --cc option must be repeated for each user you want on the cc list.
Do not add the From: address to the cc: list, if it shows up in a From:
line.
+--dry-run::
+ Do everything except actually send the emails.
+
+--envelope-sender::
+ Specify the envelope sender used to send the emails.
+ This is useful if your default address is not the address that is
+ subscribed to a list. If you use the sendmail binary, you must have
+ suitable privileges for the -f parameter.
+
--to::
Specify the primary recipient of the emails generated.
Generally, this will be the upstream maintainer of the