diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/RelNotes/1.9.4.txt | 16 | ||||
| -rw-r--r-- | Documentation/RelNotes/2.0.0.txt | 88 | ||||
| -rw-r--r-- | Documentation/RelNotes/2.1.0.txt | 86 | ||||
| -rw-r--r-- | Documentation/config.txt | 17 | ||||
| -rw-r--r-- | Documentation/git-grep.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-merge.txt | 5 | ||||
| -rw-r--r-- | Documentation/git-mergetool.txt | 8 | ||||
| -rw-r--r-- | Documentation/git-update-ref.txt | 18 | ||||
| -rw-r--r-- | Documentation/git.txt | 8 | ||||
| -rw-r--r-- | Documentation/revisions.txt | 4 | ||||
| -rw-r--r-- | Documentation/technical/api-builtin.txt | 13 | ||||
| -rw-r--r-- | Documentation/technical/api-hashmap.txt | 1 | ||||
| -rw-r--r-- | Documentation/technical/api-strbuf.txt | 9 |
13 files changed, 206 insertions, 70 deletions
diff --git a/Documentation/RelNotes/1.9.4.txt b/Documentation/RelNotes/1.9.4.txt new file mode 100644 index 0000000000..e1d1835436 --- /dev/null +++ b/Documentation/RelNotes/1.9.4.txt @@ -0,0 +1,16 @@ +Git v1.9.4 Release Notes +======================== + +Fixes since v1.9.3 +------------------ + + * Commands that take pathspecs on the command line misbehaved when + the pathspec is given as an absolute pathname (which is a + practice not particularly encouraged) that points at a symbolic + link in the working tree. + + * An earlier fix to the shell prompt script (in contrib/) for using + the PROMPT_COMMAND interface did not correctly check if the extra + code path needs to trigger, causing the branch name not to appear + when 'promptvars' option is disabled in bash or PROMPT_SUBST is + unset in zsh. diff --git a/Documentation/RelNotes/2.0.0.txt b/Documentation/RelNotes/2.0.0.txt index 6e628d4799..2617372a0c 100644 --- a/Documentation/RelNotes/2.0.0.txt +++ b/Documentation/RelNotes/2.0.0.txt @@ -44,7 +44,7 @@ with "git diff-files --diff-filter=d"). The default prefix for "git svn" has changed in Git 2.0. For a long time, "git svn" created its remote-tracking branches directly under refs/remotes, but it now places them under refs/remotes/origin/ unless -it is told otherwise with its --prefix option. +it is told otherwise with its "--prefix" option. Updates since v1.9 series @@ -53,7 +53,11 @@ Updates since v1.9 series UI, Workflows & Features * The "multi-mail" post-receive hook (in contrib/) has been updated - to a more recent version from the upstream. + to a more recent version from upstream. + + * The "remote-hg/bzr" remote-helper interfaces (used to be in + contrib/) are no more. They are now maintained separately as + third-party plug-ins in their own repositories. * "git gc --aggressive" learned "--depth" option and "gc.aggressiveDepth" configuration variable to allow use of a less @@ -63,12 +67,13 @@ UI, Workflows & Features single strand-of-pearls is broken in its output. * The "rev-parse --parseopt" mechanism used by scripted Porcelains to - parse command line options and to give help text learned to take + parse command-line options and to give help text learned to take the argv-help (the placeholder string for an option parameter, e.g. "key-id" in "--gpg-sign=<key-id>"). * The pattern to find where the function begins in C/C++ used in - "diff" and "grep -p" has been updated to help C++ source better. + "diff" and "grep -p" has been updated to improve viewing C++ + sources. * "git rebase" learned to interpret a lone "-" as "@{-1}", the branch that we were previously on. @@ -79,7 +84,7 @@ UI, Workflows & Features "--sort=version:refname". * Discard the accumulated "heuristics" to guess from which branch the - result wants to be pulled from and make sure what the end user + result wants to be pulled from and make sure that what the end user specified is not second-guessed by "git request-pull", to avoid mistakes. When you pushed out your 'master' branch to your public repository as 'for-linus', use the new "master:for-linus" syntax to @@ -88,9 +93,9 @@ UI, Workflows & Features * "git grep" learned to behave in a way similar to native grep when "-h" (no header) and "-c" (count) options are given. - * "git push" via transport-helper interface (e.g. remote-hg) has - been updated to allow forced ref updates in a way similar to the - natively supported transports. + * "git push" via transport-helper interface has been updated to + allow forced ref updates in a way similar to the natively + supported transports. * The "simple" mode is the default for "git push". @@ -114,28 +119,28 @@ UI, Workflows & Features * The progress indicators from various time-consuming commands have been marked for i18n/l10n. - * "git notes -C <blob>" diagnoses an attempt to use an object that - is not a blob as an error. + * "git notes -C <blob>" diagnoses as an error an attempt to use an + object that is not a blob. * "git config" learned to read from the standard input when "-" is given as the value to its "--file" parameter (attempting an - operation to update the configuration in the standard input of - course is rejected). + operation to update the configuration in the standard input is + rejected, of course). * Trailing whitespaces in .gitignore files, unless they are quoted for fnmatch(3), e.g. "path\ ", are warned and ignored. Strictly - speaking, this is a backward incompatible change, but very unlikely + speaking, this is a backward-incompatible change, but very unlikely to bite any sane user and adjusting should be obvious and easy. - * Many commands that create commits, e.g. "pull", "rebase", - learned to take the --gpg-sign option on the command line. + * Many commands that create commits, e.g. "pull" and "rebase", + learned to take the "--gpg-sign" option on the command line. * "git commit" can be told to always GPG sign the resulting commit - by setting "commit.gpgsign" configuration variable to true (the - command line option --no-gpg-sign should override it). + by setting the "commit.gpgsign" configuration variable to "true" + (the command-line option "--no-gpg-sign" should override it). * "git pull" can be told to only accept fast-forward by setting the - new "pull.ff" configuration. + new "pull.ff" configuration variable. * "git reset" learned the "-N" option, which does not reset the index fully for paths the index knows about but the tree-ish the command @@ -152,7 +157,7 @@ Performance, Internal Implementation, etc. * Uses of curl's "multi" interface and "easy" interface do not mix well when we attempt to reuse outgoing connections. Teach the RPC - over http code, used in the smart HTTP transport, not to use the + over HTTP code, used in the smart HTTP transport, not to use the "easy" interface. * The bitmap-index feature from JGit has been ported, which should @@ -186,24 +191,19 @@ notes for details). * The shell prompt script (in contrib/), when using the PROMPT_COMMAND interface, used an unsafe construct when showing the branch name in $PS1. - (merge 8976500 rh/prompt-pcmode-avoid-eval-on-refname later to maint). - - * The remote-helper interface to fast-import/fast-export via the - transport-helper has been tightened to avoid leaving the import - marks file from a failed/crashed run, as such a file that is out of - sync with the reality confuses a later invocation of itself. + (merge 1e4119c8 rh/prompt-pcmode-avoid-eval-on-refname later to maint). - * "git rebase" used a POSIX shell construct FreeBSD /bin/sh does not + * "git rebase" used a POSIX shell construct FreeBSD's /bin/sh does not work well with. (merge 8cd6596 km/avoid-non-function-return-in-rebase later to maint). * zsh prompt (in contrib/) leaked unnecessary error messages. - * bash completion (in contrib/) did not complete the refs and remotes + * Bash completion (in contrib/) did not complete the refs and remotes correctly given "git pu<TAB>" when "pu" is aliased to "push". - * Some more Unicode codepoints defined in Unicode 6.3 as having zero - width have been taught to our display column counting logic. + * Some more Unicode code points, defined in Unicode 6.3 as having zero + width, have been taught to our display column counting logic. (merge d813ab9 tb/unicode-6.3-zero-width later to maint). * Some tests used shell constructs that did not work well on FreeBSD @@ -217,7 +217,7 @@ notes for details). * "git diff --no-index -Mq a b" fell into an infinite loop. (merge ad1c3fb jc/fix-diff-no-index-diff-opt-parse later to maint). - * "git fetch --prune", when the right-hand-side of multiple fetch + * "git fetch --prune", when the right-hand side of multiple fetch refspecs overlap (e.g. storing "refs/heads/*" to "refs/remotes/origin/*", while storing "refs/frotz/*" to "refs/remotes/origin/fr/*"), aggressively thought that lack of @@ -272,7 +272,7 @@ notes for details). (merge 3c3e6f5 rr/doc-merge-strategies later to maint). * Serving objects from a shallow repository needs to write a - new file to hold the temporary shallow boundaries but it was not + new file to hold the temporary shallow boundaries, but it was not cleaned when we exit due to die() or a signal. (merge 7839632 jk/shallow-update-fix later to maint). @@ -295,19 +295,19 @@ notes for details). ".git" tells us where it is. (merge fcfec8b da/difftool-git-files later to maint). - * "git push" did not pay attention to branch.*.pushremote if it is - defined earlier than remote.pushdefault; the order of these two + * "git push" did not pay attention to "branch.*.pushremote" if it is + defined earlier than "remote.pushdefault"; the order of these two variables in the configuration file should not matter, but it did by mistake. (merge 98b406f jk/remote-pushremote-config-reading later to maint). - * Codepaths that parse timestamps in commit objects have been + * Code paths that parse timestamps in commit objects have been tightened. (merge f80d1f9 jk/commit-dates-parsing-fix later to maint). * "git diff --external-diff" incorrectly fed the submodule directory - in the working tree to the external diff driver when it knew it is - the same as one of the versions being compared. + in the working tree to the external diff driver when it knew that it + is the same as one of the versions being compared. (merge aba4727 tr/diff-submodule-no-reuse-worktree later to maint). * "git reset" needs to refresh the index when working in a working @@ -318,7 +318,7 @@ notes for details). * "git check-attr" when working on a repository with a working tree did not work well when the working tree was specified via the - --work-tree (and obviously with --git-dir) option. + "--work-tree" (and obviously with "--git-dir") option. (merge cdbf623 jc/check-attr-honor-working-tree later to maint). * "merge-recursive" was broken in 1.7.7 era and stopped working in @@ -326,12 +326,12 @@ notes for details). involved. This has been corrected. (merge 6e2068a bk/refresh-missing-ok-in-merge-recursive later to maint.) - * "git rev-parse" was loose in rejecting command line arguments + * "git rev-parse" was loose in rejecting command-line arguments that do not make sense, e.g. "--default" without the required value for that option. (merge a43219f ds/rev-parse-required-args later to maint.) - * include.path variable (or any variable that expects a path that + * "include.path" variable (or any variable that expects a path that can use ~username expansion) in the configuration file is not a boolean, but the code failed to check it. (merge 67beb60 jk/config-path-include-fix later to maint.) @@ -340,23 +340,23 @@ notes for details). the pathspec is given as an absolute pathname (which is a practice not particularly encouraged) that points at a symbolic link in the working tree. - (merge later 655ee9e mw/symlinks to maint.) + (merge 6127ff6 mw/symlinks later to maint.) * "git diff --quiet -- pathspec1 pathspec2" sometimes did not return - correct status value. + the correct status value. (merge f34b205 nd/diff-quiet-stat-dirty later to maint.) * Attempting to deepen a shallow repository by fetching over smart - HTTP transport failed in the protocol exchange, when no-done + HTTP transport failed in the protocol exchange, when the no-done extension was used. The fetching side waited for the list of - shallow boundary commits after the sending end stopped talking to + shallow boundary commits after the sending side stopped talking to it. (merge 0232852 nd/http-fetch-shallow-fix later to maint.) * Allow "git cmd path/", when the 'path' is where a submodule is bound to the top-level working tree, to match 'path', despite the extra and unnecessary trailing slash (such a slash is often - given by command line completion). + given by command-line completion). (merge 2e70c01 nd/submodule-pathspec-ending-with-slash later to maint.) * Documentation and in-code comments had many instances of mistaken diff --git a/Documentation/RelNotes/2.1.0.txt b/Documentation/RelNotes/2.1.0.txt new file mode 100644 index 0000000000..ad53d0deb6 --- /dev/null +++ b/Documentation/RelNotes/2.1.0.txt @@ -0,0 +1,86 @@ +Git v2.1 Release Notes +====================== + +Updates since v2.0 +------------------ + +UI, Workflows & Features + + * "git commit --date=<date>" option learned to read from more + timestamp formats, including "--date=now". + + * "git grep" learned grep.fullname configuration variable to force + "--full-name" to be default. This may cause regressions on + scripted users that do not expect this new behaviour. + + * "git merge" without argument, even when there is an upstream + defined for the current branch, refused to run until + merge.defaultToUpstream is set to true. Flip the default of that + configuration variable to true. + + * "git mergetool" learned to drive the vimdiff3 backend. + + * mergetool.prompt used to default to 'true', always asking "do you + really want to run the tool on this path?". Among the two + purposes this prompt serves, ignore the use case to confirm that + the user wants to view particular path with the named tool, and + redefine the meaning of the prompt only to confirm the choice of + the tool made by the autodetection (for those who configured the + tool explicitly, the prompt shown for the latter purpose is + simply annoying). + + Strictly speaking, this is a backward incompatible change and the + users need to explicitly set the variable to 'true' if they want + to resurrect the now-ignored use case. + + * "git svn" learned to cope with malformed timestamps with only one + digit in the hour part, e.g. 2014-01-07T5:01:02.048176Z, emitted + by some broken subversion server implementations. + + +Performance, Internal Implementation, etc. + + * "git diff" that compares 3-or-more trees (e.g. parents and the + result of a merge) have been optimized. + + * The API to update/delete references are being converted to handle + updates to multiple references in a transactional way. As an + example, "update-ref --stdin [-z]" has been updated to use this + API. + + +Also contains various documentation updates and code clean-ups. + + +Fixes since v2.0 +---------------- + +Unless otherwise noted, all the fixes since v2.0 in the maintenance +track are contained in this release (see the maintenance releases' +notes for details). + + * "--ignore-space-change" option of "git apply" ignored the spaces + at the beginning of line too aggressively, which is inconsistent + with the option of the same name "diff" and "git diff" have. + (merge 14d3bb4 jc/apply-ignore-whitespace later to maint). + + * "git blame" miscounted number of columns needed to show localized + timestamps, resulting in jaggy left-side-edge of the source code + lines in its output. + (merge dd75553 jx/blame-align-relative-time later to maint). + + * We used to disable threaded "git index-pack" on platforms without + thread-safe pread(); use a different workaround for such + platforms to allow threaded "git index-pack". + (merge 3953949 nd/index-pack-one-fd-per-thread later to maint). + + * "git rerere forget" did not work well when merge.conflictstyle + was set to a non-default value. + (merge de3d8bb fc/rerere-conflict-style later to maint). + + * "git status", even though it is a read-only operation, tries to + update the index with refreshed lstat(2) info to optimize future + accesses to the working tree opportunistically, but this could + race with a "read-write" operation that modify the index while it + is running. Detect such a race and avoid overwriting the index. + (merge 426ddee ym/fix-opportunistic-index-update-race later to maint). diff --git a/Documentation/config.txt b/Documentation/config.txt index 9f3ce06c87..2e3c6655f0 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -489,7 +489,7 @@ core.deltaBaseCacheLimit:: to avoid unpacking and decompressing frequently used base objects multiple times. + -Default is 16 MiB on all platforms. This should be reasonable +Default is 96 MiB on all platforms. This should be reasonable for all users/operating systems, except on the largest projects. You probably do not need to adjust this value. + @@ -561,14 +561,19 @@ core.pager:: configuration, then `$PAGER`, and then the default chosen at compile time (usually 'less'). + -When the `LESS` environment variable is unset, Git sets it to `FRSX` +When the `LESS` environment variable is unset, Git sets it to `FRX` (if `LESS` environment variable is set, Git does not change it at all). If you want to selectively override Git's default setting -for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will +for `LESS`, you can set `core.pager` to e.g. `less -S`. This will be passed to the shell by Git, which will translate the final -command to `LESS=FRSX less -+S`. The environment tells the command -to set the `S` option to chop long lines but the command line -resets it to the default to fold long lines. +command to `LESS=FRX less -S`. The environment does not set the +`S` option but the command line does, instructing less to truncate +long lines. Similarly, setting `core.pager` to `less -+F` will +deactivate the `F` option specified by the environment from the +command-line, deactivating the "quit if one screen" behavior of +`less`. One can specifically activate some flags for particular +commands: for example, setting `pager.blame` to `less -S` enables +line truncation only for `git blame`. + Likewise, when the `LV` environment variable is unset, Git sets it to `-c`. You can override this setting by exporting `LV` with diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index f83733490f..31811f16bd 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -53,6 +53,9 @@ grep.extendedRegexp:: option is ignored when the 'grep.patternType' option is set to a value other than 'default'. +grep.fullName:: + If set to true, enable '--full-name' option by default. + OPTIONS ------- diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index a3c1fa332a..cf2c374b71 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -101,9 +101,8 @@ commit or stash your changes before running 'git merge'. Specifying more than one commit will create a merge with more than two parents (affectionately called an Octopus merge). + -If no commit is given from the command line, and if `merge.defaultToUpstream` -configuration variable is set, merge the remote-tracking branches -that the current branch is configured to use as its upstream. +If no commit is given from the command line, merge the remote-tracking +branches that the current branch is configured to use as its upstream. See also the configuration section of this manual page. diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index 07137f252b..e846c2ed7f 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -71,11 +71,13 @@ success of the resolution after the custom tool has exited. --no-prompt:: Don't prompt before each invocation of the merge resolution program. + This is the default if the merge resolution program is + explicitly specified with the `--tool` option or with the + `merge.tool` configuration variable. --prompt:: - Prompt before each invocation of the merge resolution program. - This is the default behaviour; the option is provided to - override any configuration settings. + Prompt before each invocation of the merge resolution program + to give the user a chance to skip the path. TEMPORARY FILES --------------- diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 0a0a5512b3..c8f5ae5cb3 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -68,7 +68,12 @@ performs all modifications together. Specify commands of the form: option SP <opt> LF Quote fields containing whitespace as if they were strings in C source -code. Alternatively, use `-z` to specify commands without quoting: +code; i.e., surrounded by double-quotes and with backslash escapes. +Use 40 "0" characters or the empty string to specify a zero value. To +specify a missing value, omit the value and its preceding SP entirely. + +Alternatively, use `-z` to specify in NUL-terminated format, without +quoting: update SP <ref> NUL <newvalue> NUL [<oldvalue>] NUL create SP <ref> NUL <newvalue> NUL @@ -76,8 +81,12 @@ code. Alternatively, use `-z` to specify commands without quoting: verify SP <ref> NUL [<oldvalue>] NUL option SP <opt> NUL -Lines of any other format or a repeated <ref> produce an error. -Command meanings are: +In this format, use 40 "0" to specify a zero value, and use the empty +string to specify a missing value. + +In either format, values can be specified in any form that Git +recognizes as an object name. Commands in any other format or a +repeated <ref> produce an error. Command meanings are: update:: Set <ref> to <newvalue> after verifying <oldvalue>, if given. @@ -102,9 +111,6 @@ option:: The only valid option is `no-deref` to avoid dereferencing a symbolic ref. -Use 40 "0" or the empty string to specify a zero value, except that -with `-z` an empty <oldvalue> is considered missing. - If all <ref>s can be locked with matching <oldvalue>s simultaneously, all modifications are performed. Otherwise, no modifications are performed. Note that while each individual diff --git a/Documentation/git.txt b/Documentation/git.txt index a041cd006a..b075e0bed5 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -43,9 +43,15 @@ unreleased) version of Git, that is available from 'master' branch of the `git.git` repository. Documentation for older releases are available here: -* link:v1.9.3/git.html[documentation for release 1.9.3] +* link:v2.0.0/git.html[documentation for release 2.0] * release notes for + link:RelNotes/2.0.0.txt[2.0.0]. + +* link:v1.9.4/git.html[documentation for release 1.9.4] + +* release notes for + link:RelNotes/1.9.4.txt[1.9.4], link:RelNotes/1.9.3.txt[1.9.3], link:RelNotes/1.9.2.txt[1.9.2], link:RelNotes/1.9.1.txt[1.9.1], diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt index 5a286d0d61..07961185fe 100644 --- a/Documentation/revisions.txt +++ b/Documentation/revisions.txt @@ -94,7 +94,9 @@ some output processing may assume ref names in UTF-8. '<branchname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}':: The suffix '@\{upstream\}' to a branchname (short form '<branchname>@\{u\}') refers to the branch that the branch specified by branchname is set to build on - top of. A missing branchname defaults to the current one. + top of (configured with `branch.<name>.remote` and + `branch.<name>.merge`). A missing branchname defaults to the + current one. '<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0':: A suffix '{caret}' to a revision parameter means the first parent of diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt index e3d6e7a79a..22a39b9299 100644 --- a/Documentation/technical/api-builtin.txt +++ b/Documentation/technical/api-builtin.txt @@ -22,11 +22,14 @@ Git: where options is the bitwise-or of: `RUN_SETUP`:: - - Make sure there is a Git directory to work on, and if there is a - work tree, chdir to the top of it if the command was invoked - in a subdirectory. If there is no work tree, no chdir() is - done. + If there is not a Git directory to work on, abort. If there + is a work tree, chdir to the top of it if the command was + invoked in a subdirectory. If there is no work tree, no + chdir() is done. + +`RUN_SETUP_GENTLY`:: + If there is a Git directory, chdir as per RUN_SETUP, otherwise, + don't chdir anywhere. `USE_PAGER`:: diff --git a/Documentation/technical/api-hashmap.txt b/Documentation/technical/api-hashmap.txt index 42ca2347ed..b977ae8bbb 100644 --- a/Documentation/technical/api-hashmap.txt +++ b/Documentation/technical/api-hashmap.txt @@ -166,7 +166,6 @@ Usage example ------------- Here's a simple usage example that maps long keys to double values. -[source,c] ------------ struct hashmap map; diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index 3350d97dda..4396be9dda 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -121,10 +121,19 @@ Functions * Related to the contents of the buffer +`strbuf_trim`:: + + Strip whitespace from the beginning and end of a string. + Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`. + `strbuf_rtrim`:: Strip whitespace from the end of a string. +`strbuf_ltrim`:: + + Strip whitespace from the beginning of a string. + `strbuf_cmp`:: Compare two buffers. Returns an integer less than, equal to, or greater |