diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/CodingGuidelines | 12 | ||||
-rw-r--r-- | Documentation/RelNotes-1.5.4.4.txt | 22 | ||||
-rw-r--r-- | Documentation/RelNotes-1.5.5.txt | 115 | ||||
-rw-r--r-- | Documentation/config.txt | 36 | ||||
-rw-r--r-- | Documentation/git-cherry-pick.txt | 2 | ||||
-rw-r--r-- | Documentation/git-cvsimport.txt | 6 | ||||
-rw-r--r-- | Documentation/git-describe.txt | 9 | ||||
-rw-r--r-- | Documentation/git-gc.txt | 5 | ||||
-rw-r--r-- | Documentation/git-grep.txt | 2 | ||||
-rw-r--r-- | Documentation/git-index-pack.txt | 3 | ||||
-rw-r--r-- | Documentation/git-merge.txt | 3 | ||||
-rw-r--r-- | Documentation/git-rebase.txt | 1 | ||||
-rw-r--r-- | Documentation/git-rev-list.txt | 3 | ||||
-rw-r--r-- | Documentation/git-verify-pack.txt | 4 | ||||
-rw-r--r-- | Documentation/git-whatchanged.txt | 9 | ||||
-rw-r--r-- | Documentation/pretty-options.txt | 3 | ||||
-rw-r--r-- | Documentation/rev-list-options.txt | 2 | ||||
-rw-r--r-- | Documentation/technical/api-run-command.txt | 13 |
18 files changed, 221 insertions, 29 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 3b042db62..994eb9159 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -53,6 +53,18 @@ For shell scripts specifically (not exhaustive): - We do not write the noiseword "function" in front of shell functions. + - As to use of grep, stick to a subset of BRE (namely, no \{m,n\}, + [::], [==], nor [..]) for portability. + + - We do not use \{m,n\}; + + - We do not use -E; + + - We do not use ? nor + (which are \{0,1\} and \{1,\} + respectively in BRE) but that goes without saying as these + are ERE elements not BRE (note that \? and \+ are not even part + of BRE -- making them accessible from BRE is a GNU extension). + For C programs: - We use tabs to indent, and interpret tabs as taking up to diff --git a/Documentation/RelNotes-1.5.4.4.txt b/Documentation/RelNotes-1.5.4.4.txt index 5bfdb3537..5635977c9 100644 --- a/Documentation/RelNotes-1.5.4.4.txt +++ b/Documentation/RelNotes-1.5.4.4.txt @@ -4,6 +4,10 @@ GIT v1.5.4.4 Release Notes Fixes since v1.5.4.3 -------------------- + * Building and installing with an overtight umask such as 077 made + installed templates unreadable by others, while the rest of the install + are done in a way that is friendly to umask 022. + * "git cvsexportcommit -w $cvsdir" misbehaved when GIT_DIR is set to a relative directory. @@ -17,10 +21,26 @@ Fixes since v1.5.4.3 * "git send-email" in 1.5.4.3 issued a bogus empty In-Reply-To: header. + * "git bisect" showed mysterious "won't bisect on seeked tree" error message. + This was leftover from Cogito days to prevent "bisect" starting from a + cg-seeked state. We still keep the Cogito safety, but running "git bisect + start" when another bisect was in effect will clean up and start over. + + * "git push" with an explicit PATH to receive-pack did not quite work if + receive-pack was not on usual PATH. We earlier fixed the same issue + with "git fetch" and upload-pack, but somehow forgot to do so in the + other direction. + + * git-gui's info dialog was not displayed correctly when the user tries + to commit nothing (i.e. without staging anything). + + * "git revert" did not properly fail when attempting to run with a + dirty index. + Also included are a handful documentation updates. --- exec >/var/tmp/1 echo O=$(git describe maint) -O=v1.5.4.3 +O=v1.5.4.3-32-g0f2d447 git shortlog --no-merges $O..maint diff --git a/Documentation/RelNotes-1.5.5.txt b/Documentation/RelNotes-1.5.5.txt index c8b4f72c2..b57fa1eb1 100644 --- a/Documentation/RelNotes-1.5.5.txt +++ b/Documentation/RelNotes-1.5.5.txt @@ -4,6 +4,10 @@ GIT v1.5.5 Release Notes Updates since v1.5.4 -------------------- +(subsystems) + + * Comes with git-gui 0.9.3 + (performance) * On platforms with suboptimal qsort(3) implementation, there @@ -26,21 +30,97 @@ Updates since v1.5.4 * You can be warned when core.autocrlf conversion is applied in such a way that results in an irreversible conversion. + * A catch-all "color.ui" configuration variable can be used to + enable coloring of all color-capable commands, instead of + individual ones such as "color.status" and "color.branch". + + * The commands refused to take absolute pathnames where they + require pathnames relative to the work tree or the current + subdirectory. They now can take absolute pathnames in such a + case as long as the pathnames do not refer outside of the + work tree. E.g. "git add $(pwd)/foo" now works. + + * Error messages used to be sent to stderr, only to get hidden, + when $PAGER was in use. They now are sent to stdout along + with the command output to be shown in the $PAGER. + * A pattern "foo/" in .gitignore file now matches a directory "foo". Pattern "foo" also matches as before. + * bash completion's prompt helper function can talk about + operation in-progress (e.g. merge, rebase, etc.). + + * Configuration variables "url.<usethis>.insteadof = <otherurl>" can be + used to tell "git-fetch" and "git-push" to use different URL than what + is given from the command line. + + * "git push <somewhere> HEAD" and "git push <somewhere> +HEAD" works as + expected; they push the current branch (and only the current branch). + In addition, HEAD can be written as the value of "remote.<there>.push" + configuration variable. + + * "git add -i" behaves better even before you make an initial commit. + + * "git am" refused to run from a subdirectory without a good reason. + + * After "git apply --whitespace=fix" fixes whitespace errors in a patch, + a line before the fix can appear as a context or preimage line in a + later patch, causing the patch not to apply. The command now knows to + see through whitespace fixes done to context lines to successfully + apply such a patch series. + + * "git branch" (and "git checkout -b") to branch from a local branch can + optionally set "branch.<name>.merge" to mark the new branch to build on + the other local branch, when "branch.autosetupmerge" is set to + "always". By default, this does not happen when branching from a local + branch. + + * "git checkout" to switch to a branch that has "branch.<name>.merge" set + (i.e. marked to build on another branch) reports how much the branch + and the other branch diverged. + + * When "git checkout" has to update a lot of paths, it used to be silent + for 4 seconds before it showed any progress report. It is now a bit + more impatient and starts showing progress report early. + + * "git commit" learned a new hook "prepare-commit-msg" that can + inspect what is going to be committed and prepare the commit + log message template to be edited. + + * "git cvsimport" can now take more than one -M options. + * "git describe" learned to limit the tags to be used for naming with --match option. * "git describe --contains" now barfs when the named commit cannot be described. - * bash completion's prompt helper function can talk about - operation in-progress (e.g. merge, rebase, etc.). + * "git describe --exact-match" describes only commits that are tagged. - * "git commit" learned a new hook "prepare-commit-msg" that can - inspect what is going to be committed and prepare the commit - log message template to be edited. + * "git describe --long" describes a tagged commit as $tag-0-$sha1, + instead of just showing the exact tagname. + + * "git describe" warns when using a tag whose name and path contradict + with each other. + + * "git diff" learned "--relative" option to limit and output paths + relative to the current directory when working in a subdirectory. + + * "git diff" learned "--dirstat" option to show birds-eye-summary of + changes more concisely than "--diffstat". + + * "git format-patch" learned --cover-letter option to generate a cover + letter template. + + * "git gc" learned --quiet option. + + * "git grep" now knows "--name-only" is a synonym for the "-l" option. + + * "git help <alias>" now reports "'git <alias>' is alias to <what>", + instead of saying "No manual entry for git-<alias>". + + * "git log --grep=<what>" learned "--fixed-strings" option to look for + <what> without treating it as a regular expression. * "git gui" learned an auto-spell checking. @@ -50,6 +130,9 @@ Updates since v1.5.4 * "git send-email" learned an easier way to suppress CC recipients. + * When the configuration variable "pack.threads" is set to 0, "git + repack" auto detects the number of CPUs and uses that many threads. + * Various "git cvsimport", "git cvsexportcommit", "git svn" and "git p4" improvements. @@ -61,6 +144,15 @@ Updates since v1.5.4 * It is now easier to write test scripts that records known breakages. + * "git checkout" is rewritten in C. + + * Two conflict hunks that are separated by a very short span of common + lines are now coalesced into one larger hunk, to make the result easier + to read. + + * Run-command API's use of file descriptors is documented clearer and + is more consistent now. + Fixes since v1.5.4 ------------------ @@ -68,11 +160,18 @@ Fixes since v1.5.4 All of the fixes in v1.5.4 maintenance series are included in this release, unless otherwise noted. + * "git-daemon" did not send early errors to syslog. + + * "git-http-push" did not allow deletion of remote ref with the usual + "push <remote> :<branch>" syntax. + + * "git-log --merge" did not well work with --left-right option. + + * "git-rebase --abort" did not go back to the right location if + "git-reset" was run during the "git-rebase" session. --- exec >/var/tmp/1 -O=v1.5.4 -O=v1.5.4.2-122-g7cb97da +O=v1.5.4.3-428-g6b48990 echo O=`git describe refs/heads/master` git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint - diff --git a/Documentation/config.txt b/Documentation/config.txt index 4027726f2..683a53a0b 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -556,6 +556,11 @@ format.suffix:: `.patch`. Use this variable to change that suffix (make sure to include the dot if you want it). +format.pretty:: + The default pretty format for log/show/whatchanged command, + See linkgit:git-log[1], linkgit:git-show[1], + linkgit:git-whatchanged[1]. + gc.aggressiveWindow:: The window size parameter used in the delta compression algorithm used by 'git gc --aggressive'. This defaults @@ -749,8 +754,10 @@ merge.summary:: merge.tool:: Controls which merge resolution program is used by - linkgit:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff", - "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff". + linkgit:git-mergetool[1]. Valid built-in values are: "kdiff3", + "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and + "opendiff". Any other value is treated is custom merge tool + and there must be a corresponing mergetool.<tool>.cmd option. merge.verbosity:: Controls the amount of output shown by the recursive merge @@ -777,6 +784,31 @@ mergetool.<tool>.path:: Override the path for the given tool. This is useful in case your tool is not in the PATH. +mergetool.<tool>.cmd:: + Specify the command to invoke the specified merge tool. The + specified command is evaluated in shell with the following + variables available: 'BASE' is the name of a temporary file + containing the common base of the files to be merged, if available; + 'LOCAL' is the name of a temporary file containing the contents of + the file on the current branch; 'REMOTE' is the name of a temporary + file containing the contents of the file from the branch being + merged; 'MERGED' contains the name of the file to which the merge + tool should write the results of a successful merge. + +mergetool.<tool>.trustExitCode:: + For a custom merge command, specify whether the exit code of + the merge command can be used to determine whether the merge was + successful. If this is not set to true then the merge target file + timestamp is checked and the merge assumed to have been successful + if the file has been updated, otherwise the user is prompted to + indicate the success of the merge. + +mergetool.keepBackup:: + After performing a merge, the original file with conflict markers + can be saved as a file with a `.orig` extension. If this variable + is set to `false` then this file is not preserved. Defaults to + `true` (i.e. keep the backup files). + pack.window:: The size of the window used by linkgit:git-pack-objects[1] when no window size is given on the command line. Defaults to 10. diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 877ab66ef..f0beb412e 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -45,7 +45,7 @@ OPTIONS default is not to do `-x` so this option is a no-op. -m parent-number|--mainline parent-number:: - Usually you cannot revert a merge because you do not know which + Usually you cannot cherry-pick a merge because you do not know which side of the merge should be considered the mainline. This option specifies the parent number (starting from 1) of the mainline and allows cherry-pick to replay the change diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index 6f91b9ea2..58eefd42e 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -102,13 +102,17 @@ If you need to pass multiple options, separate them with a comma. -m:: Attempt to detect merges based on the commit message. This option - will enable default regexes that try to capture the name source + will enable default regexes that try to capture the source branch name from the commit message. -M <regex>:: Attempt to detect merges based on the commit message with a custom regex. It can be used with '-m' to enable the default regexes as well. You must escape forward slashes. ++ +The regex must capture the source branch name in $1. ++ +This option can be used several times to provide several detection regexes. -S <regex>:: Skip paths matching the regex. diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index fbb40a291..d9aa2f298 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -56,6 +56,15 @@ OPTIONS being employed to standard error. The tag name will still be printed to standard out. +--long:: + Always output the long format (the tag, the number of commits + and the abbreviated commit name) even when it matches a tag. + This is useful when you want to see parts of the commit object name + in "describe" output, even when the commit in question happens to be + a tagged version. Instead of just emitting the tag name, it will + describe such a commit as v1.2-0-deadbeef (0th commit since tag v1.2 + that points at object deadbeef....). + --match <pattern>:: Only consider tags matching the given pattern (can be used to avoid leaking private tags made from the repository). diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 4b2dfefa6..2e7be916a 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -8,7 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository SYNOPSIS -------- -'git-gc' [--prune] [--aggressive] [--auto] +'git-gc' [--prune] [--aggressive] [--auto] [--quiet] DESCRIPTION ----------- @@ -63,6 +63,9 @@ are consolidated into a single pack by using the `-A` option of `git-repack`. Setting `gc.autopacklimit` to 0 disables automatic consolidation of packs. +--quiet:: + Suppress all progress reports. + Configuration ------------- diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 71a73354f..a97f0557f 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -78,7 +78,7 @@ OPTIONS -l | --files-with-matches | --name-only | -L | --files-without-match:: Instead of showing every matched line, show only the names of files that contain (or do not contain) matches. - For better compatability with git-diff, --name-only is a + For better compatibility with git-diff, --name-only is a synonym for --files-with-matches. -c | --count:: diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt index 72b5d0011..a7825b614 100644 --- a/Documentation/git-index-pack.txt +++ b/Documentation/git-index-pack.txt @@ -75,6 +75,9 @@ OPTIONS to force the version for the generated pack index, and to force 64-bit index entries on objects located above the given offset. +--strict:: + Die, if the pack contains broken objects or links. + Note ---- diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 0c9ad7f2b..c136b1069 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -68,7 +68,8 @@ HOW MERGE WORKS --------------- A merge is always between the current `HEAD` and one or more -remote branch heads, and the index file must exactly match the +commits (usually, branch head or tag), and the index file must +exactly match the tree of `HEAD` commit (i.e. the contents of the last commit) when it happens. In other words, `git-diff --cached HEAD` must report no changes. diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index c11c6453e..4b1030474 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'git-rebase' [-i | --interactive] [-v | --verbose] [-m | --merge] + [-s <strategy> | --strategy=<strategy>] [-C<n>] [ --whitespace=<option>] [-p | --preserve-merges] [--onto <newbase>] <upstream> [<branch>] 'git-rebase' --continue | --skip | --abort diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index a8d489f9f..d80cdf550 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -20,6 +20,9 @@ SYNOPSIS [ \--full-history ] [ \--not ] [ \--all ] + [ \--branches ] + [ \--tags ] + [ \--remotes ] [ \--stdin ] [ \--quiet ] [ \--topo-order ] diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index db019a2b8..ba2a15729 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -32,11 +32,11 @@ OUTPUT FORMAT ------------- When specifying the -v option the format used is: - SHA1 type size offset-in-packfile + SHA1 type size size-in-pack-file offset-in-packfile for objects that are not deltified in the pack, and - SHA1 type size offset-in-packfile depth base-SHA1 + SHA1 type size size-in-packfile offset-in-packfile depth base-SHA1 for objects that are deltified. diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index 54947b676..a6e7bd4c8 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -38,11 +38,6 @@ OPTIONS Show git internal diff output, but for the whole tree, not just the top level. ---pretty=<format>:: - Controls the output format for the commit logs. - <format> can be one of 'raw', 'medium', 'short', 'full', - and 'oneline'. - -m:: By default, differences for merge commits are not shown. With this flag, show differences to that commit from all @@ -51,6 +46,10 @@ OPTIONS However, it is not very useful in general, although it *is* useful on a file-by-file basis. +include::pretty-options.txt[] + +include::pretty-formats.txt[] + Examples -------- git-whatchanged -p v2.6.12.. include/scsi drivers/scsi:: diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt index 973d8dd73..6d66c74cc 100644 --- a/Documentation/pretty-options.txt +++ b/Documentation/pretty-options.txt @@ -4,6 +4,9 @@ where '<format>' can be one of 'oneline', 'short', 'medium', 'full', 'fuller', 'email', 'raw' and 'format:<string>'. When omitted, the format defaults to 'medium'. ++ +Note: you can specify the default pretty format in the repository +configuration (see linkgit:git-config[1]). --abbrev-commit:: Instead of showing the full 40-byte hexadecimal commit object diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 259072c07..2648a5508 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -130,9 +130,11 @@ limiting may be applied. Show commits older than a specific date. +ifdef::git-rev-list[] --max-age='timestamp', --min-age='timestamp':: Limit the commits output to specified time range. +endif::git-rev-list[] --author='pattern', --committer='pattern':: diff --git a/Documentation/technical/api-run-command.txt b/Documentation/technical/api-run-command.txt index dfbf9ac5d..c364a22c8 100644 --- a/Documentation/technical/api-run-command.txt +++ b/Documentation/technical/api-run-command.txt @@ -49,7 +49,7 @@ Functions `finish_async`:: - Wait for the completeion of an asynchronous function that was + Wait for the completion of an asynchronous function that was started with start_async(). @@ -111,9 +111,10 @@ stderr as follows: .no_stdin, .no_stdout, .no_stderr: The respective channel is redirected to /dev/null. - .stdout_to_stderr: stdout of the child is redirected to the - parent's stderr (i.e. *not* to what .err or - .no_stderr specify). + .stdout_to_stderr: stdout of the child is redirected to its + stderr. This happens after stderr is itself redirected. + So stdout will follow stderr to wherever it is + redirected. To modify the environment of the sub-process, specify an array of string pointers (NULL terminated) in .env: @@ -121,8 +122,8 @@ string pointers (NULL terminated) in .env: . If the string is of the form "VAR=value", i.e. it contains '=' the variable is added to the child process's environment. -. If the string does not contain '=', it names an environement - variable that will be removed from the child process's envionment. +. If the string does not contain '=', it names an environment + variable that will be removed from the child process's environment. To specify a new initial working directory for the sub-process, specify it in the .dir member. |