diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Makefile | 2 | ||||
| -rw-r--r-- | Documentation/RelNotes/2.8.4.txt | 69 | ||||
| -rw-r--r-- | Documentation/RelNotes/2.9.0.txt | 148 | ||||
| -rw-r--r-- | Documentation/config.txt | 5 | ||||
| -rw-r--r-- | Documentation/diff-config.txt | 5 | ||||
| -rw-r--r-- | Documentation/diff-options.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-cherry-pick.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-log.txt | 8 | ||||
| -rw-r--r-- | Documentation/git-send-email.txt | 13 | ||||
| -rw-r--r-- | Documentation/git.txt | 3 |
10 files changed, 193 insertions, 69 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index f6e288b..35c1385 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -146,7 +146,7 @@ else ASCIIDOC_EXTRA += -a git-asciidoc-no-roff endif endif -ifdef MAN_BOLD_LITERAL +ifndef NO_MAN_BOLD_LITERAL XMLTO_EXTRA += -m manpage-bold-literal.xsl endif ifdef DOCBOOK_SUPPRESS_SP diff --git a/Documentation/RelNotes/2.8.4.txt b/Documentation/RelNotes/2.8.4.txt new file mode 100644 index 0000000..f4e2552 --- /dev/null +++ b/Documentation/RelNotes/2.8.4.txt @@ -0,0 +1,69 @@ +Git v2.8.4 Release Notes +======================== + +Fixes since v2.8.3 +------------------ + + * Documentation for "git merge --verify-signatures" has been updated + to clarify that the signature of only the commit at the tip is + verified. Also the phrasing used for signature and key validity is + adjusted to align with that used by OpenPGP. + + * On Windows, .git and optionally any files whose name starts with a + dot are now marked as hidden, with a core.hideDotFiles knob to + customize this behaviour. + + * Portability enhancement for "rebase -i" to help platforms whose + shell does not like "for i in <empty>" (which is not POSIX-kosher). + + * "git fsck" learned to catch NUL byte in a commit object as + potential error and warn. + + * CI test was taught to build documentation pages. + + * Many 'linkgit:<git documentation page>' references were broken, + which are all fixed with this. + + * "git describe --contains" often made a hard-to-justify choice of + tag to give name to a given commit, because it tried to come up + with a name with smallest number of hops from a tag, causing an old + commit whose close descendant that is recently tagged were not + described with respect to an old tag but with a newer tag. It did + not help that its computation of "hop" count was further tweaked to + penalize being on a side branch of a merge. The logic has been + updated to favor using the tag with the oldest tagger date, which + is a lot easier to explain to the end users: "We describe a commit + in terms of the (chronologically) oldest tag that contains the + commit." + + * Running tests with '-x' option to trace the individual command + executions is a useful way to debug test scripts, but some tests + that capture the standard error stream and check what the command + said can be broken with the trace output mixed in. When running + our tests under "bash", however, we can redirect the trace output + to another file descriptor to keep the standard error of programs + being tested intact. + + * "http.cookieFile" configuration variable clearly wants a pathname, + but we forgot to treat it as such by e.g. applying tilde expansion. + + * When de-initialising all submodules, "git submodule deinit" gave a + faulty recommendation to use "git submodule deinit .", which would + result in a strange error message in a pathological corner case. + This has been corrected to suggest "submodule deinit --all" instead. + + * Many commands normalize command line arguments from NFD to NFC + variant of UTF-8 on OSX, but commands in the "diff" family did + not, causing "git diff $path" to complain that no such path is + known to Git. They have been taught to do the normalization. + + * A couple of bugs around core.autocrlf have been fixed. + + * "git difftool" learned to handle unmerged paths correctly in + dir-diff mode. + + * The "are we talking with TTY, doing an interactive session?" + detection has been updated to work better for "Git for Windows". + + +Also contains other minor documentation updates and code clean-ups. diff --git a/Documentation/RelNotes/2.9.0.txt b/Documentation/RelNotes/2.9.0.txt index a60e92e..b61d367 100644 --- a/Documentation/RelNotes/2.9.0.txt +++ b/Documentation/RelNotes/2.9.0.txt @@ -1,12 +1,12 @@ Git 2.9 Release Notes ===================== -Backward compatibility note ---------------------------- +Backward compatibility notes +---------------------------- The end-user facing Porcelain level commands in the "git diff" and -"git log" by default enables the rename detection; you can still use -"diff.renames" configuration variable to disable this. +"git log" family by default enable the rename detection; you can still +use "diff.renames" configuration variable to disable this. Merging two branches that have no common ancestor with "git merge" is by default forbidden now to prevent creating such an unusual merge by @@ -30,8 +30,8 @@ UI, Workflows & Features * Comes with git-multimail 1.3.1 (in contrib/). - * The end-user facing Porcelain level commands like "diff" and "log" - now enables the rename detection by default. + * The end-user facing commands like "git diff" and "git log" + now enable the rename detection by default. * The credential.helper configuration variable is cumulative and there is no good way to override it from the command line. As @@ -39,7 +39,7 @@ UI, Workflows & Features as the signal to clear the values specified in various files. * A new "interactive.diffFilter" configuration can be used to - customize the diff shown in "git add -i" session. + customize the diff shown in "git add -i" sessions. * "git p4" now allows P4 author names to be mapped to Git author names. @@ -64,7 +64,7 @@ UI, Workflows & Features to be used in a rare event that merges histories of two projects that started their lives independently. - * "git pull" has been taught to pass --allow-unrelated-histories + * "git pull" has been taught to pass the "--allow-unrelated-histories" option to underlying "git merge". * "git apply -v" learned to report paths in the patch that were @@ -87,7 +87,7 @@ UI, Workflows & Features * When "git log" shows the log message indented by 4-spaces, the remainder of a line after a HT does not align in the way the author - originally intended. The command now expands tabs by default in + originally intended. The command now expands tabs by default to help such a case, and allows the users to override it with a new option, "--no-expand-tabs". @@ -97,13 +97,12 @@ UI, Workflows & Features * "git rerere" can encounter two or more files with the same conflict signature that have to be resolved in different ways, but there was no way to record these separate resolutions. - (merge d9d501b068 jc/rerere-multi later to maint). * "git p4" learned to record P4 jobs in Git commit that imports from the history in Perforce. * "git describe --contains" often made a hard-to-justify choice of - tag to give name to a given commit, because it tried to come up + tag to name a given commit, because it tried to come up with a name with smallest number of hops from a tag, causing an old commit whose close descendant that is recently tagged were not described with respect to an old tag but with a newer tag. It did @@ -113,16 +112,17 @@ UI, Workflows & Features is a lot easier to explain to the end users: "We describe a commit in terms of the (chronologically) oldest tag that contains the commit." - (merge 7550424 js/name-rev-use-oldest-ref later to maint). - * "git clone" learned "--shallow-submodules" option. + * "git clone" learned the "--shallow-submodules" option. * HTTP transport clients learned to throw extra HTTP headers at the server, specified via http.extraHeader configuration variable. - * Patch output from "git diff" and friends has been tweaked to be - more readable by using a blank line as a strong hint that the - contents before and after it belong to a logically separate unit. + * The "--compaction-heuristic" option to "git diff" family of + commands enables a heuristic to make the patch output more readable + by using a blank line as a strong hint that the contents before and + after it belong to logically separate units. It is still + experimental. * A new configuration variable core.hooksPath allows customizing where the hook directory is. @@ -147,9 +147,20 @@ UI, Workflows & Features (public, well-known) commit the original series was built on in its output. - * "git commit" learned to pay attention to "commit.verbose" - configuration variable and act as if "--verbose" option was - given from the command line. + * "git commit" learned to pay attention to the "commit.verbose" + configuration variable and act as if the "--verbose" option + was given from the command line. + + * Updated documentation gives hints to GMail users with two-factor + auth enabled that they need app-specific-password when using + "git send-email". + + * The manpage output of our documentation did not render well in + terminal; typeset literals in bold by default to make them stand + out more. + + * The mark-up in the top-level README.md file has been updated to + typeset CLI command names differently from the body text. Performance, Internal Implementation, Development Support etc. @@ -171,7 +182,8 @@ Performance, Internal Implementation, Development Support etc. * A major part of "git submodule update" has been ported to C to take advantage of the recently added framework to run download tasks in - parallel. + parallel. Other updates to "git submodule" that move pieces of + logic to C continues. * Rename bunch of tests on "git clone" for better organization. @@ -185,16 +197,15 @@ Performance, Internal Implementation, Development Support etc. do not attempt to look into refs/* when we know we do not have a Git repository. - * Code restructuring around the "refs" area to prepare for pluggable + * Code restructuring around the "refs" API to prepare for pluggable refs backends. - * Sources to many test helper binaries (and the generated helpers) + * Sources to many test helper binaries and the generated helpers have been moved to t/helper/ subdirectory to reduce clutter at the top level of the tree. * Unify internal logic between "git tag -v" and "git verify-tag" commands by making one directly call into the other. - (merge bef234b st/verify-tag later to maint). * "merge-recursive" strategy incorrectly checked if a path that is involved in its internal merge exists in the working tree. @@ -206,9 +217,7 @@ Performance, Internal Implementation, Development Support etc. * As nobody maintains our in-tree git.spec.in and distros use their own spec file, we stopped pretending that we support "make rpm". - * Move from unsigned char[20] to struct object_id continues. - - * Update of "git submodule" to move pieces of logic to C continues. + * Move from "unsigned char[20]" to "struct object_id" continues. * The code for warning_errno/die_errno has been refactored and a new error_errno() reporting helper is introduced. @@ -221,24 +230,40 @@ Performance, Internal Implementation, Development Support etc. our tests under "bash", however, we can redirect the trace output to another file descriptor to keep the standard error of programs being tested intact. - (merge d88785e jk/test-send-sh-x-trace-elsewhere later to maint). * t0040 had too many unnecessary repetitions in its test data. Teach test-parse-options program so that a caller can tell what it expects in its output, so that these repetitions can be cleaned up. - * Add perf test for "rebase -i" + * Add perf test for "rebase -i". * Common mistakes when writing gitlink: in our documentation are found by "make check-docs". * t9xxx series has been updated primarily for readability, while - fixing small bugs in it. A few scripted Porcelains have also been - updated to fix possible bugs around their use of "test -z" and - "test -n". + fixing small bugs in it. A few scripted Porcelain commands have + also been updated to fix possible bugs around their use of + "test -z" and "test -n". * CI test was taught to run git-svn tests. + * "git cat-file --batch-all" has been sped up, by taking advantage + of the fact that it does not have to read a list of objects, in two + ways. + + * test updates to make it more readable and maintainable. + (merge e6273f4 es/t1500-modernize later to maint). + + * "make DEVELOPER=1" worked as expected; setting DEVELOPER=1 in + config.mak didn't. + (merge 51dd3e8 mm/makefile-developer-can-be-in-config-mak later to maint). + + * The way how "submodule--helper list" signals unmatch error to its + callers has been updated. + + * A bash-ism "local" has been removed from "git submodule" scripted + Porcelain. + Also contains various documentation updates and code clean-ups. @@ -326,11 +351,11 @@ notes for details). * Support for CRAM-MD5 authentication method in "git imap-send" did not work well. - * Upcoming OpenSSL 1.1.0 will break compilation b updating a few APIs - we use in imap-send, which has been adjusted for the change. + * Upcoming OpenSSL 1.1.0 will break compilation by updating a few API + elements we use in imap-send, which has been adjusted for the change. * The socks5:// proxy support added back in 2.6.4 days was not aware - that socks5h:// proxies behave differently. + that socks5h:// proxies behave differently from socks5:// proxies. * "git config" had a codepath that tried to pass a NULL to printf("%s"), which nobody seems to have noticed. @@ -351,12 +376,12 @@ notes for details). * When "git merge" notices that the merge can be resolved purely at the tree level (without having to merge blobs) and the resulting tree happens to already exist in the object store, it forgot to - update the index, which lead to an inconsistent state for later - operations. + update the index, which left an inconsistent state that would + break later operations. * "git submodule" reports the paths of submodules the command - recurses into, but this was incorrect when the command was not run - from the root level of the superproject. + recurses into, but these paths were incorrectly reported when + the command was not run from the root level of the superproject. * The "user.useConfigOnly" configuration variable makes it an error if users do not explicitly set user.name and user.email. However, @@ -388,7 +413,6 @@ notes for details). * "git rebase -m" could be asked to rebase an entire branch starting from the root, but failed by assuming that there always is a parent commit to the first commit on the branch. - (merge 79f4344 bw/rebase-merge-entire-branch later to maint). * Fix a broken "p4 lfs" test. @@ -414,24 +438,19 @@ notes for details). the configuration variable. This will stop requiring the users to sign commit objects used internally as an implementation detail of "git stash". - (merge 6694856 jc/commit-tree-ignore-commit-gpgsign later to maint). * "http.cookieFile" configuration variable clearly wants a pathname, but we forgot to treat it as such by e.g. applying tilde expansion. - (merge e5a39ad bn/http-cookiefile-config later to maint). * Consolidate description of tilde-expansion that is done to configuration variables that take pathname to a single place. - (merge dca83ab jc/config-pathname-type later to maint). * Correct faulty recommendation to use "git submodule deinit ." when de-initialising all submodules, which would result in a strange error message in a pathological corner case. - (merge f6a5279 sb/submodule-deinit-all later to maint). * Many 'linkgit:<git documentation page>' references were broken, which are all fixed with this. - (merge 1cca17d jc/linkgit-fix later to maint). * "git rerere" can get confused by conflict markers deliberately left by the inner merge step, because they are indistinguishable from @@ -441,48 +460,53 @@ notes for details). (merge 0f9fd5c jc/ll-merge-internal later to maint). * CI test was taught to build documentation pages. - (merge b98712b ls/travis-build-doc later to maint). * "git fsck" learned to catch NUL byte in a commit object as potential error and warn. - (merge 6d2d780 jc/fsck-nul-in-commit later to maint). * Portability enhancement for "rebase -i" to help platforms whose shell does not like "for i in <empty>" (which is not POSIX-kosher). - (merge 8e98b35 jk/rebase-interative-eval-fix later to maint). * On Windows, .git and optionally any files whose name starts with a dot are now marked as hidden, with a core.hideDotFiles knob to customize this behaviour. - (merge ebf31e7 js/windows-dotgit later to maint). * Documentation for "git merge --verify-signatures" has been updated to clarify that the signature of only the commit at the tip is verified. Also the phrasing used for signature and key validity is adjusted to align with that used by OpenPGP. - (merge 05a5869 kf/gpg-sig-verification-doc later to maint). * A couple of bugs around core.autocrlf have been fixed. - (merge caa47ad tb/core-eol-fix later to maint). * Many commands normalize command line arguments from NFD to NFC variant of UTF-8 on OSX, but commands in the "diff" family did not, causing "git diff $path" to complain that no such path is known to Git. They have been taught to do the normalization. - (merge 90a78b8 ar/diff-args-osx-precompose later to maint). * "git difftool" learned to handle unmerged paths correctly in dir-diff mode. - (merge 366f9ce da/difftool later to maint). + + * The "are we talking with TTY, doing an interactive session?" + detection has been updated to work better for "Git for Windows". + + * We forgot to add "git log --decorate=auto" to documentation when we + added the feature back in v2.1.0 timeframe. + (merge 462cbb4 rj/log-decorate-auto later to maint). + + * "git fast-import --export-marks" would overwrite the existing marks + file even when it makes a dump from its custom die routine. + Prevent it from doing so when we have an import-marks file but + haven't finished reading it. + (merge f4beed6 fc/fast-import-broken-marks-file later to maint). + + * "git rebase -i", after it fails to auto-resolve the conflict, had + an unnecessary call to "git rerere" from its very early days, which + was spotted recently; the call has been removed. + (merge 7063693 js/rebase-i-dedup-call-to-rerere later to maint). * Other minor clean-ups and documentation updates - (merge 832c0e5 lp/typofixes later to maint). - (merge f5ee54a sb/z-is-gnutar-ism later to maint). - (merge 2e3926b va/i18n-misc-updates later to maint). - (merge f212dcc bn/config-doc-tt-varnames later to maint). - (merge f54bea4 nd/remote-plural-ours-plus-theirs later to maint). - (merge 2bb0518 ak/t4151-ls-files-could-be-empty later to maint). - (merge 4df4313 jc/test-seq later to maint). - (merge a75a308 tb/t5601-sed-fix later to maint). - (merge 6c1fbe1 va/i18n-remote-comment-to-align later to maint). - (merge dee2303 va/mailinfo-doc-typofix later to maint). + (merge cd82b7a pa/cherry-pick-doc-typo later to maint). + (merge 2bb73ae rs/patch-id-use-skip-prefix later to maint). + (merge aa20cbc rs/apply-name-terminate later to maint). + (merge fe17fc0 jc/t2300-setup later to maint). + (merge e256eec jk/shell-portability later to maint). diff --git a/Documentation/config.txt b/Documentation/config.txt index 53f00db..2e1b2e4 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -1956,7 +1956,10 @@ log.decorate:: command. If 'short' is specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is specified, the full ref name (including prefix) will be printed. - This is the same as the log commands '--decorate' option. + If 'auto' is specified, then if the output is going to a terminal, + the ref names are shown as if 'short' were given, otherwise no ref + names are shown. This is the same as the '--decorate' option + of the `git log`. log.follow:: If `true`, `git log` will act as if the `--follow` option was used when diff --git a/Documentation/diff-config.txt b/Documentation/diff-config.txt index edba565..d78cfc5 100644 --- a/Documentation/diff-config.txt +++ b/Documentation/diff-config.txt @@ -170,6 +170,11 @@ diff.tool:: include::mergetools-diff.txt[] +diff.compactionHeuristic:: + Set this option to `true` to enable an experimental heuristic that + shifts the hunk boundary in an attempt to make the resulting + patch easier to read. + diff.algorithm:: Choose a diff algorithm. The variants are as follows: + diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 3cb3015..d9ae681 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -63,6 +63,13 @@ ifndef::git-format-patch[] Synonym for `-p --raw`. endif::git-format-patch[] +--compaction-heuristic:: +--no-compaction-heuristic:: + These are to help debugging and tuning an experimental + heuristic (which is off by default) that shifts the hunk + boundary in an attempt to make the resulting patch easier + to read. + --minimal:: Spend extra time to make sure the smallest possible diff is produced. diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 6154e57..c104a59 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -128,7 +128,7 @@ effect to your index in a row. --allow-empty-message:: By default, cherry-picking a commit with an empty message will fail. - This option overrides that behaviour, allowing commits with empty + This option overrides that behavior, allowing commits with empty messages to be cherry picked. --keep-redundant-commits:: diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 03f9580..dec379b 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -29,12 +29,14 @@ OPTIONS (works only for a single file). --no-decorate:: ---decorate[=short|full|no]:: +--decorate[=short|full|auto|no]:: Print out the ref names of any commits that are shown. If 'short' is specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is specified, the - full ref name (including prefix) will be printed. The default option - is 'short'. + full ref name (including prefix) will be printed. If 'auto' is + specified, then if the output is going to a terminal, the ref names + are shown as if 'short' were given, otherwise no ref names are + shown. The default option is 'short'. --source:: Print out the ref name given on the command line by which each diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 771a7b5..a88d186 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -450,6 +450,19 @@ edit ~/.gitconfig to specify your account settings: smtpUser = yourname@gmail.com smtpServerPort = 587 +If you have multifactor authentication setup on your gmail account, you will +need to generate an app-specific password for use with 'git send-email'. Visit +https://security.google.com/settings/security/apppasswords to setup an +app-specific password. Once setup, you can store it with the credentials +helper: + + $ git credential fill + protocol=smtp + host=smtp.gmail.com + username=youname@gmail.com + password=app-password + + Once your commits are ready to be sent to the mailing list, run the following commands: diff --git a/Documentation/git.txt b/Documentation/git.txt index dd6dbf7..5a10e9b 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -43,9 +43,10 @@ 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.8.3/git.html[documentation for release 2.8.3] +* link:v2.8.4/git.html[documentation for release 2.8.4] * release notes for + link:RelNotes/2.8.4.txt[2.8.4], link:RelNotes/2.8.3.txt[2.8.3], link:RelNotes/2.8.2.txt[2.8.2], link:RelNotes/2.8.1.txt[2.8.1], |