diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/RelNotes/2.2.0.txt | 138 | ||||
| -rw-r--r-- | Documentation/SubmittingPatches | 2 | ||||
| -rw-r--r-- | Documentation/config.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-commit.txt | 5 | ||||
| -rw-r--r-- | Documentation/git-fast-export.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-fast-import.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-remote-ext.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-remote-fd.txt | 4 | ||||
| -rw-r--r-- | Documentation/git.txt | 5 | ||||
| -rw-r--r-- | Documentation/gitremote-helpers.txt | 6 | ||||
| -rw-r--r-- | Documentation/gittutorial-2.txt | 23 | ||||
| -rw-r--r-- | Documentation/gittutorial.txt | 19 |
12 files changed, 132 insertions, 86 deletions
diff --git a/Documentation/RelNotes/2.2.0.txt b/Documentation/RelNotes/2.2.0.txt index a5c3381b69..e98ecbcff6 100644 --- a/Documentation/RelNotes/2.2.0.txt +++ b/Documentation/RelNotes/2.2.0.txt @@ -9,71 +9,72 @@ Ports * Building on older MacOS X systems automatically sets the necessary NO_APPLE_COMMON_CRYPTO build-time option. - * The support to build with NO_PTHREADS has been resurrected. + * Building with NO_PTHREADS has been resurrected. - * Compilation options has been updated a bit to support z/OS port - better. + * Compilation options have been updated a bit to better support the + z/OS port. UI, Workflows & Features - * "git archive" learned to filter what gets archived with pathspec. + * "git archive" learned to filter what gets archived with a pathspec. * "git config --edit --global" starts from a skeletal per-user configuration file contents, instead of a total blank, when the - user does not already have any. This immediately reduces the - need for a later "Have you forgotten setting core.user?" and we - can add more to the template as we gain more experience. + user does not already have any global config. This immediately + reduces the need to later ask "Have you forgotten to set + core.user?", and we can add more to the template as we gain + more experience. * "git stash list -p" used to be almost always a no-op because each stash entry is represented as a merge commit. It learned to show the difference between the base commit version and the working tree - version, which is in line with what "git show" gives. + version, which is in line with what "git stash show" gives. * Sometimes users want to report a bug they experience on their repository, but they are not at liberty to share the contents of the repository. "fast-export" was taught an "--anonymize" option - to replace blob contents, names of people and paths and log + to replace blob contents, names of people, paths and log messages with bland and simple strings to help them. * "git difftool" learned an option to stop feeding paths to the diff backend when it exits with a non-zero status. - * "git grep" allows to paint (or not paint) partial matches on + * "git grep" learned to paint (or not paint) partial matches on context lines when showing "grep -C<num>" output in color. - * "log --date=iso" uses a slight variant of ISO 8601 format that is - made more human readable. A new "--date=iso-strict" option gives - datetime output that is more strictly conformant. + * "log --date=iso" uses a slight variant of the ISO 8601 format that is + more human readable. A new "--date=iso-strict" option gives + datetime output that conforms more strictly. * The logic "git prune" uses is more resilient against various corner cases. * A broken reimplementation of Git could write an invalid index that - records both stage #0 and higher stage entries for the same path. + records both stage #0 and higher-stage entries for the same path. We now notice and reject such an index, as there is no sensible fallback (we do not know if the broken tool wanted to resolve and - forgot to remove higher stage entries, or if it wanted to unresolve - and forgot to remove the stage#0 entry). + forgot to remove the higher-stage entries, or if it wanted to unresolve + and forgot to remove the stage #0 entry). - * The temporary files "git mergetool" uses are named to avoid too + * The temporary files "git mergetool" uses are renamed to avoid too many dots in them (e.g. a temporary file for "hello.c" used to be named e.g. "hello.BASE.4321.c" but now uses underscore instead, - e.g. "hello_BASE_4321.c"). + e.g. "hello_BASE_4321.c", to allow us to have multiple variants). - * The temporary files "git mergetools" uses can be placed in a newly + * The temporary files "git mergetool" uses can be placed in a newly created temporary directory, instead of the current directory, by setting the mergetool.writeToTemp configuration variable. * "git mergetool" understands "--tool bc" now, as version 4 of BeyondCompare can be driven the same way as its version 3 and it - feels awkward to say "--tool bc3". + feels awkward to say "--tool bc3" to run version 4. * The "pre-receive" and "post-receive" hooks are no longer required to consume their input fully (not following this requirement used to result in intermittent errors in "git push"). - * The pretty-format specifier "%d", which expanded to " (tagname)" + * The pretty-format specifier "%d", which expands to " (tagname)" for a tagged commit, gained a cousin "%D" that just gives the "tagname" without frills. @@ -86,17 +87,17 @@ UI, Workflows & Features without having to "trust" the server. * "git interpret-trailers" is a new filter to programmatically edit - the tail end of the commit log messages. + the tail end of the commit log messages, e.g. "Signed-off-by:". * "git help everyday" shows the "Everyday Git in 20 commands or so" - document, whose contents have been updated to more modern Git - practice. + document, whose contents have been updated to match more modern + Git practice. - * On the "git svn" front, work to reduce memory consumption and - to improve handling of mergeinfo progresses. + * On the "git svn" front, work progresses to reduce memory consumption and + to improve handling of mergeinfo. -Performance, Internal Implementation, etc. +Performance, Internal Implementation, Development Support etc. * The API to manipulate the "refs" has been restructured to make it more transactional, with the eventual goal to allow all-or-none @@ -106,34 +107,34 @@ Performance, Internal Implementation, etc. * The lockfile API and its users have been cleaned up. * We no longer attempt to keep track of individual dependencies to - the header files in the build procedure, relying on automated + the header files in the build procedure, relying instead on automated dependency generation support from modern compilers. * In tests, we have been using NOT_{MINGW,CYGWIN} test prerequisites long before negated prerequisites e.g. !MINGW were invented. The former has been converted to the latter to avoid confusion. - * Looking up remotes configuration in a repository with very many - remotes defined has been optimized. + * Optimized looking up a remote's configuration in a repository with very many + remotes defined. * There are cases where you lock and open to write a file, close it - to show the updated contents to external processes, and then have - to update the file again while still holding the lock, but the - lockfile API lacked support for such an access pattern. + to show the updated contents to an external processes, and then have + to update the file again while still holding the lock; now the + lockfile API has support for such an access pattern. * The API to allocate the structure to keep track of commit decoration has been updated to make it less cumbersome to use. * An in-core caching layer to let us avoid reading the same - configuration files number of times has been added. A few commands + configuration files several times has been added. A few commands have been converted to use this subsystem. * Various code paths have been cleaned up and simplified by using - "strbuf", "starts_with()", and "skip_prefix()" APIs more. + the "strbuf", "starts_with()", and "skip_prefix()" APIs more. * A few codepaths that died when large blobs that would not fit in core are involved in their operation have been taught to punt - instead, by e.g. marking too large a blob as not to be diffed. + instead, by e.g. marking a too-large blob as not to be diffed. * A few more code paths in "commit" and "checkout" have been taught to repopulate the cache-tree in the index, to help speed up later @@ -141,7 +142,7 @@ Performance, Internal Implementation, etc. "status"). * A common programming mistake to assign the same short option name - to two separate options is detected by parse_options() API to help + to two separate options is detected by the parse_options() API to help developers. * The code path to write out the packed-refs file has been optimized, @@ -153,7 +154,7 @@ Performance, Internal Implementation, etc. especially matters in a repository with a large number of existing refs. - * "git fsck" was taught to check contents of tag objects a bit more. + * "git fsck" was taught to check the contents of tag objects a bit more. * "git hash-object" was taught a "--literally" option to help debugging. @@ -162,16 +163,17 @@ Performance, Internal Implementation, etc. original before feeding the filter. Instead, stream the file contents directly to the filter and process its output. - * The scripts in the test suite can be run with "-x" option to show - a shell-trace of each command run in them. + * The scripts in the test suite can be run with the "-x" option to show + a shell-trace of each command they run. * The "run-command" API learned to manage the argv and environment - array for child process, alleviating the need for the callers to + arrays for child process, alleviating the need for the callers to allocate and deallocate them. * Some people use AsciiDoctor, instead of AsciiDoc, to format our - documentation set; the documentation has been adjusted, as - AsciiDoctor is pickier than AsciiDoc in its input mark-up. + documentation set; the documentation has been adjusted to be usable + by both, as AsciiDoctor is pickier than AsciiDoc about its input + mark-up. Also contains various documentation updates and code clean-ups. @@ -189,21 +191,21 @@ notes for details). format", which was counterintuitive. * "git -c section.var command" and "git -c section.var= command" - should pass the configuration differently (the former should be a + should pass the configuration value differently (the former should be a boolean true, the latter should be an empty string). * Applying a patch not generated by Git in a subdirectory used to - check the whitespace breakage using the attributes for incorrect + check for whitespace breakage using the attributes of incorrect paths. Also whitespace checks were performed even for paths - excluded via "git apply --exclude=<path>" mechanism. + excluded via the "git apply --exclude=<path>" mechanism. - * "git bundle create" with date-range specification were meant to + * "git bundle create" with a date-range specification was meant to exclude tags outside the range, but it didn't. - * "git add x" where x that used to be a directory has become a + * "git add x" where x used to be a directory and is now a symbolic link to a directory misbehaved. - * The prompt script checked $GIT_DIR/ref/stash file to see if there + * The prompt script checked the $GIT_DIR/ref/stash file to see if there is a stash, which was a no-no. * Pack-protocol documentation had a minor typo. @@ -217,7 +219,7 @@ notes for details). (merge 107efbe rs/daemon-fixes later to maint). * With sufficiently long refnames, "git fast-import" could have - overflown an on-stack buffer. + overflowed an on-stack buffer. * After "pack-refs --prune" packed refs at the top-level, it failed to prune them. @@ -232,8 +234,8 @@ notes for details). to first check out <branch>. (merge 95c6826 so/rebase-doc later to maint). - * "git push" over HTTP transport had an artificial limit on number of - refs that can be pushed imposed by the command line length. + * "git push" over HTTP transport had an artificial limit on the number of + refs that can be pushed, imposed by the command line length. (merge 26be19b jk/send-pack-many-refspecs later to maint). * When receiving an invalid pack stream that records the same object @@ -248,19 +250,19 @@ notes for details). detached HEAD as a starting point to traverse objects still in use. (merge c40fdd0 mk/reachable-protect-detached-head later to maint). - * "git config --add section.var val" used to lose existing - section.var whose value was an empty string. + * "git config --add section.var val" when section.var already has an + empty-string value used to lose the empty-string value. (merge c1063be ta/config-add-to-empty-or-true-fix later to maint). * "git fsck" failed to report that it found corrupt objects via its exit status in some cases. (merge 30d1038 jk/fsck-exit-code-fix later to maint). - * Use of "--verbose" option used to break "git branch --merged". + * Use of the "--verbose" option used to break "git branch --merged". (merge 12994dd jk/maint-branch-verbose-merged later to maint). - * Some MUAs mangled a line in a message that begins with "From " to - ">From " when writing to a mailbox file and feeding such an input + * Some MUAs mangle a line in a message that begins with "From " to + ">From " when writing to a mailbox file, and feeding such an input to "git am" used to lose such a line. (merge 85de86a jk/mbox-from-line later to maint). @@ -273,8 +275,8 @@ notes for details). coding guidelines. (merge 1c4b660 da/include-compat-util-first-in-c later to maint). - * t7004 test, which tried to run Git with small stack space, has been - updated to give a bit larger stack to avoid false breakage on some + * The t7004 test, which tried to run Git with small stack space, has been + updated to use a bit larger stack to avoid false breakage on some platforms. (merge b9a1907 sk/tag-contains-wo-recursion later to maint). @@ -287,11 +289,25 @@ notes for details). CGI.pm as of 4.04; use CGI::start_from instead. (merge 4750f4b rm/gitweb-start-form later to maint). - * Newer versions of 'meld' breaks the auto-detection we use to see if + * Newer versions of 'meld' break the auto-detection we use to see if they are new enough to support the `--output` option. (merge b12d045 da/mergetool-meld later to maint). - * "git pack-objects" forgot to disable the codepath to generate + * "git pack-objects" forgot to disable the codepath to generate the object reachability bitmap when it needs to split the resulting pack. (merge 2113471 jk/pack-objects-no-bitmap-when-splitting later to maint). + + * The code to use cache-tree trusted the on-disk data too much and + fell into an infinite loop upon seeing an incorrectly recorded + index file. + (merge 729dbbd jk/cache-tree-protect-from-broken-libgit2 later to maint). + + * "git fetch" into a repository where branch B was deleted earlier, + back when it had reflog enabled, and then branch B/C is fetched + into it without reflog enabled, which is arguably an unlikely + corner case, unnecessarily failed. + (merge aae828b jk/fetch-reflog-df-conflict later to maint). + + * "git log --first-parent -L..." used to crash. + (merge a8787c5 tm/line-log-first-parent later to maint). diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index e6d46edbe7..fa71b5f0b6 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -337,7 +337,7 @@ suggests to the contributors: spend their time to improve your patch. Go back to step (2). (4) The list forms consensus that the last round of your patch is - good. Send it to the list and cc the maintainer. + good. Send it to the maintainer and cc the list. (5) A topic branch is created with the patch and is merged to 'next', and cooked further and eventually graduates to 'master'. diff --git a/Documentation/config.txt b/Documentation/config.txt index e8dd76d979..922072596f 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -683,7 +683,7 @@ alias.*:: confusion and troubles with script usage, aliases that hide existing Git commands are ignored. Arguments are split by spaces, the usual shell quoting and escaping is supported. - quote pair and a backslash can be used to quote them. + A quote pair or a backslash can be used to quote them. + If the alias expansion is prefixed with an exclamation point, it will be treated as a shell command. For example, defining @@ -2339,7 +2339,7 @@ status.showUntrackedFiles:: files which are not currently tracked by Git. Directories which contain only untracked files, are shown with the directory name only. Showing untracked files means that Git needs to lstat() all - all the files in the whole repository, which might be slow on some + the files in the whole repository, which might be slow on some systems. So, this variable controls how the commands displays the untracked files. Possible values are: + diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 0bbc8f55f9..1e74b75d38 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -250,9 +250,10 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].) -o:: --only:: - Make a commit only from the paths specified on the + Make a commit by taking the updated working tree contents + of the paths specified on the command line, disregarding any contents that have been - staged so far. This is the default mode of operation of + staged for other paths. This is the default mode of operation of 'git commit' if any paths are given on the command line, in which case this option can be omitted. If this option is specified together with '--amend', then diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt index dbe9a46833..929e496af8 100644 --- a/Documentation/git-fast-export.txt +++ b/Documentation/git-fast-export.txt @@ -209,6 +209,10 @@ Since 'git fast-import' cannot tag trees, you will not be able to export the linux.git repository completely, as it contains a tag referencing a tree instead of a commit. +SEE ALSO +-------- +linkgit:git-fast-import[1] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 377eeaa36d..f71fb0134b 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -1441,6 +1441,10 @@ operator can use this facility to peek at the objects and refs from an import in progress, at the cost of some added running time and worse compression. +SEE ALSO +-------- +linkgit:git-fast-export[1] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt index cd0bb77e4a..b25d0b5996 100644 --- a/Documentation/git-remote-ext.txt +++ b/Documentation/git-remote-ext.txt @@ -116,6 +116,10 @@ begins with `ext::`. Examples: determined by the helper using environment variables (see above). +SEE ALSO +-------- +linkgit:gitremote-helpers[1] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt index bcd37668e3..e700bafa47 100644 --- a/Documentation/git-remote-fd.txt +++ b/Documentation/git-remote-fd.txt @@ -50,6 +50,10 @@ EXAMPLES `git push fd::7,8/bar master`:: Same as above. +SEE ALSO +-------- +linkgit:gitremote-helpers[1] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/git.txt b/Documentation/git.txt index 9202010d80..afb48d39bb 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -43,6 +43,11 @@ unreleased) version of Git, that is available from the 'master' branch of the `git.git` repository. Documentation for older releases are available here: +* link:v2.2.0/git.html[documentation for release 2.2] + +* release notes for + link:RelNotes/2.2.0.txt[2.2]. + * link:v2.1.3/git.html[documentation for release 2.1.3] * release notes for diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt index 64f7ad26b4..8edf72cf53 100644 --- a/Documentation/gitremote-helpers.txt +++ b/Documentation/gitremote-helpers.txt @@ -452,8 +452,14 @@ SEE ALSO -------- linkgit:git-remote[1] +linkgit:git-remote-ext[1] + +linkgit:git-remote-fd[1] + linkgit:git-remote-testgit[1] +linkgit:git-fast-import[1] + GIT --- Part of the linkgit:git[1] suite diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt index f6fbf814fb..30d2119565 100644 --- a/Documentation/gittutorial-2.txt +++ b/Documentation/gittutorial-2.txt @@ -368,17 +368,18 @@ situation: ------------------------------------------------ $ git status -# On branch master -# Changes to be committed: -# (use "git reset HEAD <file>..." to unstage) -# -# new file: closing.txt -# -# Changes not staged for commit: -# (use "git add <file>..." to update what will be committed) -# -# modified: file.txt -# +On branch master +Changes to be committed: + (use "git reset HEAD <file>..." to unstage) + + new file: closing.txt + +Changes not staged for commit: + (use "git add <file>..." to update what will be committed) + (use "git checkout -- <file>..." to discard changes in working directory) + + modified: file.txt + ------------------------------------------------ Since the current state of closing.txt is cached in the index file, diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index af9f709ccf..b00c67df46 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -3,7 +3,7 @@ gittutorial(7) NAME ---- -gittutorial - A tutorial introduction to Git (for version 1.5.1 or newer) +gittutorial - A tutorial introduction to Git SYNOPSIS -------- @@ -107,14 +107,15 @@ summary of the situation with 'git status': ------------------------------------------------ $ git status -# On branch master -# Changes to be committed: -# (use "git reset HEAD <file>..." to unstage) -# -# modified: file1 -# modified: file2 -# modified: file3 -# +On branch master +Changes to be committed: +Your branch is up-to-date with 'origin/master'. + (use "git reset HEAD <file>..." to unstage) + + modified: file1 + modified: file2 + modified: file3 + ------------------------------------------------ If you need to make any further adjustments, do so now, and then add any |