diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/RelNotes-1.5.1.txt | 2 | ||||
| -rwxr-xr-x | Documentation/build-docdep.perl | 6 | ||||
| -rw-r--r-- | Documentation/config.txt | 5 | ||||
| -rw-r--r-- | Documentation/git-add.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-branch.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-bundle.txt | 8 | ||||
| -rw-r--r-- | Documentation/git-quiltimport.txt | 8 | ||||
| -rw-r--r-- | Documentation/git-send-email.txt | 12 | ||||
| -rw-r--r-- | Documentation/git-svn.txt | 121 | ||||
| -rw-r--r-- | Documentation/pretty-formats.txt | 44 |
10 files changed, 139 insertions, 75 deletions
diff --git a/Documentation/RelNotes-1.5.1.txt b/Documentation/RelNotes-1.5.1.txt index 5ce385b44..aa371be1d 100644 --- a/Documentation/RelNotes-1.5.1.txt +++ b/Documentation/RelNotes-1.5.1.txt @@ -50,7 +50,7 @@ Updates since v1.5.0 LF at the end of lines. Currently, which paths to consider 'text' (i.e. be subjected to the autocrlf mechanism) is decided purely based on the contents, but the plan is to - allow users to explicitly override this heuristics based on + allow users to explicitly override this heuristic based on paths. - The behaviour of 'git-apply', when run in a subdirectory, diff --git a/Documentation/build-docdep.perl b/Documentation/build-docdep.perl index 489389c32..ba4205e03 100755 --- a/Documentation/build-docdep.perl +++ b/Documentation/build-docdep.perl @@ -41,10 +41,6 @@ while ($changed) { while (my ($text, $included) = each %include) { if (! exists $included{$text} && (my $base = $text) =~ s/\.txt$//) { - my ($suffix) = '1'; - if ($base eq 'git') { - $suffix = '7'; # yuck... - } - print "$base.html $base.$suffix : ", join(" ", keys %$included), "\n"; + print "$base.html $base.xml : ", join(" ", keys %$included), "\n"; } } diff --git a/Documentation/config.txt b/Documentation/config.txt index d2b4a05ca..d20902bc3 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -341,6 +341,11 @@ format.headers:: Additional email headers to include in a patch to be submitted by mail. See gitlink:git-format-patch[1]. +format.suffix:: + The default for format-patch is to output files with the suffix + `.patch`. Use this variable to change that suffix (make sure to + include the dot if you want it). + gc.packrefs:: `git gc` does not run `git pack-refs` in a bare repository by default so that older dumb-transport clients can still fetch diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index b73a99d61..755d7186f 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -52,7 +52,7 @@ OPTIONS -f:: Allow adding otherwise ignored files. -\i, \--interactive:: +-i, \--interactive:: Add modified contents in the working tree interactively to the index. diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index aa1fdd402..3ea3b8063 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -8,7 +8,8 @@ git-branch - List, create, or delete branches SYNOPSIS -------- [verse] -'git-branch' [--color | --no-color] [-r | -a] [-v [--abbrev=<length>]] +'git-branch' [--color | --no-color] [-r | -a] + [-v [--abbrev=<length> | --no-abbrev]] 'git-branch' [-l] [-f] <branchname> [<start-point>] 'git-branch' (-m | -M) [<oldbranch>] <newbranch> 'git-branch' (-d | -D) [-r] <branchname>... @@ -80,6 +81,9 @@ OPTIONS Alter minimum display length for sha1 in output listing, default value is 7. +--no-abbrev:: + Display the full sha1s in output listing rather than abbreviating them. + <branchname>:: The name of the branch to create or delete. The new branch name must pass all checks defined by diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index 4ea9e85d5..92e7a6872 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -19,7 +19,7 @@ DESCRIPTION Some workflows require that one or more branches of development on one machine be replicated on another machine, but the two machines cannot be directly connected so the interactive git protocols (git, ssh, -rsync, http) cannot be used. This command provides suport for +rsync, http) cannot be used. This command provides support for git-fetch and git-pull to operate by packaging objects and references in an archive at the originating machine, then importing those into another repository using gitlink:git-fetch[1] and gitlink:git-pull[1] @@ -58,7 +58,7 @@ unbundle <file>:: gitlink:git-fetch[1]. [git-rev-list-args...]:: - A list of arguments, accepatble to git-rev-parse and + A list of arguments, acceptable to git-rev-parse and git-rev-list, that specify the specific objects and references to transport. For example, "master~10..master" causes the current master reference to be packaged along with all objects @@ -70,7 +70,7 @@ unbundle <file>:: [refname...]:: A list of references used to limit the references reported as available. This is principally of use to git-fetch, which - expects to recieve only those references asked for and not + expects to receive only those references asked for and not necessarily everything in the pack (in this case, git-bundle is acting like gitlink:git-fetch-pack[1]). @@ -87,7 +87,7 @@ specified explicitly (e.g., ^master~10), or implicitly (e.g., master~10..master, master --since=10.days.ago). It is very important that the basis used be held by the destination. -It is ok to err on the side of conservatism, causing the bundle file +It is okay to err on the side of conservatism, causing the bundle file to contain objects already in the destination as these are ignored when unpacking at the destination. diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt index 6e9a8c369..296937a41 100644 --- a/Documentation/git-quiltimport.txt +++ b/Documentation/git-quiltimport.txt @@ -42,10 +42,10 @@ OPTIONS --patches <dir>:: The directory to find the quilt patches and the quilt series file. - - The default for the patch directory is patches - or the value of the $QUILT_PATCHES environment - variable. ++ +The default for the patch directory is patches +or the value of the $QUILT_PATCHES environment +variable. Author ------ diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 4c8d907bd..35b0104e4 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -26,13 +26,13 @@ The options available are: --bcc:: Specify a "Bcc:" value for each email. - - The --bcc option must be repeated for each user you want on the bcc list. ++ +The --bcc option must be repeated for each user you want on the bcc list. --cc:: Specify a starting "Cc:" value for each email. - - The --cc option must be repeated for each user you want on the cc list. ++ +The --cc option must be repeated for each user you want on the cc list. --chain-reply-to, --no-chain-reply-to:: If this is set, each email will be sent as a reply to the previous @@ -87,8 +87,8 @@ The options available are: Specify the primary recipient of the emails generated. Generally, this will be the upstream maintainer of the project involved. - - The --to option must be repeated for each user you want on the to list. ++ +The --to option must be repeated for each user you want on the to list. Author diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index cf094ca35..9b5a3d619 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -63,7 +63,7 @@ COMMANDS transports (eg svn+ssh://), you must include the username in the URL, eg svn+ssh://foo@svn.bar.com/project ---prefix=<prefix> +--prefix=<prefix>:: This allows one to specify a prefix which is prepended to the names of remotes if trunk/branches/tags are specified. The prefix does not automatically include a @@ -94,16 +94,16 @@ COMMANDS This fetches revisions from the SVN parent of the current HEAD and rebases the current (uncommitted to SVN) work against it. - This works similarly to 'svn update' or 'git-pull' except that - it preserves linear history with 'git-rebase' instead of - 'git-merge' for ease of dcommit-ing with git-svn. +This works similarly to 'svn update' or 'git-pull' except that +it preserves linear history with 'git-rebase' instead of +'git-merge' for ease of dcommit-ing with git-svn. - This accepts all options that 'git-svn fetch' and 'git-rebase' - accepts. However '--fetch-all' only fetches from the current - [svn-remote], and not all [svn-remote] definitions. +This accepts all options that 'git-svn fetch' and 'git-rebase' +accepts. However '--fetch-all' only fetches from the current +[svn-remote], and not all [svn-remote] definitions. - Like 'git-rebase'; this requires that the working tree be clean - and have no uncommitted changes. +Like 'git-rebase'; this requires that the working tree be clean +and have no uncommitted changes. 'dcommit':: Commit each diff from a specified head directly to the SVN @@ -117,29 +117,40 @@ COMMANDS alternative to HEAD. This is advantageous over 'set-tree' (below) because it produces cleaner, more linear history. +-- 'log':: This should make it easy to look up svn log messages when svn users refer to -r/--revision numbers. ++ +The following features from `svn log' are supported: ++ +-- +--revision=<n>[:<n>];; + is supported, non-numeric args are not: + HEAD, NEXT, BASE, PREV, etc ... +-v/--verbose;; + it's not completely compatible with the --verbose + output in svn log, but reasonably close. +--limit=<n>;; + is NOT the same as --max-count, doesn't count + merged/excluded commits +--incremental;; + supported +-- ++ +New features: ++ +-- +--show-commit;; + shows the git commit sha1, as well +--oneline;; + our version of --pretty=oneline +-- ++ +Any other arguments are passed directly to `git log' - The following features from `svn log' are supported: - - --revision=<n>[:<n>] - is supported, non-numeric args are not: - HEAD, NEXT, BASE, PREV, etc ... - -v/--verbose - it's not completely compatible with - the --verbose output in svn log, but - reasonably close. - --limit=<n> - is NOT the same as --max-count, - doesn't count merged/excluded commits - --incremental - supported - - New features: - - --show-commit - shows the git commit sha1, as well - --oneline - our version of --pretty=oneline - - Any other arguments are passed directly to `git log' - +-- 'set-tree':: You should consider using 'dcommit' instead of this command. Commit specified commit or tree objects to SVN. This relies on @@ -256,16 +267,18 @@ config key: svn.authorsfile Make git-svn less verbose. --repack[=<n>]:: ---repack-flags=<flags> - These should help keep disk usage sane for large fetches - with many revisions. +--repack-flags=<flags>:: + +These should help keep disk usage sane for large fetches +with many revisions. - --repack takes an optional argument for the number of revisions - to fetch before repacking. This defaults to repacking every - 1000 commits fetched if no argument is specified. +--repack takes an optional argument for the number of revisions +to fetch before repacking. This defaults to repacking every +1000 commits fetched if no argument is specified. - --repack-flags are passed directly to gitlink:git-repack[1]. +--repack-flags are passed directly to gitlink:git-repack[1]. +[verse] config key: svn.repack config key: svn.repackflags @@ -323,28 +336,30 @@ CONFIG FILE-ONLY OPTIONS svn.noMetadata:: svn-remote.<name>.noMetadata:: - This gets rid of the git-svn-id: lines at the end of every commit. - If you lose your .git/svn/git-svn/.rev_db file, git-svn will not - be able to rebuild it and you won't be able to fetch again, - either. This is fine for one-shot imports. +This gets rid of the git-svn-id: lines at the end of every commit. + +If you lose your .git/svn/git-svn/.rev_db file, git-svn will not +be able to rebuild it and you won't be able to fetch again, +either. This is fine for one-shot imports. - The 'git-svn log' command will not work on repositories using - this, either. Using this conflicts with the 'useSvmProps' - option for (hopefully) obvious reasons. +The 'git-svn log' command will not work on repositories using +this, either. Using this conflicts with the 'useSvmProps' +option for (hopefully) obvious reasons. svn.useSvmProps:: svn-remote.<name>.useSvmProps:: - This allows git-svn to re-map repository URLs and UUIDs from - mirrors created using SVN::Mirror (or svk) for metadata. - If an SVN revision has a property, "svm:headrev", it is likely - that the revision was created by SVN::Mirror (also used by SVK). - The property contains a repository UUID and a revision. We want - to make it look like we are mirroring the original URL, so - introduce a helper function that returns the original identity - URL and UUID, and use it when generating metadata in commit - messages. +This allows git-svn to re-map repository URLs and UUIDs from +mirrors created using SVN::Mirror (or svk) for metadata. + +If an SVN revision has a property, "svm:headrev", it is likely +that the revision was created by SVN::Mirror (also used by SVK). +The property contains a repository UUID and a revision. We want +to make it look like we are mirroring the original URL, so +introduce a helper function that returns the original identity +URL and UUID, and use it when generating metadata in commit +messages. svn.useSvnsyncProps:: svn-remote.<name>.useSvnsyncprops:: @@ -369,8 +384,8 @@ section because they affect the 'git-svn-id:' metadata line. -- -Basic Examples -~~~~~~~~~~~~~~ +BASIC EXAMPLES +-------------- Tracking and contributing to a the trunk of a Subversion-managed project: @@ -405,7 +420,7 @@ Tracking and contributing to an entire Subversion-managed project # with the appropriate name): git reset --hard remotes/trunk # You may only dcommit to one branch/tag/trunk at a time. The usage -# of dcommit/rebase/show-ignore should be teh same as above. +# of dcommit/rebase/show-ignore should be the same as above. ------------------------------------------------------------------------ REBASE VS. PULL/MERGE diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt index fb0b0b958..2fe6c3196 100644 --- a/Documentation/pretty-formats.txt +++ b/Documentation/pretty-formats.txt @@ -77,9 +77,53 @@ displayed in full, regardless of whether --abbrev or true parent commits, without taking grafts nor history simplification into account. + * 'format:' ++ +The 'format:' format allows you to specify which information +you want to show. It works a little bit like printf format, +with the notable exception that you get a newline with '%n' +instead of '\n'. + +E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<"' +would show something like this: + +The author of fe6e0ee was Junio C Hamano, 23 hours ago +The title was >>t4119: test autocomputing -p<n> for traditional diff input.<< + +The placeholders are: + +- '%H': commit hash +- '%h': abbreviated commit hash +- '%T': tree hash +- '%t': abbreviated tree hash +- '%P': parent hashes +- '%p': abbreviated parent hashes +- '%an': author name +- '%ae': author email +- '%ad': author date +- '%aD': author date, RFC2822 style +- '%ar': author date, relative +- '%at': author date, UNIX timestamp +- '%cn': committer name +- '%ce': committer email +- '%cd': committer date +- '%cD': committer date, RFC2822 style +- '%cr': committer date, relative +- '%ct': committer date, UNIX timestamp +- '%e': encoding +- '%s': subject +- '%b': body +- '%Cred': switch color to red +- '%Cgreen': switch color to green +- '%Cblue': switch color to blue +- '%Creset': reset color +- '%n': newline + + --encoding[=<encoding>]:: The commit objects record the encoding used for the log message in their encoding header; this option can be used to tell the command to re-code the commit log message in the encoding preferred by the user. For non plumbing commands this defaults to UTF-8. + |