Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- git/mingw64/share/doc/connect/manual.html +1420 -0
- git/mingw64/share/doc/connect/manual.txt +625 -0
- git/mingw64/share/doc/expat/AUTHORS +10 -0
- git/mingw64/share/doc/expat/changelog +1926 -0
- git/mingw64/share/doc/git-doc/BreakingChanges.adoc +335 -0
- git/mingw64/share/doc/git-doc/BreakingChanges.html +940 -0
- git/mingw64/share/doc/git-doc/DecisionMaking.adoc +74 -0
- git/mingw64/share/doc/git-doc/DecisionMaking.html +545 -0
- git/mingw64/share/doc/git-doc/blame-options.adoc +151 -0
- git/mingw64/share/doc/git-doc/cmds-ancillaryinterrogators.adoc +51 -0
- git/mingw64/share/doc/git-doc/cmds-ancillarymanipulators.adoc +36 -0
- git/mingw64/share/doc/git-doc/cmds-developerinterfaces.adoc +33 -0
- git/mingw64/share/doc/git-doc/cmds-foreignscminterface.adoc +30 -0
- git/mingw64/share/doc/git-doc/cmds-guide.adoc +39 -0
- git/mingw64/share/doc/git-doc/cmds-mainporcelain.adoc +141 -0
- git/mingw64/share/doc/git-doc/cmds-plumbinginterrogators.adoc +72 -0
- git/mingw64/share/doc/git-doc/cmds-plumbingmanipulators.adoc +60 -0
- git/mingw64/share/doc/git-doc/cmds-purehelpers.adoc +54 -0
- git/mingw64/share/doc/git-doc/cmds-synchelpers.adoc +18 -0
- git/mingw64/share/doc/git-doc/cmds-synchingrepositories.adoc +15 -0
- git/mingw64/share/doc/git-doc/cmds-userinterfaces.adoc +24 -0
- git/mingw64/share/doc/git-doc/config.adoc +568 -0
- git/mingw64/share/doc/git-doc/date-formats.adoc +31 -0
- git/mingw64/share/doc/git-doc/diff-algorithm-option.adoc +20 -0
- git/mingw64/share/doc/git-doc/diff-context-options.adoc +12 -0
- git/mingw64/share/doc/git-doc/diff-format.adoc +186 -0
- git/mingw64/share/doc/git-doc/diff-generate-patch.adoc +210 -0
- git/mingw64/share/doc/git-doc/diff-options.adoc +917 -0
- git/mingw64/share/doc/git-doc/docbook-xsl.css +296 -0
- git/mingw64/share/doc/git-doc/docinfo.html +5 -0
- git/mingw64/share/doc/git-doc/everyday.html +464 -0
- git/mingw64/share/doc/git-doc/fetch-options.adoc +358 -0
- git/mingw64/share/doc/git-doc/for-each-ref-options.adoc +85 -0
- git/mingw64/share/doc/git-doc/format-patch-caveats.adoc +33 -0
- git/mingw64/share/doc/git-doc/format-patch-end-of-commit-message.adoc +8 -0
- git/mingw64/share/doc/git-doc/fsck-msgids.adoc +253 -0
- git/mingw64/share/doc/git-doc/git-add.adoc +460 -0
- git/mingw64/share/doc/git-doc/git-add.html +1058 -0
- git/mingw64/share/doc/git-doc/git-am.adoc +316 -0
- git/mingw64/share/doc/git-doc/git-am.html +951 -0
- git/mingw64/share/doc/git-doc/git-annotate.adoc +33 -0
- git/mingw64/share/doc/git-doc/git-annotate.html +724 -0
- git/mingw64/share/doc/git-doc/git-apply.adoc +299 -0
- git/mingw64/share/doc/git-doc/git-apply.html +852 -0
- git/mingw64/share/doc/git-doc/git-archive.adoc +248 -0
- git/mingw64/share/doc/git-doc/git-archive.html +777 -0
- git/mingw64/share/doc/git-doc/git-backfill.adoc +75 -0
- git/mingw64/share/doc/git-doc/git-backfill.html +553 -0
- git/mingw64/share/doc/git-doc/git-bash.adoc +107 -0
- git/mingw64/share/doc/git-doc/git-bash.html +586 -0
git/mingw64/share/doc/connect/manual.html
ADDED
|
@@ -0,0 +1,1420 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
| 2 |
+
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
| 3 |
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
| 4 |
+
<head>
|
| 5 |
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
| 6 |
+
<meta name="generator" content="AsciiDoc 8.5.2" />
|
| 7 |
+
<title>SSH Proxy Command — connect.c</title>
|
| 8 |
+
<style type="text/css">
|
| 9 |
+
/* Debug borders */
|
| 10 |
+
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
|
| 11 |
+
/*
|
| 12 |
+
border: 1px solid red;
|
| 13 |
+
*/
|
| 14 |
+
}
|
| 15 |
+
|
| 16 |
+
body {
|
| 17 |
+
margin: 1em 5% 1em 5%;
|
| 18 |
+
}
|
| 19 |
+
|
| 20 |
+
a {
|
| 21 |
+
color: blue;
|
| 22 |
+
text-decoration: underline;
|
| 23 |
+
}
|
| 24 |
+
a:visited {
|
| 25 |
+
color: fuchsia;
|
| 26 |
+
}
|
| 27 |
+
|
| 28 |
+
em {
|
| 29 |
+
font-style: italic;
|
| 30 |
+
color: navy;
|
| 31 |
+
}
|
| 32 |
+
|
| 33 |
+
strong {
|
| 34 |
+
font-weight: bold;
|
| 35 |
+
color: #083194;
|
| 36 |
+
}
|
| 37 |
+
|
| 38 |
+
tt {
|
| 39 |
+
color: navy;
|
| 40 |
+
}
|
| 41 |
+
|
| 42 |
+
h1, h2, h3, h4, h5, h6 {
|
| 43 |
+
color: #527bbd;
|
| 44 |
+
font-family: sans-serif;
|
| 45 |
+
margin-top: 1.2em;
|
| 46 |
+
margin-bottom: 0.5em;
|
| 47 |
+
line-height: 1.3;
|
| 48 |
+
}
|
| 49 |
+
|
| 50 |
+
h1, h2, h3 {
|
| 51 |
+
border-bottom: 2px solid silver;
|
| 52 |
+
}
|
| 53 |
+
h2 {
|
| 54 |
+
padding-top: 0.5em;
|
| 55 |
+
}
|
| 56 |
+
h3 {
|
| 57 |
+
float: left;
|
| 58 |
+
}
|
| 59 |
+
h3 + * {
|
| 60 |
+
clear: left;
|
| 61 |
+
}
|
| 62 |
+
|
| 63 |
+
div.sectionbody {
|
| 64 |
+
font-family: serif;
|
| 65 |
+
margin-left: 0;
|
| 66 |
+
}
|
| 67 |
+
|
| 68 |
+
hr {
|
| 69 |
+
border: 1px solid silver;
|
| 70 |
+
}
|
| 71 |
+
|
| 72 |
+
p {
|
| 73 |
+
margin-top: 0.5em;
|
| 74 |
+
margin-bottom: 0.5em;
|
| 75 |
+
}
|
| 76 |
+
|
| 77 |
+
ul, ol, li > p {
|
| 78 |
+
margin-top: 0;
|
| 79 |
+
}
|
| 80 |
+
|
| 81 |
+
pre {
|
| 82 |
+
padding: 0;
|
| 83 |
+
margin: 0;
|
| 84 |
+
}
|
| 85 |
+
|
| 86 |
+
span#author {
|
| 87 |
+
color: #527bbd;
|
| 88 |
+
font-family: sans-serif;
|
| 89 |
+
font-weight: bold;
|
| 90 |
+
font-size: 1.1em;
|
| 91 |
+
}
|
| 92 |
+
span#email {
|
| 93 |
+
}
|
| 94 |
+
span#revnumber, span#revdate, span#revremark {
|
| 95 |
+
font-family: sans-serif;
|
| 96 |
+
}
|
| 97 |
+
|
| 98 |
+
div#footer {
|
| 99 |
+
font-family: sans-serif;
|
| 100 |
+
font-size: small;
|
| 101 |
+
border-top: 2px solid silver;
|
| 102 |
+
padding-top: 0.5em;
|
| 103 |
+
margin-top: 4.0em;
|
| 104 |
+
}
|
| 105 |
+
div#footer-text {
|
| 106 |
+
float: left;
|
| 107 |
+
padding-bottom: 0.5em;
|
| 108 |
+
}
|
| 109 |
+
div#footer-badges {
|
| 110 |
+
float: right;
|
| 111 |
+
padding-bottom: 0.5em;
|
| 112 |
+
}
|
| 113 |
+
|
| 114 |
+
div#preamble {
|
| 115 |
+
margin-top: 1.5em;
|
| 116 |
+
margin-bottom: 1.5em;
|
| 117 |
+
}
|
| 118 |
+
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
|
| 119 |
+
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
| 120 |
+
div.admonitionblock {
|
| 121 |
+
margin-top: 1.0em;
|
| 122 |
+
margin-bottom: 1.5em;
|
| 123 |
+
}
|
| 124 |
+
div.admonitionblock {
|
| 125 |
+
margin-top: 2.0em;
|
| 126 |
+
margin-bottom: 2.0em;
|
| 127 |
+
margin-right: 10%;
|
| 128 |
+
color: #606060;
|
| 129 |
+
}
|
| 130 |
+
|
| 131 |
+
div.content { /* Block element content. */
|
| 132 |
+
padding: 0;
|
| 133 |
+
}
|
| 134 |
+
|
| 135 |
+
/* Block element titles. */
|
| 136 |
+
div.title, caption.title {
|
| 137 |
+
color: #527bbd;
|
| 138 |
+
font-family: sans-serif;
|
| 139 |
+
font-weight: bold;
|
| 140 |
+
text-align: left;
|
| 141 |
+
margin-top: 1.0em;
|
| 142 |
+
margin-bottom: 0.5em;
|
| 143 |
+
}
|
| 144 |
+
div.title + * {
|
| 145 |
+
margin-top: 0;
|
| 146 |
+
}
|
| 147 |
+
|
| 148 |
+
td div.title:first-child {
|
| 149 |
+
margin-top: 0.0em;
|
| 150 |
+
}
|
| 151 |
+
div.content div.title:first-child {
|
| 152 |
+
margin-top: 0.0em;
|
| 153 |
+
}
|
| 154 |
+
div.content + div.title {
|
| 155 |
+
margin-top: 0.0em;
|
| 156 |
+
}
|
| 157 |
+
|
| 158 |
+
div.sidebarblock > div.content {
|
| 159 |
+
background: #ffffee;
|
| 160 |
+
border: 1px solid silver;
|
| 161 |
+
padding: 0.5em;
|
| 162 |
+
}
|
| 163 |
+
|
| 164 |
+
div.listingblock > div.content {
|
| 165 |
+
border: 1px solid silver;
|
| 166 |
+
background: #f4f4f4;
|
| 167 |
+
padding: 0.5em;
|
| 168 |
+
}
|
| 169 |
+
|
| 170 |
+
div.quoteblock, div.verseblock {
|
| 171 |
+
padding-left: 1.0em;
|
| 172 |
+
margin-left: 1.0em;
|
| 173 |
+
margin-right: 10%;
|
| 174 |
+
border-left: 5px solid #dddddd;
|
| 175 |
+
color: #777777;
|
| 176 |
+
}
|
| 177 |
+
|
| 178 |
+
div.quoteblock > div.attribution {
|
| 179 |
+
padding-top: 0.5em;
|
| 180 |
+
text-align: right;
|
| 181 |
+
}
|
| 182 |
+
|
| 183 |
+
div.verseblock > div.content {
|
| 184 |
+
white-space: pre;
|
| 185 |
+
}
|
| 186 |
+
div.verseblock > div.attribution {
|
| 187 |
+
padding-top: 0.75em;
|
| 188 |
+
text-align: left;
|
| 189 |
+
}
|
| 190 |
+
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
| 191 |
+
div.verseblock + div.attribution {
|
| 192 |
+
text-align: left;
|
| 193 |
+
}
|
| 194 |
+
|
| 195 |
+
div.admonitionblock .icon {
|
| 196 |
+
vertical-align: top;
|
| 197 |
+
font-size: 1.1em;
|
| 198 |
+
font-weight: bold;
|
| 199 |
+
text-decoration: underline;
|
| 200 |
+
color: #527bbd;
|
| 201 |
+
padding-right: 0.5em;
|
| 202 |
+
}
|
| 203 |
+
div.admonitionblock td.content {
|
| 204 |
+
padding-left: 0.5em;
|
| 205 |
+
border-left: 3px solid #dddddd;
|
| 206 |
+
}
|
| 207 |
+
|
| 208 |
+
div.exampleblock > div.content {
|
| 209 |
+
border-left: 3px solid #dddddd;
|
| 210 |
+
padding-left: 0.5em;
|
| 211 |
+
}
|
| 212 |
+
|
| 213 |
+
div.imageblock div.content { padding-left: 0; }
|
| 214 |
+
span.image img { border-style: none; }
|
| 215 |
+
a.image:visited { color: white; }
|
| 216 |
+
|
| 217 |
+
dl {
|
| 218 |
+
margin-top: 0.8em;
|
| 219 |
+
margin-bottom: 0.8em;
|
| 220 |
+
}
|
| 221 |
+
dt {
|
| 222 |
+
margin-top: 0.5em;
|
| 223 |
+
margin-bottom: 0;
|
| 224 |
+
font-style: normal;
|
| 225 |
+
color: navy;
|
| 226 |
+
}
|
| 227 |
+
dd > *:first-child {
|
| 228 |
+
margin-top: 0.1em;
|
| 229 |
+
}
|
| 230 |
+
|
| 231 |
+
ul, ol {
|
| 232 |
+
list-style-position: outside;
|
| 233 |
+
}
|
| 234 |
+
ol.arabic {
|
| 235 |
+
list-style-type: decimal;
|
| 236 |
+
}
|
| 237 |
+
ol.loweralpha {
|
| 238 |
+
list-style-type: lower-alpha;
|
| 239 |
+
}
|
| 240 |
+
ol.upperalpha {
|
| 241 |
+
list-style-type: upper-alpha;
|
| 242 |
+
}
|
| 243 |
+
ol.lowerroman {
|
| 244 |
+
list-style-type: lower-roman;
|
| 245 |
+
}
|
| 246 |
+
ol.upperroman {
|
| 247 |
+
list-style-type: upper-roman;
|
| 248 |
+
}
|
| 249 |
+
|
| 250 |
+
div.compact ul, div.compact ol,
|
| 251 |
+
div.compact p, div.compact p,
|
| 252 |
+
div.compact div, div.compact div {
|
| 253 |
+
margin-top: 0.1em;
|
| 254 |
+
margin-bottom: 0.1em;
|
| 255 |
+
}
|
| 256 |
+
|
| 257 |
+
div.tableblock > table {
|
| 258 |
+
border: 3px solid #527bbd;
|
| 259 |
+
}
|
| 260 |
+
thead, p.table.header {
|
| 261 |
+
font-family: sans-serif;
|
| 262 |
+
font-weight: bold;
|
| 263 |
+
}
|
| 264 |
+
tfoot {
|
| 265 |
+
font-weight: bold;
|
| 266 |
+
}
|
| 267 |
+
td > div.verse {
|
| 268 |
+
white-space: pre;
|
| 269 |
+
}
|
| 270 |
+
p.table {
|
| 271 |
+
margin-top: 0;
|
| 272 |
+
}
|
| 273 |
+
/* Because the table frame attribute is overriden by CSS in most browsers. */
|
| 274 |
+
div.tableblock > table[frame="void"] {
|
| 275 |
+
border-style: none;
|
| 276 |
+
}
|
| 277 |
+
div.tableblock > table[frame="hsides"] {
|
| 278 |
+
border-left-style: none;
|
| 279 |
+
border-right-style: none;
|
| 280 |
+
}
|
| 281 |
+
div.tableblock > table[frame="vsides"] {
|
| 282 |
+
border-top-style: none;
|
| 283 |
+
border-bottom-style: none;
|
| 284 |
+
}
|
| 285 |
+
|
| 286 |
+
|
| 287 |
+
div.hdlist {
|
| 288 |
+
margin-top: 0.8em;
|
| 289 |
+
margin-bottom: 0.8em;
|
| 290 |
+
}
|
| 291 |
+
div.hdlist tr {
|
| 292 |
+
padding-bottom: 15px;
|
| 293 |
+
}
|
| 294 |
+
dt.hdlist1.strong, td.hdlist1.strong {
|
| 295 |
+
font-weight: bold;
|
| 296 |
+
}
|
| 297 |
+
td.hdlist1 {
|
| 298 |
+
vertical-align: top;
|
| 299 |
+
font-style: normal;
|
| 300 |
+
padding-right: 0.8em;
|
| 301 |
+
color: navy;
|
| 302 |
+
}
|
| 303 |
+
td.hdlist2 {
|
| 304 |
+
vertical-align: top;
|
| 305 |
+
}
|
| 306 |
+
div.hdlist.compact tr {
|
| 307 |
+
margin: 0;
|
| 308 |
+
padding-bottom: 0;
|
| 309 |
+
}
|
| 310 |
+
|
| 311 |
+
.comment {
|
| 312 |
+
background: yellow;
|
| 313 |
+
}
|
| 314 |
+
|
| 315 |
+
.footnote, .footnoteref {
|
| 316 |
+
font-size: 0.8em;
|
| 317 |
+
}
|
| 318 |
+
|
| 319 |
+
span.footnote, span.footnoteref {
|
| 320 |
+
vertical-align: super;
|
| 321 |
+
}
|
| 322 |
+
|
| 323 |
+
#footnotes {
|
| 324 |
+
margin: 20px 0 20px 0;
|
| 325 |
+
padding: 7px 0 0 0;
|
| 326 |
+
}
|
| 327 |
+
|
| 328 |
+
#footnotes div.footnote {
|
| 329 |
+
margin: 0 0 5px 0;
|
| 330 |
+
}
|
| 331 |
+
|
| 332 |
+
#footnotes hr {
|
| 333 |
+
border: none;
|
| 334 |
+
border-top: 1px solid silver;
|
| 335 |
+
height: 1px;
|
| 336 |
+
text-align: left;
|
| 337 |
+
margin-left: 0;
|
| 338 |
+
width: 20%;
|
| 339 |
+
min-width: 100px;
|
| 340 |
+
}
|
| 341 |
+
|
| 342 |
+
|
| 343 |
+
@media print {
|
| 344 |
+
div#footer-badges { display: none; }
|
| 345 |
+
}
|
| 346 |
+
|
| 347 |
+
div#toc {
|
| 348 |
+
margin-bottom: 2.5em;
|
| 349 |
+
}
|
| 350 |
+
|
| 351 |
+
div#toctitle {
|
| 352 |
+
color: #527bbd;
|
| 353 |
+
font-family: sans-serif;
|
| 354 |
+
font-size: 1.1em;
|
| 355 |
+
font-weight: bold;
|
| 356 |
+
margin-top: 1.0em;
|
| 357 |
+
margin-bottom: 0.1em;
|
| 358 |
+
}
|
| 359 |
+
|
| 360 |
+
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
| 361 |
+
margin-top: 0;
|
| 362 |
+
margin-bottom: 0;
|
| 363 |
+
}
|
| 364 |
+
div.toclevel2 {
|
| 365 |
+
margin-left: 2em;
|
| 366 |
+
font-size: 0.9em;
|
| 367 |
+
}
|
| 368 |
+
div.toclevel3 {
|
| 369 |
+
margin-left: 4em;
|
| 370 |
+
font-size: 0.9em;
|
| 371 |
+
}
|
| 372 |
+
div.toclevel4 {
|
| 373 |
+
margin-left: 6em;
|
| 374 |
+
font-size: 0.9em;
|
| 375 |
+
}
|
| 376 |
+
/* Workarounds for IE6's broken and incomplete CSS2. */
|
| 377 |
+
|
| 378 |
+
div.sidebar-content {
|
| 379 |
+
background: #ffffee;
|
| 380 |
+
border: 1px solid silver;
|
| 381 |
+
padding: 0.5em;
|
| 382 |
+
}
|
| 383 |
+
div.sidebar-title, div.image-title {
|
| 384 |
+
color: #527bbd;
|
| 385 |
+
font-family: sans-serif;
|
| 386 |
+
font-weight: bold;
|
| 387 |
+
margin-top: 0.0em;
|
| 388 |
+
margin-bottom: 0.5em;
|
| 389 |
+
}
|
| 390 |
+
|
| 391 |
+
div.listingblock div.content {
|
| 392 |
+
border: 1px solid silver;
|
| 393 |
+
background: #f4f4f4;
|
| 394 |
+
padding: 0.5em;
|
| 395 |
+
}
|
| 396 |
+
|
| 397 |
+
div.quoteblock-attribution {
|
| 398 |
+
padding-top: 0.5em;
|
| 399 |
+
text-align: right;
|
| 400 |
+
}
|
| 401 |
+
|
| 402 |
+
div.verseblock-content {
|
| 403 |
+
white-space: pre;
|
| 404 |
+
}
|
| 405 |
+
div.verseblock-attribution {
|
| 406 |
+
padding-top: 0.75em;
|
| 407 |
+
text-align: left;
|
| 408 |
+
}
|
| 409 |
+
|
| 410 |
+
div.exampleblock-content {
|
| 411 |
+
border-left: 3px solid #dddddd;
|
| 412 |
+
padding-left: 0.5em;
|
| 413 |
+
}
|
| 414 |
+
|
| 415 |
+
/* IE6 sets dynamically generated links as visited. */
|
| 416 |
+
div#toc a:visited { color: blue; }
|
| 417 |
+
</style>
|
| 418 |
+
<script type="text/javascript">
|
| 419 |
+
/*<+'])');
|
| 463 |
+
// Function that scans the DOM tree for header elements (the DOM2
|
| 464 |
+
// nodeIterator API would be a better technique but not supported by all
|
| 465 |
+
// browsers).
|
| 466 |
+
var iterate = function (el) {
|
| 467 |
+
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
| 468 |
+
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
| 469 |
+
var mo = re.exec(i.tagName);
|
| 470 |
+
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
| 471 |
+
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
| 472 |
+
}
|
| 473 |
+
iterate(i);
|
| 474 |
+
}
|
| 475 |
+
}
|
| 476 |
+
}
|
| 477 |
+
iterate(el);
|
| 478 |
+
return result;
|
| 479 |
+
}
|
| 480 |
+
|
| 481 |
+
var toc = document.getElementById("toc");
|
| 482 |
+
var entries = tocEntries(document.getElementById("content"), toclevels);
|
| 483 |
+
for (var i = 0; i < entries.length; ++i) {
|
| 484 |
+
var entry = entries[i];
|
| 485 |
+
if (entry.element.id == "")
|
| 486 |
+
entry.element.id = "_toc_" + i;
|
| 487 |
+
var a = document.createElement("a");
|
| 488 |
+
a.href = "#" + entry.element.id;
|
| 489 |
+
a.appendChild(document.createTextNode(entry.text));
|
| 490 |
+
var div = document.createElement("div");
|
| 491 |
+
div.appendChild(a);
|
| 492 |
+
div.className = "toclevel" + entry.toclevel;
|
| 493 |
+
toc.appendChild(div);
|
| 494 |
+
}
|
| 495 |
+
if (entries.length == 0)
|
| 496 |
+
toc.parentNode.removeChild(toc);
|
| 497 |
+
},
|
| 498 |
+
|
| 499 |
+
|
| 500 |
+
/////////////////////////////////////////////////////////////////////
|
| 501 |
+
// Footnotes generator
|
| 502 |
+
/////////////////////////////////////////////////////////////////////
|
| 503 |
+
|
| 504 |
+
/* Based on footnote generation code from:
|
| 505 |
+
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
| 506 |
+
*/
|
| 507 |
+
|
| 508 |
+
footnotes: function () {
|
| 509 |
+
var cont = document.getElementById("content");
|
| 510 |
+
var noteholder = document.getElementById("footnotes");
|
| 511 |
+
var spans = cont.getElementsByTagName("span");
|
| 512 |
+
var refs = {};
|
| 513 |
+
var n = 0;
|
| 514 |
+
for (i=0; i<spans.length; i++) {
|
| 515 |
+
if (spans[i].className == "footnote") {
|
| 516 |
+
n++;
|
| 517 |
+
// Use [\s\S] in place of . so multi-line matches work.
|
| 518 |
+
// Because JavaScript has no s (dotall) regex flag.
|
| 519 |
+
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
| 520 |
+
noteholder.innerHTML +=
|
| 521 |
+
"<div class='footnote' id='_footnote_" + n + "'>" +
|
| 522 |
+
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
| 523 |
+
n + "</a>. " + note + "</div>";
|
| 524 |
+
spans[i].innerHTML =
|
| 525 |
+
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
| 526 |
+
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
| 527 |
+
var id =spans[i].getAttribute("id");
|
| 528 |
+
if (id != null) refs["#"+id] = n;
|
| 529 |
+
}
|
| 530 |
+
}
|
| 531 |
+
if (n == 0)
|
| 532 |
+
noteholder.parentNode.removeChild(noteholder);
|
| 533 |
+
else {
|
| 534 |
+
// Process footnoterefs.
|
| 535 |
+
for (i=0; i<spans.length; i++) {
|
| 536 |
+
if (spans[i].className == "footnoteref") {
|
| 537 |
+
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
| 538 |
+
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
| 539 |
+
n = refs[href];
|
| 540 |
+
spans[i].innerHTML =
|
| 541 |
+
"[<a href='#_footnote_" + n +
|
| 542 |
+
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
| 543 |
+
}
|
| 544 |
+
}
|
| 545 |
+
}
|
| 546 |
+
}
|
| 547 |
+
|
| 548 |
+
}
|
| 549 |
+
/*]]>*/
|
| 550 |
+
</script>
|
| 551 |
+
</head>
|
| 552 |
+
<body>
|
| 553 |
+
<div id="header">
|
| 554 |
+
<h1>SSH Proxy Command — connect.c</h1>
|
| 555 |
+
</div>
|
| 556 |
+
<div id="content">
|
| 557 |
+
<div id="preamble">
|
| 558 |
+
<div class="sectionbody">
|
| 559 |
+
<div class="paragraph"><p><tt>connect.c</tt> is a simple relaying command to make network connection
|
| 560 |
+
via SOCKS and https proxy. It is mainly intended to be used as proxy
|
| 561 |
+
command of OpenSSH. You can make SSH session beyond the firewall with
|
| 562 |
+
this command,</p></div>
|
| 563 |
+
<div class="paragraph"><p>Features of <tt>connect.c</tt> are:</p></div>
|
| 564 |
+
<div class="ulist"><ul>
|
| 565 |
+
<li>
|
| 566 |
+
<p>
|
| 567 |
+
Supports SOCKS (version 4/4a/5) and https CONNECT method.
|
| 568 |
+
</p>
|
| 569 |
+
</li>
|
| 570 |
+
<li>
|
| 571 |
+
<p>
|
| 572 |
+
Supports NO-AUTH and USERPASS authentication of SOCKS5
|
| 573 |
+
</p>
|
| 574 |
+
</li>
|
| 575 |
+
<li>
|
| 576 |
+
<p>
|
| 577 |
+
You can input password from tty, <tt>ssh-askpass</tt> or environment variable.
|
| 578 |
+
</p>
|
| 579 |
+
</li>
|
| 580 |
+
<li>
|
| 581 |
+
<p>
|
| 582 |
+
Run on UNIX or Windows platform.
|
| 583 |
+
</p>
|
| 584 |
+
</li>
|
| 585 |
+
<li>
|
| 586 |
+
<p>
|
| 587 |
+
You can compile with various C compiler (cc, gcc, Visual C, Borland C. etc.)
|
| 588 |
+
</p>
|
| 589 |
+
</li>
|
| 590 |
+
<li>
|
| 591 |
+
<p>
|
| 592 |
+
Simple and general program independent from OpenSSH.
|
| 593 |
+
</p>
|
| 594 |
+
</li>
|
| 595 |
+
<li>
|
| 596 |
+
<p>
|
| 597 |
+
You can also relay local socket stream instead of standard I/O.
|
| 598 |
+
</p>
|
| 599 |
+
</li>
|
| 600 |
+
</ul></div>
|
| 601 |
+
<div class="paragraph"><p>You can download source code
|
| 602 |
+
(<a href="http://bitbucket.org/gotoh/connect/raw/tip/connect.c">connect.c</a>)
|
| 603 |
+
on the <a href="http://bitbucket.org/gotoh/connect/">project page</a>.</p></div>
|
| 604 |
+
<div class="paragraph"><p>Pre-compiled binary for MS Windows is also available on
|
| 605 |
+
<a href="http://bitbucket.org/gotoh/connect/downloads/">download page</a>.</p></div>
|
| 606 |
+
</div>
|
| 607 |
+
</div>
|
| 608 |
+
<h2 id="_what_is_proxy_command">What is proxy command?</h2>
|
| 609 |
+
<div class="sectionbody">
|
| 610 |
+
<div class="paragraph"><p>OpenSSH development team decides to stop supporting SOCKS and any
|
| 611 |
+
other tunneling mechanism. It was aimed to separate complexity to
|
| 612 |
+
support various mechanism of proxying from core code. And they
|
| 613 |
+
recommends more flexible mechanism: ProxyCommand option instead.</p></div>
|
| 614 |
+
<div class="paragraph"><p>Proxy command mechanism is delegation of network stream
|
| 615 |
+
communication. If ProxyCommand options is specified, SSH invoke
|
| 616 |
+
specified external command and talk with standard I/O of thid
|
| 617 |
+
command. Invoked command undertakes network communication with
|
| 618 |
+
relaying to/from standard input/output including iniitial
|
| 619 |
+
communication or negotiation for proxying. Thus, ssh can split out
|
| 620 |
+
proxying code into external command.</p></div>
|
| 621 |
+
<div class="paragraph"><p>The <tt>connect.c</tt> program was made for this purpose.</p></div>
|
| 622 |
+
</div>
|
| 623 |
+
<h2 id="_how_to_use">How to Use</h2>
|
| 624 |
+
<div class="sectionbody">
|
| 625 |
+
<h3 id="_get_source">Get Source</h3><div style="clear:left"></div>
|
| 626 |
+
<div class="paragraph"><p>You can get source code from <a href="http://bitbucket.org/gotoh/connect/downloads/">project download page</a>.
|
| 627 |
+
Pre-compiled MS Windows binary is also available there.</p></div>
|
| 628 |
+
<h3 id="_compile_and_install">Compile and Install</h3><div style="clear:left"></div>
|
| 629 |
+
<div class="paragraph"><p>In most environment, you can compile <tt>connect.c</tt> simply. On UNIX
|
| 630 |
+
environment, you can use cc or gcc. On Windows environment, you can
|
| 631 |
+
use Microsoft Visual C, Borland C or Cygwin gcc.</p></div>
|
| 632 |
+
<div class="dlist"><dl>
|
| 633 |
+
<dt class="hdlist1">
|
| 634 |
+
UNIX cc
|
| 635 |
+
</dt>
|
| 636 |
+
<dd>
|
| 637 |
+
<p>
|
| 638 |
+
<tt>cc connect.c -o connect</tt>
|
| 639 |
+
</p>
|
| 640 |
+
</dd>
|
| 641 |
+
<dt class="hdlist1">
|
| 642 |
+
UNIX gcc
|
| 643 |
+
</dt>
|
| 644 |
+
<dd>
|
| 645 |
+
<p>
|
| 646 |
+
<tt>gcc connect.c -o connect</tt>
|
| 647 |
+
</p>
|
| 648 |
+
</dd>
|
| 649 |
+
<dt class="hdlist1">
|
| 650 |
+
Solaris
|
| 651 |
+
</dt>
|
| 652 |
+
<dd>
|
| 653 |
+
<p>
|
| 654 |
+
<tt>gcc connect.c -o connect -lnsl -lsocket -lresolv</tt>
|
| 655 |
+
</p>
|
| 656 |
+
</dd>
|
| 657 |
+
<dt class="hdlist1">
|
| 658 |
+
Microsoft Visual C/C++
|
| 659 |
+
</dt>
|
| 660 |
+
<dd>
|
| 661 |
+
<p>
|
| 662 |
+
<tt>cl connect.c wsock32.lib advapi32.lib</tt>
|
| 663 |
+
</p>
|
| 664 |
+
</dd>
|
| 665 |
+
<dt class="hdlist1">
|
| 666 |
+
Borland C
|
| 667 |
+
</dt>
|
| 668 |
+
<dd>
|
| 669 |
+
<p>
|
| 670 |
+
<tt>bcc32 connect.c wsock32.lib advapi32.lib</tt>
|
| 671 |
+
</p>
|
| 672 |
+
</dd>
|
| 673 |
+
<dt class="hdlist1">
|
| 674 |
+
Cygwin gcc
|
| 675 |
+
</dt>
|
| 676 |
+
<dd>
|
| 677 |
+
<p>
|
| 678 |
+
<tt>gcc connect.c -o connect</tt>
|
| 679 |
+
</p>
|
| 680 |
+
</dd>
|
| 681 |
+
<dt class="hdlist1">
|
| 682 |
+
Mac OS/Darwin
|
| 683 |
+
</dt>
|
| 684 |
+
<dd>
|
| 685 |
+
<p>
|
| 686 |
+
<tt>gcc connect.c -o connect -lresolv</tt>
|
| 687 |
+
</p>
|
| 688 |
+
</dd>
|
| 689 |
+
</dl></div>
|
| 690 |
+
<div class="paragraph"><p>To install connect command, simply copy compiled binary to directory
|
| 691 |
+
in your <tt>PATH</tt> (ex. <tt>/usr/local/bin</tt>). Like this:</p></div>
|
| 692 |
+
<div class="listingblock">
|
| 693 |
+
<div class="content">
|
| 694 |
+
<pre><tt>$ cp connect /usr/local/bin</tt></pre>
|
| 695 |
+
</div></div>
|
| 696 |
+
<h3 id="_modify_your_tt_ssh_config_tt">Modify your <tt>~/.ssh/config</tt></h3><div style="clear:left"></div>
|
| 697 |
+
<div class="paragraph"><p>Modify your <tt>~/.ssh/config</tt> file to use connect command as proxy
|
| 698 |
+
command. For the case of SOCKS server is running on firewall host
|
| 699 |
+
socks.local.net with port 1080, you can add <tt>ProxyCommand</tt> option in
|
| 700 |
+
<tt>~/.ssh/config</tt>, like this:</p></div>
|
| 701 |
+
<div class="listingblock">
|
| 702 |
+
<div class="content">
|
| 703 |
+
<pre><tt>Host remote.outside.net
|
| 704 |
+
ProxyCommand connect -S socks.local.net %h %p</tt></pre>
|
| 705 |
+
</div></div>
|
| 706 |
+
<div class="paragraph"><p><tt>%h</tt> and <tt>%p</tt> will be replaced on invoking proxy command with target
|
| 707 |
+
hostname and port specified to SSH command.</p></div>
|
| 708 |
+
<div class="paragraph"><p>If you hate writing many entries of remote hosts, following example
|
| 709 |
+
may help you.</p></div>
|
| 710 |
+
<div class="listingblock">
|
| 711 |
+
<div class="content">
|
| 712 |
+
<pre><tt>## Outside of the firewall, use connect command with SOCKS conenction.
|
| 713 |
+
Host *
|
| 714 |
+
ProxyCommand connect -S socks.local.net %h %p
|
| 715 |
+
|
| 716 |
+
## Inside of the firewall, use connect command with direct connection.
|
| 717 |
+
Host *.local.net
|
| 718 |
+
ProxyCommand connect %h %p</tt></pre>
|
| 719 |
+
</div></div>
|
| 720 |
+
<div class="paragraph"><p>If you want to use http proxy, use <tt>-H</tt> option instead of <tt>-S</tt> option
|
| 721 |
+
in examle above, like this:</p></div>
|
| 722 |
+
<div class="listingblock">
|
| 723 |
+
<div class="content">
|
| 724 |
+
<pre><tt>## Outside of the firewall, with HTTP proxy
|
| 725 |
+
Host *
|
| 726 |
+
ProxyCommand connect -H proxy.local.net:8080 %h %p
|
| 727 |
+
|
| 728 |
+
## Inside of the firewall, direct
|
| 729 |
+
Host *.local.net
|
| 730 |
+
ProxyCommand connect %h %p</tt></pre>
|
| 731 |
+
</div></div>
|
| 732 |
+
<h3 id="_use_ssh">Use SSH</h3><div style="clear:left"></div>
|
| 733 |
+
<div class="paragraph"><p>After editing your <tt>~/.ssh/config</tt> file, you are ready to use ssh. You
|
| 734 |
+
can execute ssh without any special options as if remote host is IP
|
| 735 |
+
reachable host. Following is an example to execute hostname command on
|
| 736 |
+
host <tt>remote.outside.net</tt>.</p></div>
|
| 737 |
+
<div class="listingblock">
|
| 738 |
+
<div class="content">
|
| 739 |
+
<pre><tt>local$ ssh remote.outside.net hostname
|
| 740 |
+
Hello, this is remote.outside.net
|
| 741 |
+
remote$</tt></pre>
|
| 742 |
+
</div></div>
|
| 743 |
+
<h3 id="_have_trouble">Have trouble?</h3><div style="clear:left"></div>
|
| 744 |
+
<div class="paragraph"><p>If you have trouble, execute connect command from command line with <tt>-d</tt>
|
| 745 |
+
option to see what is happened. Some debug message may appear and
|
| 746 |
+
reports progress. This information may tell you what is wrong. In this
|
| 747 |
+
example, error has occurred on authentication stage of SOCKS5
|
| 748 |
+
protocol.</p></div>
|
| 749 |
+
<div class="listingblock">
|
| 750 |
+
<div class="content">
|
| 751 |
+
<pre><tt>$ connect -d -S socks.local.net unknown.remote.outside.net 110
|
| 752 |
+
DEBUG: relay_method = SOCKS (2)
|
| 753 |
+
DEBUG: relay_host=socks.local.net
|
| 754 |
+
DEBUG: relay_port=1080
|
| 755 |
+
DEBUG: relay_user=gotoh
|
| 756 |
+
DEBUG: socks_version=5
|
| 757 |
+
DEBUG: socks_resolve=REMOTE (2)
|
| 758 |
+
DEBUG: local_type=stdio
|
| 759 |
+
DEBUG: dest_host=unknown.remote.outside.net
|
| 760 |
+
DEBUG: dest_port=110
|
| 761 |
+
DEBUG: Program is $Revision: 1.20 $
|
| 762 |
+
DEBUG: connecting to xxx.xxx.xxx.xxx:1080
|
| 763 |
+
DEBUG: begin_socks_relay()
|
| 764 |
+
DEBUG: atomic_out() [4 bytes]
|
| 765 |
+
DEBUG: >>> 05 02 00 02
|
| 766 |
+
DEBUG: atomic_in() [2 bytes]
|
| 767 |
+
DEBUG: <<< 05 02
|
| 768 |
+
DEBUG: auth method: USERPASS
|
| 769 |
+
DEBUG: atomic_out() [some bytes]
|
| 770 |
+
DEBUG: >>> xx xx xx xx ...
|
| 771 |
+
DEBUG: atomic_in() [2 bytes]
|
| 772 |
+
DEBUG: <<< 01 01
|
| 773 |
+
ERROR: Authentication faield.
|
| 774 |
+
FATAL: failed to begin relaying via SOCKS.</tt></pre>
|
| 775 |
+
</div></div>
|
| 776 |
+
</div>
|
| 777 |
+
<h2 id="_more_detail">More Detail</h2>
|
| 778 |
+
<div class="sectionbody">
|
| 779 |
+
<div class="paragraph"><p>Command line usage is here:</p></div>
|
| 780 |
+
<div class="listingblock">
|
| 781 |
+
<div class="content">
|
| 782 |
+
<pre><tt>usage: connect [-dnhs45] [-R resolve] [-p local-port] [-w sec]
|
| 783 |
+
[-H [user@]proxy-server[:port]]
|
| 784 |
+
[-S [user@]socks-server[:port]]
|
| 785 |
+
host port</tt></pre>
|
| 786 |
+
</div></div>
|
| 787 |
+
<div class="paragraph"><p>host and port is target hostname and port-number to connect.</p></div>
|
| 788 |
+
<div class="dlist"><dl>
|
| 789 |
+
<dt class="hdlist1">
|
| 790 |
+
<tt>-H</tt> [user@]server[:port]
|
| 791 |
+
</dt>
|
| 792 |
+
<dd>
|
| 793 |
+
<p>
|
| 794 |
+
Specify hostname and port number of http proxy server to
|
| 795 |
+
relay. If port is omitted, 80 is used.
|
| 796 |
+
</p>
|
| 797 |
+
</dd>
|
| 798 |
+
<dt class="hdlist1">
|
| 799 |
+
<tt>-h</tt>
|
| 800 |
+
</dt>
|
| 801 |
+
<dd>
|
| 802 |
+
<p>
|
| 803 |
+
Use HTTP proxy via proxy server sepcified by environment variable
|
| 804 |
+
<tt>HTTP_PROXY</tt>.
|
| 805 |
+
</p>
|
| 806 |
+
</dd>
|
| 807 |
+
<dt class="hdlist1">
|
| 808 |
+
<tt>-S</tt> [_user_@]<em>server</em>\[:_port_]
|
| 809 |
+
</dt>
|
| 810 |
+
<dd>
|
| 811 |
+
<p>
|
| 812 |
+
Specify hostname and port number of SOCKS server to
|
| 813 |
+
relay. Like <tt>-H</tt> option, port number can be omit and default is 1080.
|
| 814 |
+
</p>
|
| 815 |
+
</dd>
|
| 816 |
+
<dt class="hdlist1">
|
| 817 |
+
<tt>-s</tt>
|
| 818 |
+
</dt>
|
| 819 |
+
<dd>
|
| 820 |
+
<p>
|
| 821 |
+
Use SOCKS proxy via SOCKS server sepcified by environment variable
|
| 822 |
+
<tt>SOCKS5_SERVER</tt>.
|
| 823 |
+
</p>
|
| 824 |
+
</dd>
|
| 825 |
+
<dt class="hdlist1">
|
| 826 |
+
<tt>-4</tt>
|
| 827 |
+
</dt>
|
| 828 |
+
<dd>
|
| 829 |
+
<p>
|
| 830 |
+
Use SOCKS version 4 protocol.
|
| 831 |
+
This option must be used with <tt>-S</tt>.
|
| 832 |
+
</p>
|
| 833 |
+
</dd>
|
| 834 |
+
<dt class="hdlist1">
|
| 835 |
+
<tt>-5</tt>
|
| 836 |
+
</dt>
|
| 837 |
+
<dd>
|
| 838 |
+
<p>
|
| 839 |
+
Use SOCKS version 5 protocol.
|
| 840 |
+
This option must be used with <tt>-S</tt>.
|
| 841 |
+
</p>
|
| 842 |
+
</dd>
|
| 843 |
+
<dt class="hdlist1">
|
| 844 |
+
<tt>-R</tt> <em>method</em>
|
| 845 |
+
</dt>
|
| 846 |
+
<dd>
|
| 847 |
+
<p>
|
| 848 |
+
The method to resolve hostname. 3 keywords (<tt>local</tt>,
|
| 849 |
+
<tt>remote</tt>, <tt>both</tt>) or dot-notation IP address is allowed. Keyword
|
| 850 |
+
both means; <em>"Try local first, then remote"</em>. If dot-notation IP
|
| 851 |
+
address is specified, use this host as nameserver (UNIX
|
| 852 |
+
only). Default is remote for SOCKS5 or local for others. On SOCKS4
|
| 853 |
+
protocol, remote resolving method (remote and both) use protocol
|
| 854 |
+
version 4a.
|
| 855 |
+
</p>
|
| 856 |
+
</dd>
|
| 857 |
+
<dt class="hdlist1">
|
| 858 |
+
<tt>-p</tt> <em>port</em>
|
| 859 |
+
</dt>
|
| 860 |
+
<dd>
|
| 861 |
+
<p>
|
| 862 |
+
Accept on local TCP port and relay it instead of standard input
|
| 863 |
+
and output. With this option, program will terminate when remote or
|
| 864 |
+
local TCP session is closed.
|
| 865 |
+
</p>
|
| 866 |
+
</dd>
|
| 867 |
+
<dt class="hdlist1">
|
| 868 |
+
<tt>-w</tt> <em>timeout</em>
|
| 869 |
+
</dt>
|
| 870 |
+
<dd>
|
| 871 |
+
<p>
|
| 872 |
+
Timeout seconds for connecting to remote host.
|
| 873 |
+
</p>
|
| 874 |
+
</dd>
|
| 875 |
+
<dt class="hdlist1">
|
| 876 |
+
<tt>-a</tt> <em>auth</em>
|
| 877 |
+
</dt>
|
| 878 |
+
<dd>
|
| 879 |
+
<p>
|
| 880 |
+
option specifiys user intended authentication methods
|
| 881 |
+
separated by comma. Currently <tt>userpass</tt> and <tt>none</tt> are
|
| 882 |
+
supported. Default is userpass. You can also specifying this parameter
|
| 883 |
+
by the environment variable <tt>SOCKS5_AUTH</tt>.
|
| 884 |
+
</p>
|
| 885 |
+
</dd>
|
| 886 |
+
</dl></div>
|
| 887 |
+
<div class="paragraph"><p><tt>-d</tt>: Run with debug message output. If you fail to connect, use this
|
| 888 |
+
option to see what is done.</p></div>
|
| 889 |
+
<div class="paragraph"><p>As additional feature,
|
| 890 |
+
you can omit port argument when program name is special format
|
| 891 |
+
containing port number itself like "connect-25". For example:</p></div>
|
| 892 |
+
<div class="listingblock">
|
| 893 |
+
<div class="content">
|
| 894 |
+
<pre><tt>$ ln -s connect connect-25
|
| 895 |
+
$ ./connect-25 smtphost.outside.net
|
| 896 |
+
220 smtphost.outside.net ESMTP Sendmail
|
| 897 |
+
QUIT
|
| 898 |
+
221 2.0.0 smtphost.remote.net closing connection
|
| 899 |
+
$</tt></pre>
|
| 900 |
+
</div></div>
|
| 901 |
+
<div class="paragraph"><p>This example means that the command name "connect-25" indicates port
|
| 902 |
+
number 25 so you can omit 2nd argument (and used if specified
|
| 903 |
+
explicitly).
|
| 904 |
+
This is usefull for the application which invokes only with hostname
|
| 905 |
+
argument.</p></div>
|
| 906 |
+
<h3 id="_specifying_user_name_via_environment_variables">Specifying user name via environment variables</h3><div style="clear:left"></div>
|
| 907 |
+
<div class="paragraph"><p>There are 5 environemnt variables to specify user name without command
|
| 908 |
+
line option. This mechanism is usefull for the user who using another
|
| 909 |
+
user name different from system account.</p></div>
|
| 910 |
+
<div class="dlist"><dl>
|
| 911 |
+
<dt class="hdlist1">
|
| 912 |
+
<tt>SOCKS5_USER</tt>
|
| 913 |
+
</dt>
|
| 914 |
+
<dd>
|
| 915 |
+
<p>
|
| 916 |
+
Used for SOCKS v5 access.
|
| 917 |
+
</p>
|
| 918 |
+
</dd>
|
| 919 |
+
<dt class="hdlist1">
|
| 920 |
+
<tt>SOCKS4_USER</tt>
|
| 921 |
+
</dt>
|
| 922 |
+
<dd>
|
| 923 |
+
<p>
|
| 924 |
+
Used for SOCKS v4 access.
|
| 925 |
+
</p>
|
| 926 |
+
</dd>
|
| 927 |
+
<dt class="hdlist1">
|
| 928 |
+
<tt>SOCKS_USER</tt>
|
| 929 |
+
</dt>
|
| 930 |
+
<dd>
|
| 931 |
+
<p>
|
| 932 |
+
Used for SOCKS v5 or v4 access and varaibles above are not defined.
|
| 933 |
+
</p>
|
| 934 |
+
</dd>
|
| 935 |
+
<dt class="hdlist1">
|
| 936 |
+
<tt>HTTP_PROXY_USER</tt>
|
| 937 |
+
</dt>
|
| 938 |
+
<dd>
|
| 939 |
+
<p>
|
| 940 |
+
Used for HTTP proxy access.
|
| 941 |
+
</p>
|
| 942 |
+
</dd>
|
| 943 |
+
<dt class="hdlist1">
|
| 944 |
+
<tt>CONNECT_USER</tt>
|
| 945 |
+
</dt>
|
| 946 |
+
<dd>
|
| 947 |
+
<p>
|
| 948 |
+
Used for all type of access if all above are not defined.
|
| 949 |
+
</p>
|
| 950 |
+
</dd>
|
| 951 |
+
</dl></div>
|
| 952 |
+
<div class="paragraph"><p>Following table describes how user name is determined. Left most number is order to check. If variable is not defined, check next variable, and so on.</p></div>
|
| 953 |
+
<div class="tableblock">
|
| 954 |
+
<table rules="all"
|
| 955 |
+
width="50%"
|
| 956 |
+
frame="border"
|
| 957 |
+
cellspacing="0" cellpadding="4">
|
| 958 |
+
<col width="25%" />
|
| 959 |
+
<col width="25%" />
|
| 960 |
+
<col width="25%" />
|
| 961 |
+
<col width="25%" />
|
| 962 |
+
<tbody>
|
| 963 |
+
<tr>
|
| 964 |
+
<td align="left" valign="top"><p class="table"></p></td>
|
| 965 |
+
<td align="left" valign="top"><p class="table">SOCKS v5</p></td>
|
| 966 |
+
<td align="left" valign="top"><p class="table">SOCKS v4</p></td>
|
| 967 |
+
<td align="left" valign="top"><p class="table">HTTP proxy</p></td>
|
| 968 |
+
</tr>
|
| 969 |
+
<tr>
|
| 970 |
+
<td align="left" valign="top"><p class="table">1</p></td>
|
| 971 |
+
<td align="left" valign="top"><p class="table"><tt>SOCKS5_USER</tt></p></td>
|
| 972 |
+
<td align="left" valign="top"><p class="table"><tt>SOCKS4_USER</tt></p></td>
|
| 973 |
+
<td rowspan="2" align="center" valign="top"><p class="table"><tt>HTTP_PROXY_USER</tt></p></td>
|
| 974 |
+
</tr>
|
| 975 |
+
<tr>
|
| 976 |
+
<td align="left" valign="top"><p class="table">2</p></td>
|
| 977 |
+
<td colspan="2" align="center" valign="top"><p class="table"><tt>SOCKS_USER</tt></p></td>
|
| 978 |
+
</tr>
|
| 979 |
+
<tr>
|
| 980 |
+
<td align="left" valign="top"><p class="table">3</p></td>
|
| 981 |
+
<td colspan="3" align="center" valign="top"><p class="table"><tt>CONNECT_USER</tt></p></td>
|
| 982 |
+
</tr>
|
| 983 |
+
<tr>
|
| 984 |
+
<td align="left" valign="top"><p class="table">4</p></td>
|
| 985 |
+
<td colspan="3" align="center" valign="top"><p class="table">(query user name to system)</p></td>
|
| 986 |
+
</tr>
|
| 987 |
+
</tbody>
|
| 988 |
+
</table>
|
| 989 |
+
</div>
|
| 990 |
+
<h3 id="_specifying_password_via_environment_variables">Specifying password via environment variables</h3><div style="clear:left"></div>
|
| 991 |
+
<div class="paragraph"><p>There are 5 environemnt variables to specify password. If you use this
|
| 992 |
+
feature, please note that it is not secure way.</p></div>
|
| 993 |
+
<div class="dlist"><dl>
|
| 994 |
+
<dt class="hdlist1">
|
| 995 |
+
<tt>SOCKS5_PASSWD</tt>
|
| 996 |
+
</dt>
|
| 997 |
+
<dd>
|
| 998 |
+
<p>
|
| 999 |
+
Used for SOCKS v5 access. This variables is compatible with NEC SOCKS implementation.
|
| 1000 |
+
</p>
|
| 1001 |
+
</dd>
|
| 1002 |
+
<dt class="hdlist1">
|
| 1003 |
+
<tt>SOCKS5_PASSWORD</tt>
|
| 1004 |
+
</dt>
|
| 1005 |
+
<dd>
|
| 1006 |
+
<p>
|
| 1007 |
+
Used for SOCKS v5 access if <tt>SOCKS5_PASSWD</tt> is not defined.
|
| 1008 |
+
</p>
|
| 1009 |
+
</dd>
|
| 1010 |
+
<dt class="hdlist1">
|
| 1011 |
+
<tt>SOCKS_PASSWORD</tt>
|
| 1012 |
+
</dt>
|
| 1013 |
+
<dd>
|
| 1014 |
+
<p>
|
| 1015 |
+
Used for SOCKS v5 (or v4) access all above is not defined.
|
| 1016 |
+
</p>
|
| 1017 |
+
</dd>
|
| 1018 |
+
<dt class="hdlist1">
|
| 1019 |
+
<tt>HTTP_PROXY_PASSWORD</tt>
|
| 1020 |
+
</dt>
|
| 1021 |
+
<dd>
|
| 1022 |
+
<p>
|
| 1023 |
+
Used for HTTP proxy access.
|
| 1024 |
+
</p>
|
| 1025 |
+
</dd>
|
| 1026 |
+
<dt class="hdlist1">
|
| 1027 |
+
<tt>CONNECT_PASSWORD</tt>
|
| 1028 |
+
</dt>
|
| 1029 |
+
<dd>
|
| 1030 |
+
<p>
|
| 1031 |
+
Used for all type of access if all above are not defined.
|
| 1032 |
+
</p>
|
| 1033 |
+
</dd>
|
| 1034 |
+
</dl></div>
|
| 1035 |
+
<div class="paragraph"><p>Following table describes how password is determined. Left most number
|
| 1036 |
+
is order to check. If variable is not defined, check next variable,
|
| 1037 |
+
and so on. Finally ask to user interactively using external program or
|
| 1038 |
+
tty input.</p></div>
|
| 1039 |
+
<div class="tableblock">
|
| 1040 |
+
<table rules="all"
|
| 1041 |
+
width="50%"
|
| 1042 |
+
frame="border"
|
| 1043 |
+
cellspacing="0" cellpadding="4">
|
| 1044 |
+
<col width="33%" />
|
| 1045 |
+
<col width="33%" />
|
| 1046 |
+
<col width="33%" />
|
| 1047 |
+
<tbody>
|
| 1048 |
+
<tr>
|
| 1049 |
+
<td align="left" valign="top"><p class="table"></p></td>
|
| 1050 |
+
<td align="left" valign="top"><p class="table">SOCKS v5</p></td>
|
| 1051 |
+
<td align="left" valign="top"><p class="table">HTTP proxy</p></td>
|
| 1052 |
+
</tr>
|
| 1053 |
+
<tr>
|
| 1054 |
+
<td align="left" valign="top"><p class="table">1</p></td>
|
| 1055 |
+
<td align="left" valign="top"><p class="table"><tt>SOCKS5_PASSWD</tt></p></td>
|
| 1056 |
+
<td rowspan="2" align="center" valign="top"><p class="table"><tt>HTTP_PROXY_PASSWORD</tt></p></td>
|
| 1057 |
+
</tr>
|
| 1058 |
+
<tr>
|
| 1059 |
+
<td align="left" valign="top"><p class="table">2</p></td>
|
| 1060 |
+
<td align="left" valign="top"><p class="table"><tt>SOCKS_PASSWORD</tt></p></td>
|
| 1061 |
+
</tr>
|
| 1062 |
+
<tr>
|
| 1063 |
+
<td align="left" valign="top"><p class="table">3</p></td>
|
| 1064 |
+
<td colspan="2" align="center" valign="top"><p class="table"><tt>CONNECT_PASSWORD</tt></p></td>
|
| 1065 |
+
</tr>
|
| 1066 |
+
<tr>
|
| 1067 |
+
<td align="left" valign="top"><p class="table">4</p></td>
|
| 1068 |
+
<td colspan="2" align="center" valign="top"><p class="table">(ask to user interactively)</p></td>
|
| 1069 |
+
</tr>
|
| 1070 |
+
</tbody>
|
| 1071 |
+
</table>
|
| 1072 |
+
</div>
|
| 1073 |
+
</div>
|
| 1074 |
+
<h2 id="_limitations">Limitations</h2>
|
| 1075 |
+
<div class="sectionbody">
|
| 1076 |
+
<h3 id="_socks5_authentication">SOCKS5 authentication</h3><div style="clear:left"></div>
|
| 1077 |
+
<div class="paragraph"><p>Only NO-AUTH and USER/PASSWORD authentications are supported. GSSAPI
|
| 1078 |
+
authentication (RFC 1961) and other draft authentications (CHAP, EAP,
|
| 1079 |
+
MAF, etc.) is not supported.</p></div>
|
| 1080 |
+
<h3 id="_http_authentication">HTTP authentication</h3><div style="clear:left"></div>
|
| 1081 |
+
<div class="paragraph"><p>BASIC authentication is supported but DIGEST authentication is not.</p></div>
|
| 1082 |
+
<h3 id="_switching_proxy_server_on_event">Switching proxy server on event</h3><div style="clear:left"></div>
|
| 1083 |
+
<div class="paragraph"><p>There is no mechanism to switch proxy server regarding to PC
|
| 1084 |
+
environment. This limitation might be bad news for mobile user. Since
|
| 1085 |
+
I do not want to make this program complex, I do not want to support
|
| 1086 |
+
although this feature is already requested. Please advice me if there
|
| 1087 |
+
is good idea of detecting environment to swich and simple way to
|
| 1088 |
+
specify conditioned directive of servers.</p></div>
|
| 1089 |
+
<div class="paragraph"><p>One tricky workaround exists. It is replacing <tt>~/.ssh/config</tt> file by
|
| 1090 |
+
script on ppp up/down.</p></div>
|
| 1091 |
+
<div class="paragraph"><p>There’s another example of wrapper script (contributed by Darren
|
| 1092 |
+
Tucker). This script costs executing ifconfig and grep to detect
|
| 1093 |
+
current environment, but it works. Note that you should modify
|
| 1094 |
+
addresses if you use it.</p></div>
|
| 1095 |
+
<div class="listingblock">
|
| 1096 |
+
<div class="content">
|
| 1097 |
+
<pre><tt>#!/bin/sh
|
| 1098 |
+
## ~/bin/myconnect --- Proxy server switching wrapper
|
| 1099 |
+
|
| 1100 |
+
if ifconfig eth0 |grep "inet addr:192\.168\.1" >/dev/null; then
|
| 1101 |
+
opts="-S 192.168.1.1:1080"
|
| 1102 |
+
elif ifconfig eth0 |grep "inet addr:10\." >/dev/null; then
|
| 1103 |
+
opts="-H 10.1.1.1:80"
|
| 1104 |
+
else
|
| 1105 |
+
opts="-s"
|
| 1106 |
+
fi
|
| 1107 |
+
exec /usr/local/bin/connect $opts $@</tt></pre>
|
| 1108 |
+
</div></div>
|
| 1109 |
+
</div>
|
| 1110 |
+
<h2 id="_tips">Tips</h2>
|
| 1111 |
+
<div class="sectionbody">
|
| 1112 |
+
<h3 id="_proxying_socket_connection">Proxying socket connection</h3><div style="clear:left"></div>
|
| 1113 |
+
<div class="paragraph"><p>In usual, <tt>connect.c</tt> relays network connection to/from standard
|
| 1114 |
+
input/output. By specifying -p option, however, <tt>connect.c</tt> relays local
|
| 1115 |
+
network stream instead of standard input/output. With this option,
|
| 1116 |
+
connect command waits connection from other program, then start
|
| 1117 |
+
relaying between both network stream.</p></div>
|
| 1118 |
+
<div class="paragraph"><p>This feature may be useful for the program which is hard to SOCKSify.</p></div>
|
| 1119 |
+
<h3 id="_use_with_ssh_askpass_command">Use with ssh-askpass command</h3><div style="clear:left"></div>
|
| 1120 |
+
<div class="paragraph"><p><tt>connect.c</tt> ask you password when authentication is required. If you
|
| 1121 |
+
are using on tty/pty terminal, connect can input from terminal with
|
| 1122 |
+
prompt. But you can also use ssh-askpass program to input password. If
|
| 1123 |
+
you are graphical environment like X Window or MS Windows, and program
|
| 1124 |
+
does not have tty/pty, and environment variable <tt>SSH_ASKPASS</tt> is
|
| 1125 |
+
specified, then <tt>connect.c</tt> invoke command specified by environment
|
| 1126 |
+
variable SSH_ASKPASS to input password. ssh-askpass program might be
|
| 1127 |
+
installed if you are using OpenSSH on UNIX environment. On Windows
|
| 1128 |
+
environment, pre-compiled binary is available from here.</p></div>
|
| 1129 |
+
<div class="paragraph"><p>This feature is limited on window system environment.</p></div>
|
| 1130 |
+
<div class="paragraph"><p>And also useful on Emacs on MS Windows (NT Emacs or Meadow). It is
|
| 1131 |
+
hard to send passphrase to connect command (and also ssh) because
|
| 1132 |
+
external command is invoked on hidden terminal and do I/O with this
|
| 1133 |
+
terminal. Using ssh-askpass avoids this problem.</p></div>
|
| 1134 |
+
<h3 id="_use_for_network_stream_of_emacs">Use for Network Stream of Emacs</h3><div style="clear:left"></div>
|
| 1135 |
+
<div class="paragraph"><p>Although <tt>connect.c</tt> is made for OpenSSH, it is generic and independent
|
| 1136 |
+
from OpenSSH. So we can use this for other purpose. For example, you
|
| 1137 |
+
can use this command in Emacs to open network connection with remote
|
| 1138 |
+
host over the firewall via SOCKS or HTTP proxy without SOCKSifying
|
| 1139 |
+
Emacs itself.</p></div>
|
| 1140 |
+
<div class="paragraph"><p>There is sample code:
|
| 1141 |
+
<a href="http://bitbucket.org/gotoh/connect/src/tip/relay.el">http://bitbucket.org/gotoh/connect/src/tip/relay.el</a></p></div>
|
| 1142 |
+
<div class="paragraph"><p>With this code, you can use <tt>relay-open-network-stream</tt> function instead
|
| 1143 |
+
of <tt>open-network-stream</tt> to make network connection. See top comments of
|
| 1144 |
+
the source for more detail.</p></div>
|
| 1145 |
+
<h3 id="_remote_resolver">Remote resolver</h3><div style="clear:left"></div>
|
| 1146 |
+
<div class="paragraph"><p>If you are SOCKS4 user on UNIX environment, you might want specify
|
| 1147 |
+
nameserver to resolve remote hostname. You can do it specifying <tt>-R</tt>
|
| 1148 |
+
option followed by IP address of resolver.</p></div>
|
| 1149 |
+
<h3 id="_hopping_connection_via_ssh">Hopping Connection via SSH</h3><div style="clear:left"></div>
|
| 1150 |
+
<div class="paragraph"><p>Conbination of ssh and connect command have more interesting
|
| 1151 |
+
usage. Following command makes indirect connection to host2:port from
|
| 1152 |
+
your current host via host1.</p></div>
|
| 1153 |
+
<div class="listingblock">
|
| 1154 |
+
<div class="content">
|
| 1155 |
+
<pre><tt>$ ssh host1 connect host2 port</tt></pre>
|
| 1156 |
+
</div></div>
|
| 1157 |
+
<div class="paragraph"><p>This method is useful for the situations like:</p></div>
|
| 1158 |
+
<div class="ulist"><ul>
|
| 1159 |
+
<li>
|
| 1160 |
+
<p>
|
| 1161 |
+
You are outside of organizasion now, but you want to access an
|
| 1162 |
+
internal host barriered by firewall.
|
| 1163 |
+
</p>
|
| 1164 |
+
</li>
|
| 1165 |
+
<li>
|
| 1166 |
+
<p>
|
| 1167 |
+
You want to use some service which is allowed only from some limited hosts.
|
| 1168 |
+
</p>
|
| 1169 |
+
</li>
|
| 1170 |
+
</ul></div>
|
| 1171 |
+
<div class="paragraph"><p>For example, I want to use local NetNews service in my office from
|
| 1172 |
+
home. I cannot make NNTP session directly because NNTP host is
|
| 1173 |
+
barriered by firewall. Fortunately, I have ssh account on internal
|
| 1174 |
+
host and allowed using SOCKS5 on firewall from outside. So I use
|
| 1175 |
+
following command to connect to NNTP service.</p></div>
|
| 1176 |
+
<div class="listingblock">
|
| 1177 |
+
<div class="content">
|
| 1178 |
+
<pre><tt>$ ssh host1 connect news 119
|
| 1179 |
+
200 news.my-office.com InterNetNews NNRP server INN 2.3.2 ready (posting ok).
|
| 1180 |
+
quit
|
| 1181 |
+
205 .
|
| 1182 |
+
$</tt></pre>
|
| 1183 |
+
</div></div>
|
| 1184 |
+
<div class="paragraph"><p>By combinating hopping connection and relay.el, I can read NetNews
|
| 1185 |
+
using <a href="http://www.gohome.org/wl/">Wanderlust</a> on Emacs at home.</p></div>
|
| 1186 |
+
<div class="listingblock">
|
| 1187 |
+
<div class="content">
|
| 1188 |
+
<pre><tt> |
|
| 1189 |
+
External (internet) | Internal (office)
|
| 1190 |
+
|
|
| 1191 |
+
+------+ +----------+ +-------+ +-----------+
|
| 1192 |
+
| HOME | | firewall | | host1 | | NNTP host |
|
| 1193 |
+
+------+ +----------+ +-------+ +-----------+
|
| 1194 |
+
emacs <-------------- ssh ---------------> sshd <-- connect --> nntpd
|
| 1195 |
+
<-- connect --> socksd <-- SOCKS --></tt></pre>
|
| 1196 |
+
</div></div>
|
| 1197 |
+
<div class="paragraph"><p>As an advanced example, you can use SSH hopping as fetchmail’s plug-in
|
| 1198 |
+
program to access via secure tunnel. This method requires that connect
|
| 1199 |
+
program is insatalled on remote host. There’s example of .fetchmailrc
|
| 1200 |
+
bellow. When fetchmail access to mail-server, you will login to remote
|
| 1201 |
+
host using SSH then execute connect program on remote host to relay
|
| 1202 |
+
conversation with pop server. Thus fetchmail can retrieve mails in
|
| 1203 |
+
secure.</p></div>
|
| 1204 |
+
<div class="listingblock">
|
| 1205 |
+
<div class="content">
|
| 1206 |
+
<pre><tt>poll mail-server
|
| 1207 |
+
protocol pop3
|
| 1208 |
+
plugin "ssh %h connect localhost %p"
|
| 1209 |
+
username "username"
|
| 1210 |
+
password "password"</tt></pre>
|
| 1211 |
+
</div></div>
|
| 1212 |
+
</div>
|
| 1213 |
+
<h2 id="_break_the_more_restricted_wall">Break The More Restricted Wall</h2>
|
| 1214 |
+
<div class="sectionbody">
|
| 1215 |
+
<div class="paragraph"><p>If firewall does not provide SOCKS nor HTTPS other than port 443, you
|
| 1216 |
+
cannot break the wall in usual way. But if you have you own host which
|
| 1217 |
+
is accessible from internet, you can make ssh connection to your own
|
| 1218 |
+
host by configuring sshd as waiting at port 443 instead of standard
|
| 1219 |
+
22. By this, you can login to your own host via port 443. Once you
|
| 1220 |
+
have logged-in to extenal home machine, you can execute connect as
|
| 1221 |
+
second hop to make connection from your own host to final target host,
|
| 1222 |
+
like this:</p></div>
|
| 1223 |
+
<div class="listingblock">
|
| 1224 |
+
<div class="content">
|
| 1225 |
+
<pre><tt>internal$ cat ~/.ssh/config
|
| 1226 |
+
Host home
|
| 1227 |
+
ProxyCommand connect -H firewall:8080 %h 443
|
| 1228 |
+
|
| 1229 |
+
Host server # internal
|
| 1230 |
+
ProxyCommand ssh home connect %h %p
|
| 1231 |
+
|
| 1232 |
+
internal$ ssh home
|
| 1233 |
+
You are logged in to home!
|
| 1234 |
+
home# exit
|
| 1235 |
+
internal$ ssh server
|
| 1236 |
+
You are logged in to server!
|
| 1237 |
+
server# exit
|
| 1238 |
+
internal$</tt></pre>
|
| 1239 |
+
</div></div>
|
| 1240 |
+
<div class="paragraph"><p>This way is similar to "Hopping connection via SSH" except configuring
|
| 1241 |
+
outer sshd as waiting at port 443 (https). This means that you have a
|
| 1242 |
+
capability to break the strongly restricted wall if you have own host
|
| 1243 |
+
out side of the wall.</p></div>
|
| 1244 |
+
<div class="listingblock">
|
| 1245 |
+
<div class="content">
|
| 1246 |
+
<pre><tt> |
|
| 1247 |
+
Internal (office) | External (internet)
|
| 1248 |
+
|
|
| 1249 |
+
+--------+ +----------+ +------+ +--------+
|
| 1250 |
+
| office | | firewall | | home | | server |
|
| 1251 |
+
+--------+ +----------+ +------+ +--------+
|
| 1252 |
+
<------------------ ssh --------------------->sshd:443
|
| 1253 |
+
<-- connect --> http-proxy <-- https:443 --> any
|
| 1254 |
+
connect <-- tcp --> port</tt></pre>
|
| 1255 |
+
</div></div>
|
| 1256 |
+
<div class="admonitionblock">
|
| 1257 |
+
<table><tr>
|
| 1258 |
+
<td class="icon">
|
| 1259 |
+
<div class="title">Note</div>
|
| 1260 |
+
</td>
|
| 1261 |
+
<td class="content">If you wanna use this, you should give up hosting https
|
| 1262 |
+
service at port 443 on you external host <em>home</em>.</td>
|
| 1263 |
+
</tr></table>
|
| 1264 |
+
</div>
|
| 1265 |
+
</div>
|
| 1266 |
+
<h2 id="_f_y_i">F.Y.I.</h2>
|
| 1267 |
+
<div class="sectionbody">
|
| 1268 |
+
<h3 id="_difference_between_socks_versions">Difference between SOCKS versions</h3><div style="clear:left"></div>
|
| 1269 |
+
<div class="paragraph"><p>SOCKS version 4 is first popular implementation which is documented
|
| 1270 |
+
<a href="http://www.socks.nec.com/protocol/socks4.protocol">here</a>. Since this
|
| 1271 |
+
protocol provide IP address based requesting, client program should
|
| 1272 |
+
resolve name of outer host by itself. Version 4a (documented
|
| 1273 |
+
<a href="http://www.socks.nec.com/protocol/socks4a.protocol">here</a>) is
|
| 1274 |
+
enhanced to allow request by hostname instead of IP address.</p></div>
|
| 1275 |
+
<div class="paragraph"><p>SOCKS version 5 is re-designed protocol stands on experience of
|
| 1276 |
+
version 4 and 4a. There is no compativility with previous
|
| 1277 |
+
versions. Instead, there’s some improvement: IPv6 support, request by
|
| 1278 |
+
hostname, UDP proxying, etc.</p></div>
|
| 1279 |
+
<h3 id="_configuration_to_use_https">Configuration to use HTTPS</h3><div style="clear:left"></div>
|
| 1280 |
+
<div class="paragraph"><p>Many http proxy servers implementation supports https CONNECT method
|
| 1281 |
+
(SLL). You might add configuration to allow using https. For the
|
| 1282 |
+
example of <a href="http://www.delegate.org/delegate/">DeleGate</a> (DeleGate is a
|
| 1283 |
+
multi-purpose application level gateway, or a proxy server) , you
|
| 1284 |
+
should add https to REMITTABLE parameter to allow HTTP-Proxy like
|
| 1285 |
+
this:</p></div>
|
| 1286 |
+
<div class="listingblock">
|
| 1287 |
+
<div class="content">
|
| 1288 |
+
<pre><tt>delegated -Pxxxx ...... REMITTABLE='+,https' ...</tt></pre>
|
| 1289 |
+
</div></div>
|
| 1290 |
+
<div class="paragraph"><p>For the case of Squid, you should allow target ports via https by ACL,
|
| 1291 |
+
and so on.</p></div>
|
| 1292 |
+
<h3 id="_socks5_servers">SOCKS5 Servers</h3><div style="clear:left"></div>
|
| 1293 |
+
<div class="dlist"><dl>
|
| 1294 |
+
<dt class="hdlist1">
|
| 1295 |
+
<a href="http://www.socks.nec.com/refsoftware.html">NEC SOCKS Reference Implementation</a>
|
| 1296 |
+
</dt>
|
| 1297 |
+
<dd>
|
| 1298 |
+
<p>
|
| 1299 |
+
Reference implementation of SOKCS server and library.
|
| 1300 |
+
</p>
|
| 1301 |
+
</dd>
|
| 1302 |
+
<dt class="hdlist1">
|
| 1303 |
+
<a href="http://www.inet.no/dante/index.html">Dante</a>
|
| 1304 |
+
</dt>
|
| 1305 |
+
<dd>
|
| 1306 |
+
<p>
|
| 1307 |
+
Dante is free implementation of SOKCS server and library. Many
|
| 1308 |
+
enhancements and modulalized.
|
| 1309 |
+
</p>
|
| 1310 |
+
</dd>
|
| 1311 |
+
<dt class="hdlist1">
|
| 1312 |
+
<a href="http://www.delegate.org/delegate/">DeleGate</a>
|
| 1313 |
+
</dt>
|
| 1314 |
+
<dd>
|
| 1315 |
+
<p>
|
| 1316 |
+
DeleGate is multi function proxy service provider. DeleGate 5.x.x
|
| 1317 |
+
or earlier can be SOCKS4 server, and 6.x.x can be SOCKS5 and
|
| 1318 |
+
SOCKS4 server. and 7.7.0 or later can be SOCKS5 and SOCKS4a
|
| 1319 |
+
server.
|
| 1320 |
+
</p>
|
| 1321 |
+
</dd>
|
| 1322 |
+
</dl></div>
|
| 1323 |
+
<h3 id="_specifications">Specifications</h3><div style="clear:left"></div>
|
| 1324 |
+
<div class="dlist"><dl>
|
| 1325 |
+
<dt class="hdlist1">
|
| 1326 |
+
<a href="http://www.socks.nec.com/protocol/socks4.protocol">socks4.protocol.txt</a>
|
| 1327 |
+
</dt>
|
| 1328 |
+
<dd>
|
| 1329 |
+
<p>
|
| 1330 |
+
SOCKS: A protocol for TCP proxy across firewalls
|
| 1331 |
+
</p>
|
| 1332 |
+
</dd>
|
| 1333 |
+
<dt class="hdlist1">
|
| 1334 |
+
<a href="http://www.socks.nec.com/protocol/socks4a.protocol">socks4a.protocol.txt</a>
|
| 1335 |
+
</dt>
|
| 1336 |
+
<dd>
|
| 1337 |
+
<p>
|
| 1338 |
+
SOCKS 4A: A Simple Extension to SOCKS 4 Protocol
|
| 1339 |
+
</p>
|
| 1340 |
+
</dd>
|
| 1341 |
+
<dt class="hdlist1">
|
| 1342 |
+
<a href="http://www.socks.nec.com/rfc/rfc1928.txt">RFC 1928</a>
|
| 1343 |
+
</dt>
|
| 1344 |
+
<dd>
|
| 1345 |
+
<p>
|
| 1346 |
+
SOCKS Protocol Version 5
|
| 1347 |
+
</p>
|
| 1348 |
+
</dd>
|
| 1349 |
+
<dt class="hdlist1">
|
| 1350 |
+
<a href="http://www.socks.nec.com/rfc/rfc1929.txt">RFC 1929</a>
|
| 1351 |
+
</dt>
|
| 1352 |
+
<dd>
|
| 1353 |
+
<p>
|
| 1354 |
+
Username/Password Authentication for SOCKS V5
|
| 1355 |
+
</p>
|
| 1356 |
+
</dd>
|
| 1357 |
+
<dt class="hdlist1">
|
| 1358 |
+
<a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a>
|
| 1359 |
+
</dt>
|
| 1360 |
+
<dd>
|
| 1361 |
+
<p>
|
| 1362 |
+
Hypertext Transfer Protocol — HTTP/1.1
|
| 1363 |
+
</p>
|
| 1364 |
+
</dd>
|
| 1365 |
+
<dt class="hdlist1">
|
| 1366 |
+
<a href="http://www.ietf.org/rfc/rfc2617.txt">RFC 2617</a>
|
| 1367 |
+
</dt>
|
| 1368 |
+
<dd>
|
| 1369 |
+
<p>
|
| 1370 |
+
HTTP Authentication: Basic and Digest Access Authentication
|
| 1371 |
+
</p>
|
| 1372 |
+
</dd>
|
| 1373 |
+
</dl></div>
|
| 1374 |
+
<h3 id="_related_links">Related Links</h3><div style="clear:left"></div>
|
| 1375 |
+
<div class="ulist"><ul>
|
| 1376 |
+
<li>
|
| 1377 |
+
<p>
|
| 1378 |
+
<a href="http://www.openssh.org/">OpenSSH Home</a>
|
| 1379 |
+
</p>
|
| 1380 |
+
</li>
|
| 1381 |
+
<li>
|
| 1382 |
+
<p>
|
| 1383 |
+
<a href="http://www.ssh.com/">Proprietary SSH</a>
|
| 1384 |
+
</p>
|
| 1385 |
+
</li>
|
| 1386 |
+
<li>
|
| 1387 |
+
<p>
|
| 1388 |
+
<a href="http://www.taiyo.co.jp/~gotoh/ssh/openssh-socks.html">Using OpenSSH through a SOCKS compatible PROXY on your LAN</a> (J. Grant)
|
| 1389 |
+
</p>
|
| 1390 |
+
</li>
|
| 1391 |
+
</ul></div>
|
| 1392 |
+
<h3 id="_similars">Similars</h3><div style="clear:left"></div>
|
| 1393 |
+
<div class="dlist"><dl>
|
| 1394 |
+
<dt class="hdlist1">
|
| 1395 |
+
<a href="http://proxytunnel.sourceforge.net/">Proxy Tunnel</a>
|
| 1396 |
+
</dt>
|
| 1397 |
+
<dd>
|
| 1398 |
+
<p>
|
| 1399 |
+
Proxying command using https CONNECT.
|
| 1400 |
+
</p>
|
| 1401 |
+
</dd>
|
| 1402 |
+
<dt class="hdlist1">
|
| 1403 |
+
<a href="http://www.snurgle.org/~griffon/ssh-https-tunnel">stunnel</a>
|
| 1404 |
+
</dt>
|
| 1405 |
+
<dd>
|
| 1406 |
+
<p>
|
| 1407 |
+
Proxy through an https tunnel (Perl script)
|
| 1408 |
+
</p>
|
| 1409 |
+
</dd>
|
| 1410 |
+
</dl></div>
|
| 1411 |
+
</div>
|
| 1412 |
+
</div>
|
| 1413 |
+
<div id="footnotes"><hr /></div>
|
| 1414 |
+
<div id="footer">
|
| 1415 |
+
<div id="footer-text">
|
| 1416 |
+
Last updated 2009-12-17 21:28:59 JST
|
| 1417 |
+
</div>
|
| 1418 |
+
</div>
|
| 1419 |
+
</body>
|
| 1420 |
+
</html>
|
git/mingw64/share/doc/connect/manual.txt
ADDED
|
@@ -0,0 +1,625 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
SSH Proxy Command -- connect.c
|
| 2 |
+
==============================
|
| 3 |
+
|
| 4 |
+
`connect.c` is a simple relaying command to make network connection
|
| 5 |
+
via SOCKS and https proxy. It is mainly intended to be used as proxy
|
| 6 |
+
command of OpenSSH. You can make SSH session beyond the firewall with
|
| 7 |
+
this command,
|
| 8 |
+
|
| 9 |
+
Features of `connect.c` are:
|
| 10 |
+
|
| 11 |
+
* Supports SOCKS (version 4/4a/5) and https CONNECT method.
|
| 12 |
+
* Supports NO-AUTH and USERPASS authentication of SOCKS5
|
| 13 |
+
* You can input password from tty, `ssh-askpass` or environment variable.
|
| 14 |
+
* Run on UNIX or Windows platform.
|
| 15 |
+
* You can compile with various C compiler (cc, gcc, Visual C, Borland C. etc.)
|
| 16 |
+
* Simple and general program independent from OpenSSH.
|
| 17 |
+
* You can also relay local socket stream instead of standard I/O.
|
| 18 |
+
|
| 19 |
+
You can download source code
|
| 20 |
+
(http://bitbucket.org/gotoh/connect/raw/tip/connect.c[connect.c])
|
| 21 |
+
on the http://bitbucket.org/gotoh/connect/[project page].
|
| 22 |
+
|
| 23 |
+
Pre-compiled binary for MS Windows is also available on
|
| 24 |
+
http://bitbucket.org/gotoh/connect/downloads/[download page].
|
| 25 |
+
|
| 26 |
+
|
| 27 |
+
What is proxy command?
|
| 28 |
+
----------------------
|
| 29 |
+
|
| 30 |
+
OpenSSH development team decides to stop supporting SOCKS and any
|
| 31 |
+
other tunneling mechanism. It was aimed to separate complexity to
|
| 32 |
+
support various mechanism of proxying from core code. And they
|
| 33 |
+
recommends more flexible mechanism: ProxyCommand option instead.
|
| 34 |
+
|
| 35 |
+
Proxy command mechanism is delegation of network stream
|
| 36 |
+
communication. If ProxyCommand options is specified, SSH invoke
|
| 37 |
+
specified external command and talk with standard I/O of thid
|
| 38 |
+
command. Invoked command undertakes network communication with
|
| 39 |
+
relaying to/from standard input/output including iniitial
|
| 40 |
+
communication or negotiation for proxying. Thus, ssh can split out
|
| 41 |
+
proxying code into external command.
|
| 42 |
+
|
| 43 |
+
The `connect.c` program was made for this purpose.
|
| 44 |
+
|
| 45 |
+
How to Use
|
| 46 |
+
----------
|
| 47 |
+
|
| 48 |
+
Get Source
|
| 49 |
+
~~~~~~~~~~
|
| 50 |
+
|
| 51 |
+
You can get source code from http://bitbucket.org/gotoh/connect/downloads/[project download page].
|
| 52 |
+
Pre-compiled MS Windows binary is also available there.
|
| 53 |
+
|
| 54 |
+
|
| 55 |
+
Compile and Install
|
| 56 |
+
~~~~~~~~~~~~~~~~~~~
|
| 57 |
+
In most environment, you can compile `connect.c` simply. On UNIX
|
| 58 |
+
environment, you can use cc or gcc. On Windows environment, you can
|
| 59 |
+
use Microsoft Visual C, Borland C or Cygwin gcc.
|
| 60 |
+
|
| 61 |
+
UNIX cc:: `cc connect.c -o connect`
|
| 62 |
+
UNIX gcc:: `gcc connect.c -o connect`
|
| 63 |
+
Solaris:: `gcc connect.c -o connect -lnsl -lsocket -lresolv`
|
| 64 |
+
Microsoft Visual C/C++:: `cl connect.c wsock32.lib advapi32.lib`
|
| 65 |
+
Borland C:: `bcc32 connect.c wsock32.lib advapi32.lib`
|
| 66 |
+
Cygwin gcc:: `gcc connect.c -o connect`
|
| 67 |
+
Mac OS/Darwin:: `gcc connect.c -o connect -lresolv`
|
| 68 |
+
|
| 69 |
+
|
| 70 |
+
To install connect command, simply copy compiled binary to directory
|
| 71 |
+
in your `PATH` (ex. `/usr/local/bin`). Like this:
|
| 72 |
+
|
| 73 |
+
----
|
| 74 |
+
$ cp connect /usr/local/bin
|
| 75 |
+
----
|
| 76 |
+
|
| 77 |
+
Modify your `~/.ssh/config`
|
| 78 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 79 |
+
|
| 80 |
+
Modify your `~/.ssh/config` file to use connect command as proxy
|
| 81 |
+
command. For the case of SOCKS server is running on firewall host
|
| 82 |
+
socks.local.net with port 1080, you can add `ProxyCommand` option in
|
| 83 |
+
`~/.ssh/config`, like this:
|
| 84 |
+
|
| 85 |
+
----
|
| 86 |
+
Host remote.outside.net
|
| 87 |
+
ProxyCommand connect -S socks.local.net %h %p
|
| 88 |
+
----
|
| 89 |
+
|
| 90 |
+
`%h` and `%p` will be replaced on invoking proxy command with target
|
| 91 |
+
hostname and port specified to SSH command.
|
| 92 |
+
|
| 93 |
+
If you hate writing many entries of remote hosts, following example
|
| 94 |
+
may help you.
|
| 95 |
+
|
| 96 |
+
----
|
| 97 |
+
## Outside of the firewall, use connect command with SOCKS conenction.
|
| 98 |
+
Host *
|
| 99 |
+
ProxyCommand connect -S socks.local.net %h %p
|
| 100 |
+
|
| 101 |
+
## Inside of the firewall, use connect command with direct connection.
|
| 102 |
+
Host *.local.net
|
| 103 |
+
ProxyCommand connect %h %p
|
| 104 |
+
----
|
| 105 |
+
|
| 106 |
+
If you want to use http proxy, use `-H` option instead of `-S` option
|
| 107 |
+
in examle above, like this:
|
| 108 |
+
|
| 109 |
+
----
|
| 110 |
+
## Outside of the firewall, with HTTP proxy
|
| 111 |
+
Host *
|
| 112 |
+
ProxyCommand connect -H proxy.local.net:8080 %h %p
|
| 113 |
+
|
| 114 |
+
## Inside of the firewall, direct
|
| 115 |
+
Host *.local.net
|
| 116 |
+
ProxyCommand connect %h %p
|
| 117 |
+
----
|
| 118 |
+
|
| 119 |
+
|
| 120 |
+
Use SSH
|
| 121 |
+
~~~~~~~
|
| 122 |
+
|
| 123 |
+
After editing your `~/.ssh/config` file, you are ready to use ssh. You
|
| 124 |
+
can execute ssh without any special options as if remote host is IP
|
| 125 |
+
reachable host. Following is an example to execute hostname command on
|
| 126 |
+
host `remote.outside.net`.
|
| 127 |
+
|
| 128 |
+
----
|
| 129 |
+
local$ ssh remote.outside.net hostname
|
| 130 |
+
Hello, this is remote.outside.net
|
| 131 |
+
remote$
|
| 132 |
+
----
|
| 133 |
+
|
| 134 |
+
|
| 135 |
+
Have trouble?
|
| 136 |
+
~~~~~~~~~~~~~
|
| 137 |
+
|
| 138 |
+
If you have trouble, execute connect command from command line with `-d`
|
| 139 |
+
option to see what is happened. Some debug message may appear and
|
| 140 |
+
reports progress. This information may tell you what is wrong. In this
|
| 141 |
+
example, error has occurred on authentication stage of SOCKS5
|
| 142 |
+
protocol.
|
| 143 |
+
|
| 144 |
+
----
|
| 145 |
+
$ connect -d -S socks.local.net unknown.remote.outside.net 110
|
| 146 |
+
DEBUG: relay_method = SOCKS (2)
|
| 147 |
+
DEBUG: relay_host=socks.local.net
|
| 148 |
+
DEBUG: relay_port=1080
|
| 149 |
+
DEBUG: relay_user=gotoh
|
| 150 |
+
DEBUG: socks_version=5
|
| 151 |
+
DEBUG: socks_resolve=REMOTE (2)
|
| 152 |
+
DEBUG: local_type=stdio
|
| 153 |
+
DEBUG: dest_host=unknown.remote.outside.net
|
| 154 |
+
DEBUG: dest_port=110
|
| 155 |
+
DEBUG: Program is $Revision: 1.20 $
|
| 156 |
+
DEBUG: connecting to xxx.xxx.xxx.xxx:1080
|
| 157 |
+
DEBUG: begin_socks_relay()
|
| 158 |
+
DEBUG: atomic_out() [4 bytes]
|
| 159 |
+
DEBUG: >>> 05 02 00 02
|
| 160 |
+
DEBUG: atomic_in() [2 bytes]
|
| 161 |
+
DEBUG: <<< 05 02
|
| 162 |
+
DEBUG: auth method: USERPASS
|
| 163 |
+
DEBUG: atomic_out() [some bytes]
|
| 164 |
+
DEBUG: >>> xx xx xx xx ...
|
| 165 |
+
DEBUG: atomic_in() [2 bytes]
|
| 166 |
+
DEBUG: <<< 01 01
|
| 167 |
+
ERROR: Authentication faield.
|
| 168 |
+
FATAL: failed to begin relaying via SOCKS.
|
| 169 |
+
----
|
| 170 |
+
|
| 171 |
+
|
| 172 |
+
More Detail
|
| 173 |
+
-----------
|
| 174 |
+
|
| 175 |
+
Command line usage is here:
|
| 176 |
+
|
| 177 |
+
----
|
| 178 |
+
usage: connect [-dnhs45] [-R resolve] [-p local-port] [-w sec]
|
| 179 |
+
[-H [user@]proxy-server[:port]]
|
| 180 |
+
[-S [user@]socks-server[:port]]
|
| 181 |
+
host port
|
| 182 |
+
----
|
| 183 |
+
|
| 184 |
+
host and port is target hostname and port-number to connect.
|
| 185 |
+
|
| 186 |
+
|
| 187 |
+
`-H` [user@]server[:port]::
|
| 188 |
+
Specify hostname and port number of http proxy server to
|
| 189 |
+
relay. If port is omitted, 80 is used.
|
| 190 |
+
|
| 191 |
+
`-h`::
|
| 192 |
+
Use HTTP proxy via proxy server sepcified by environment variable
|
| 193 |
+
`HTTP_PROXY`.
|
| 194 |
+
|
| 195 |
+
`-S` \[_user_@]_server_\[:_port_]::
|
| 196 |
+
Specify hostname and port number of SOCKS server to
|
| 197 |
+
relay. Like `-H` option, port number can be omit and default is 1080.
|
| 198 |
+
|
| 199 |
+
`-s`::
|
| 200 |
+
Use SOCKS proxy via SOCKS server sepcified by environment variable
|
| 201 |
+
`SOCKS5_SERVER`.
|
| 202 |
+
|
| 203 |
+
|
| 204 |
+
`-4`:: Use SOCKS version 4 protocol.
|
| 205 |
+
This option must be used with `-S`.
|
| 206 |
+
`-5`:: Use SOCKS version 5 protocol.
|
| 207 |
+
This option must be used with `-S`.
|
| 208 |
+
|
| 209 |
+
`-R` _method_:: The method to resolve hostname. 3 keywords (`local`,
|
| 210 |
+
`remote`, `both`) or dot-notation IP address is allowed. Keyword
|
| 211 |
+
both means; _"Try local first, then remote"_. If dot-notation IP
|
| 212 |
+
address is specified, use this host as nameserver (UNIX
|
| 213 |
+
only). Default is remote for SOCKS5 or local for others. On SOCKS4
|
| 214 |
+
protocol, remote resolving method (remote and both) use protocol
|
| 215 |
+
version 4a.
|
| 216 |
+
|
| 217 |
+
`-p` _port_:: Accept on local TCP port and relay it instead of standard input
|
| 218 |
+
and output. With this option, program will terminate when remote or
|
| 219 |
+
local TCP session is closed.
|
| 220 |
+
|
| 221 |
+
`-w` _timeout_:: Timeout seconds for connecting to remote host.
|
| 222 |
+
|
| 223 |
+
`-a` _auth_:: option specifiys user intended authentication methods
|
| 224 |
+
separated by comma. Currently `userpass` and `none` are
|
| 225 |
+
supported. Default is userpass. You can also specifying this parameter
|
| 226 |
+
by the environment variable `SOCKS5_AUTH`.
|
| 227 |
+
|
| 228 |
+
`-d`: Run with debug message output. If you fail to connect, use this
|
| 229 |
+
option to see what is done.
|
| 230 |
+
|
| 231 |
+
As additional feature,
|
| 232 |
+
you can omit port argument when program name is special format
|
| 233 |
+
containing port number itself like "connect-25". For example:
|
| 234 |
+
|
| 235 |
+
----
|
| 236 |
+
$ ln -s connect connect-25
|
| 237 |
+
$ ./connect-25 smtphost.outside.net
|
| 238 |
+
220 smtphost.outside.net ESMTP Sendmail
|
| 239 |
+
QUIT
|
| 240 |
+
221 2.0.0 smtphost.remote.net closing connection
|
| 241 |
+
$
|
| 242 |
+
----
|
| 243 |
+
|
| 244 |
+
This example means that the command name "connect-25" indicates port
|
| 245 |
+
number 25 so you can omit 2nd argument (and used if specified
|
| 246 |
+
explicitly).
|
| 247 |
+
This is usefull for the application which invokes only with hostname
|
| 248 |
+
argument.
|
| 249 |
+
|
| 250 |
+
|
| 251 |
+
Specifying user name via environment variables
|
| 252 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 253 |
+
|
| 254 |
+
There are 5 environemnt variables to specify user name without command
|
| 255 |
+
line option. This mechanism is usefull for the user who using another
|
| 256 |
+
user name different from system account.
|
| 257 |
+
|
| 258 |
+
`SOCKS5_USER`::
|
| 259 |
+
Used for SOCKS v5 access.
|
| 260 |
+
`SOCKS4_USER`::
|
| 261 |
+
Used for SOCKS v4 access.
|
| 262 |
+
`SOCKS_USER`::
|
| 263 |
+
Used for SOCKS v5 or v4 access and varaibles above are not defined.
|
| 264 |
+
`HTTP_PROXY_USER`::
|
| 265 |
+
Used for HTTP proxy access.
|
| 266 |
+
`CONNECT_USER`::
|
| 267 |
+
Used for all type of access if all above are not defined.
|
| 268 |
+
|
| 269 |
+
Following table describes how user name is determined. Left most number is order to check. If variable is not defined, check next variable, and so on.
|
| 270 |
+
|
| 271 |
+
[width="50%"]
|
| 272 |
+
|====
|
| 273 |
+
| | SOCKS v5 | SOCKS v4 | HTTP proxy
|
| 274 |
+
| 1 | `SOCKS5_USER` | `SOCKS4_USER` .2+^| `HTTP_PROXY_USER`
|
| 275 |
+
| 2 2+^| `SOCKS_USER`
|
| 276 |
+
| 3 3+^| `CONNECT_USER`
|
| 277 |
+
| 4 3+^| (query user name to system)
|
| 278 |
+
|====
|
| 279 |
+
|
| 280 |
+
|
| 281 |
+
Specifying password via environment variables
|
| 282 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 283 |
+
|
| 284 |
+
There are 5 environemnt variables to specify password. If you use this
|
| 285 |
+
feature, please note that it is not secure way.
|
| 286 |
+
|
| 287 |
+
`SOCKS5_PASSWD`::
|
| 288 |
+
Used for SOCKS v5 access. This variables is compatible with NEC SOCKS implementation.
|
| 289 |
+
`SOCKS5_PASSWORD`::
|
| 290 |
+
Used for SOCKS v5 access if `SOCKS5_PASSWD` is not defined.
|
| 291 |
+
`SOCKS_PASSWORD`::
|
| 292 |
+
Used for SOCKS v5 (or v4) access all above is not defined.
|
| 293 |
+
`HTTP_PROXY_PASSWORD`::
|
| 294 |
+
Used for HTTP proxy access.
|
| 295 |
+
`CONNECT_PASSWORD`::
|
| 296 |
+
Used for all type of access if all above are not defined.
|
| 297 |
+
|
| 298 |
+
Following table describes how password is determined. Left most number
|
| 299 |
+
is order to check. If variable is not defined, check next variable,
|
| 300 |
+
and so on. Finally ask to user interactively using external program or
|
| 301 |
+
tty input.
|
| 302 |
+
|
| 303 |
+
[width="50%"]
|
| 304 |
+
|====
|
| 305 |
+
| | SOCKS v5 | HTTP proxy
|
| 306 |
+
| 1 | `SOCKS5_PASSWD` .2+^| `HTTP_PROXY_PASSWORD`
|
| 307 |
+
| 2 | `SOCKS_PASSWORD`
|
| 308 |
+
| 3 2+^| `CONNECT_PASSWORD`
|
| 309 |
+
| 4 2+^| (ask to user interactively)
|
| 310 |
+
|====
|
| 311 |
+
|
| 312 |
+
|
| 313 |
+
Limitations
|
| 314 |
+
-----------
|
| 315 |
+
|
| 316 |
+
SOCKS5 authentication
|
| 317 |
+
~~~~~~~~~~~~~~~~~~~~~
|
| 318 |
+
|
| 319 |
+
Only NO-AUTH and USER/PASSWORD authentications are supported. GSSAPI
|
| 320 |
+
authentication (RFC 1961) and other draft authentications (CHAP, EAP,
|
| 321 |
+
MAF, etc.) is not supported.
|
| 322 |
+
|
| 323 |
+
|
| 324 |
+
HTTP authentication
|
| 325 |
+
~~~~~~~~~~~~~~~~~~~
|
| 326 |
+
|
| 327 |
+
BASIC authentication is supported but DIGEST authentication is not.
|
| 328 |
+
|
| 329 |
+
|
| 330 |
+
Switching proxy server on event
|
| 331 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 332 |
+
|
| 333 |
+
There is no mechanism to switch proxy server regarding to PC
|
| 334 |
+
environment. This limitation might be bad news for mobile user. Since
|
| 335 |
+
I do not want to make this program complex, I do not want to support
|
| 336 |
+
although this feature is already requested. Please advice me if there
|
| 337 |
+
is good idea of detecting environment to swich and simple way to
|
| 338 |
+
specify conditioned directive of servers.
|
| 339 |
+
|
| 340 |
+
One tricky workaround exists. It is replacing `~/.ssh/config` file by
|
| 341 |
+
script on ppp up/down.
|
| 342 |
+
|
| 343 |
+
There's another example of wrapper script (contributed by Darren
|
| 344 |
+
Tucker). This script costs executing ifconfig and grep to detect
|
| 345 |
+
current environment, but it works. Note that you should modify
|
| 346 |
+
addresses if you use it.
|
| 347 |
+
|
| 348 |
+
----
|
| 349 |
+
#!/bin/sh
|
| 350 |
+
## ~/bin/myconnect --- Proxy server switching wrapper
|
| 351 |
+
|
| 352 |
+
if ifconfig eth0 |grep "inet addr:192\.168\.1" >/dev/null; then
|
| 353 |
+
opts="-S 192.168.1.1:1080"
|
| 354 |
+
elif ifconfig eth0 |grep "inet addr:10\." >/dev/null; then
|
| 355 |
+
opts="-H 10.1.1.1:80"
|
| 356 |
+
else
|
| 357 |
+
opts="-s"
|
| 358 |
+
fi
|
| 359 |
+
exec /usr/local/bin/connect $opts $@
|
| 360 |
+
----
|
| 361 |
+
|
| 362 |
+
|
| 363 |
+
Tips
|
| 364 |
+
----
|
| 365 |
+
|
| 366 |
+
Proxying socket connection
|
| 367 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 368 |
+
|
| 369 |
+
In usual, `connect.c` relays network connection to/from standard
|
| 370 |
+
input/output. By specifying -p option, however, `connect.c` relays local
|
| 371 |
+
network stream instead of standard input/output. With this option,
|
| 372 |
+
connect command waits connection from other program, then start
|
| 373 |
+
relaying between both network stream.
|
| 374 |
+
|
| 375 |
+
This feature may be useful for the program which is hard to SOCKSify.
|
| 376 |
+
|
| 377 |
+
|
| 378 |
+
Use with ssh-askpass command
|
| 379 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 380 |
+
|
| 381 |
+
`connect.c` ask you password when authentication is required. If you
|
| 382 |
+
are using on tty/pty terminal, connect can input from terminal with
|
| 383 |
+
prompt. But you can also use ssh-askpass program to input password. If
|
| 384 |
+
you are graphical environment like X Window or MS Windows, and program
|
| 385 |
+
does not have tty/pty, and environment variable `SSH_ASKPASS` is
|
| 386 |
+
specified, then `connect.c` invoke command specified by environment
|
| 387 |
+
variable SSH_ASKPASS to input password. ssh-askpass program might be
|
| 388 |
+
installed if you are using OpenSSH on UNIX environment. On Windows
|
| 389 |
+
environment, pre-compiled binary is available from here.
|
| 390 |
+
|
| 391 |
+
This feature is limited on window system environment.
|
| 392 |
+
|
| 393 |
+
And also useful on Emacs on MS Windows (NT Emacs or Meadow). It is
|
| 394 |
+
hard to send passphrase to connect command (and also ssh) because
|
| 395 |
+
external command is invoked on hidden terminal and do I/O with this
|
| 396 |
+
terminal. Using ssh-askpass avoids this problem.
|
| 397 |
+
|
| 398 |
+
|
| 399 |
+
Use for Network Stream of Emacs
|
| 400 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 401 |
+
|
| 402 |
+
Although `connect.c` is made for OpenSSH, it is generic and independent
|
| 403 |
+
from OpenSSH. So we can use this for other purpose. For example, you
|
| 404 |
+
can use this command in Emacs to open network connection with remote
|
| 405 |
+
host over the firewall via SOCKS or HTTP proxy without SOCKSifying
|
| 406 |
+
Emacs itself.
|
| 407 |
+
|
| 408 |
+
There is sample code:
|
| 409 |
+
http://bitbucket.org/gotoh/connect/src/tip/relay.el
|
| 410 |
+
|
| 411 |
+
With this code, you can use `relay-open-network-stream` function instead
|
| 412 |
+
of `open-network-stream` to make network connection. See top comments of
|
| 413 |
+
the source for more detail.
|
| 414 |
+
|
| 415 |
+
|
| 416 |
+
Remote resolver
|
| 417 |
+
~~~~~~~~~~~~~~~
|
| 418 |
+
|
| 419 |
+
If you are SOCKS4 user on UNIX environment, you might want specify
|
| 420 |
+
nameserver to resolve remote hostname. You can do it specifying `-R`
|
| 421 |
+
option followed by IP address of resolver.
|
| 422 |
+
|
| 423 |
+
|
| 424 |
+
Hopping Connection via SSH
|
| 425 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 426 |
+
|
| 427 |
+
Conbination of ssh and connect command have more interesting
|
| 428 |
+
usage. Following command makes indirect connection to host2:port from
|
| 429 |
+
your current host via host1.
|
| 430 |
+
|
| 431 |
+
----
|
| 432 |
+
$ ssh host1 connect host2 port
|
| 433 |
+
----
|
| 434 |
+
|
| 435 |
+
This method is useful for the situations like:
|
| 436 |
+
|
| 437 |
+
* You are outside of organizasion now, but you want to access an
|
| 438 |
+
internal host barriered by firewall.
|
| 439 |
+
|
| 440 |
+
* You want to use some service which is allowed only from some limited hosts.
|
| 441 |
+
|
| 442 |
+
For example, I want to use local NetNews service in my office from
|
| 443 |
+
home. I cannot make NNTP session directly because NNTP host is
|
| 444 |
+
barriered by firewall. Fortunately, I have ssh account on internal
|
| 445 |
+
host and allowed using SOCKS5 on firewall from outside. So I use
|
| 446 |
+
following command to connect to NNTP service.
|
| 447 |
+
|
| 448 |
+
----
|
| 449 |
+
$ ssh host1 connect news 119
|
| 450 |
+
200 news.my-office.com InterNetNews NNRP server INN 2.3.2 ready (posting ok).
|
| 451 |
+
quit
|
| 452 |
+
205 .
|
| 453 |
+
$
|
| 454 |
+
----
|
| 455 |
+
|
| 456 |
+
By combinating hopping connection and relay.el, I can read NetNews
|
| 457 |
+
using http://www.gohome.org/wl/[Wanderlust] on Emacs at home.
|
| 458 |
+
|
| 459 |
+
----
|
| 460 |
+
|
|
| 461 |
+
External (internet) | Internal (office)
|
| 462 |
+
|
|
| 463 |
+
+------+ +----------+ +-------+ +-----------+
|
| 464 |
+
| HOME | | firewall | | host1 | | NNTP host |
|
| 465 |
+
+------+ +----------+ +-------+ +-----------+
|
| 466 |
+
emacs <-------------- ssh ---------------> sshd <-- connect --> nntpd
|
| 467 |
+
<-- connect --> socksd <-- SOCKS -->
|
| 468 |
+
----
|
| 469 |
+
|
| 470 |
+
As an advanced example, you can use SSH hopping as fetchmail's plug-in
|
| 471 |
+
program to access via secure tunnel. This method requires that connect
|
| 472 |
+
program is insatalled on remote host. There's example of .fetchmailrc
|
| 473 |
+
bellow. When fetchmail access to mail-server, you will login to remote
|
| 474 |
+
host using SSH then execute connect program on remote host to relay
|
| 475 |
+
conversation with pop server. Thus fetchmail can retrieve mails in
|
| 476 |
+
secure.
|
| 477 |
+
|
| 478 |
+
----
|
| 479 |
+
poll mail-server
|
| 480 |
+
protocol pop3
|
| 481 |
+
plugin "ssh %h connect localhost %p"
|
| 482 |
+
username "username"
|
| 483 |
+
password "password"
|
| 484 |
+
----
|
| 485 |
+
|
| 486 |
+
|
| 487 |
+
Break The More Restricted Wall
|
| 488 |
+
------------------------------
|
| 489 |
+
|
| 490 |
+
If firewall does not provide SOCKS nor HTTPS other than port 443, you
|
| 491 |
+
cannot break the wall in usual way. But if you have you own host which
|
| 492 |
+
is accessible from internet, you can make ssh connection to your own
|
| 493 |
+
host by configuring sshd as waiting at port 443 instead of standard
|
| 494 |
+
22. By this, you can login to your own host via port 443. Once you
|
| 495 |
+
have logged-in to extenal home machine, you can execute connect as
|
| 496 |
+
second hop to make connection from your own host to final target host,
|
| 497 |
+
like this:
|
| 498 |
+
|
| 499 |
+
----
|
| 500 |
+
internal$ cat ~/.ssh/config
|
| 501 |
+
Host home
|
| 502 |
+
ProxyCommand connect -H firewall:8080 %h 443
|
| 503 |
+
|
| 504 |
+
Host server # internal
|
| 505 |
+
ProxyCommand ssh home connect %h %p
|
| 506 |
+
|
| 507 |
+
internal$ ssh home
|
| 508 |
+
You are logged in to home!
|
| 509 |
+
home# exit
|
| 510 |
+
internal$ ssh server
|
| 511 |
+
You are logged in to server!
|
| 512 |
+
server# exit
|
| 513 |
+
internal$
|
| 514 |
+
----
|
| 515 |
+
|
| 516 |
+
This way is similar to "Hopping connection via SSH" except configuring
|
| 517 |
+
outer sshd as waiting at port 443 (https). This means that you have a
|
| 518 |
+
capability to break the strongly restricted wall if you have own host
|
| 519 |
+
out side of the wall.
|
| 520 |
+
|
| 521 |
+
----
|
| 522 |
+
|
|
| 523 |
+
Internal (office) | External (internet)
|
| 524 |
+
|
|
| 525 |
+
+--------+ +----------+ +------+ +--------+
|
| 526 |
+
| office | | firewall | | home | | server |
|
| 527 |
+
+--------+ +----------+ +------+ +--------+
|
| 528 |
+
<------------------ ssh --------------------->sshd:443
|
| 529 |
+
<-- connect --> http-proxy <-- https:443 --> any
|
| 530 |
+
connect <-- tcp --> port
|
| 531 |
+
----
|
| 532 |
+
|
| 533 |
+
NOTE: If you wanna use this, you should give up hosting https
|
| 534 |
+
service at port 443 on you external host 'home'.
|
| 535 |
+
|
| 536 |
+
|
| 537 |
+
F.Y.I.
|
| 538 |
+
------
|
| 539 |
+
|
| 540 |
+
Difference between SOCKS versions
|
| 541 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 542 |
+
|
| 543 |
+
SOCKS version 4 is first popular implementation which is documented
|
| 544 |
+
http://www.socks.nec.com/protocol/socks4.protocol[here]. Since this
|
| 545 |
+
protocol provide IP address based requesting, client program should
|
| 546 |
+
resolve name of outer host by itself. Version 4a (documented
|
| 547 |
+
http://www.socks.nec.com/protocol/socks4a.protocol[here]) is
|
| 548 |
+
enhanced to allow request by hostname instead of IP address.
|
| 549 |
+
|
| 550 |
+
SOCKS version 5 is re-designed protocol stands on experience of
|
| 551 |
+
version 4 and 4a. There is no compativility with previous
|
| 552 |
+
versions. Instead, there's some improvement: IPv6 support, request by
|
| 553 |
+
hostname, UDP proxying, etc.
|
| 554 |
+
|
| 555 |
+
|
| 556 |
+
Configuration to use HTTPS
|
| 557 |
+
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
| 558 |
+
|
| 559 |
+
Many http proxy servers implementation supports https CONNECT method
|
| 560 |
+
(SLL). You might add configuration to allow using https. For the
|
| 561 |
+
example of http://www.delegate.org/delegate/[DeleGate] (DeleGate is a
|
| 562 |
+
multi-purpose application level gateway, or a proxy server) , you
|
| 563 |
+
should add https to REMITTABLE parameter to allow HTTP-Proxy like
|
| 564 |
+
this:
|
| 565 |
+
|
| 566 |
+
----
|
| 567 |
+
delegated -Pxxxx ...... REMITTABLE='+,https' ...
|
| 568 |
+
----
|
| 569 |
+
|
| 570 |
+
For the case of Squid, you should allow target ports via https by ACL,
|
| 571 |
+
and so on.
|
| 572 |
+
|
| 573 |
+
|
| 574 |
+
SOCKS5 Servers
|
| 575 |
+
~~~~~~~~~~~~~~
|
| 576 |
+
|
| 577 |
+
http://www.socks.nec.com/refsoftware.html[NEC SOCKS Reference Implementation]::
|
| 578 |
+
Reference implementation of SOKCS server and library.
|
| 579 |
+
|
| 580 |
+
http://www.inet.no/dante/index.html[Dante]::
|
| 581 |
+
Dante is free implementation of SOKCS server and library. Many
|
| 582 |
+
enhancements and modulalized.
|
| 583 |
+
|
| 584 |
+
http://www.delegate.org/delegate/[DeleGate]::
|
| 585 |
+
DeleGate is multi function proxy service provider. DeleGate 5.x.x
|
| 586 |
+
or earlier can be SOCKS4 server, and 6.x.x can be SOCKS5 and
|
| 587 |
+
SOCKS4 server. and 7.7.0 or later can be SOCKS5 and SOCKS4a
|
| 588 |
+
server.
|
| 589 |
+
|
| 590 |
+
|
| 591 |
+
Specifications
|
| 592 |
+
~~~~~~~~~~~~~~
|
| 593 |
+
|
| 594 |
+
http://www.socks.nec.com/protocol/socks4.protocol[socks4.protocol.txt]::
|
| 595 |
+
SOCKS: A protocol for TCP proxy across firewalls
|
| 596 |
+
http://www.socks.nec.com/protocol/socks4a.protocol[socks4a.protocol.txt]::
|
| 597 |
+
SOCKS 4A: A Simple Extension to SOCKS 4 Protocol
|
| 598 |
+
http://www.socks.nec.com/rfc/rfc1928.txt[RFC 1928]::
|
| 599 |
+
SOCKS Protocol Version 5
|
| 600 |
+
http://www.socks.nec.com/rfc/rfc1929.txt[RFC 1929]::
|
| 601 |
+
Username/Password Authentication for SOCKS V5
|
| 602 |
+
http://www.ietf.org/rfc/rfc2616.txt[RFC 2616]::
|
| 603 |
+
Hypertext Transfer Protocol -- HTTP/1.1
|
| 604 |
+
http://www.ietf.org/rfc/rfc2617.txt[RFC 2617]::
|
| 605 |
+
HTTP Authentication: Basic and Digest Access Authentication
|
| 606 |
+
|
| 607 |
+
|
| 608 |
+
Related Links
|
| 609 |
+
~~~~~~~~~~~~~
|
| 610 |
+
|
| 611 |
+
* http://www.openssh.org/[OpenSSH Home]
|
| 612 |
+
* http://www.ssh.com/[Proprietary SSH]
|
| 613 |
+
* http://www.taiyo.co.jp/~gotoh/ssh/openssh-socks.html[Using OpenSSH through a SOCKS compatible PROXY on your LAN] (J. Grant)
|
| 614 |
+
|
| 615 |
+
|
| 616 |
+
Similars
|
| 617 |
+
~~~~~~~~
|
| 618 |
+
|
| 619 |
+
http://proxytunnel.sourceforge.net/[Proxy Tunnel]:: Proxying command using https CONNECT.
|
| 620 |
+
http://www.snurgle.org/~griffon/ssh-https-tunnel[stunnel]:: Proxy through an https tunnel (Perl script)
|
| 621 |
+
|
| 622 |
+
|
| 623 |
+
// This document is rescured from the document
|
| 624 |
+
// in the internet web cache.
|
| 625 |
+
// Original date of this document is 2004-09-06.
|
git/mingw64/share/doc/expat/AUTHORS
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Expat is brought to you by:
|
| 2 |
+
|
| 3 |
+
Clark Cooper
|
| 4 |
+
Fred L. Drake, Jr.
|
| 5 |
+
Greg Stein
|
| 6 |
+
James Clark
|
| 7 |
+
Karl Waclawek
|
| 8 |
+
Rhodri James
|
| 9 |
+
Sebastian Pipping
|
| 10 |
+
Steven Solie
|
git/mingw64/share/doc/expat/changelog
ADDED
|
@@ -0,0 +1,1926 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
__ __ _
|
| 2 |
+
___\ \/ /_ __ __ _| |_
|
| 3 |
+
/ _ \\ /| '_ \ / _` | __|
|
| 4 |
+
| __// \| |_) | (_| | |_
|
| 5 |
+
\___/_/\_\ .__/ \__,_|\__|
|
| 6 |
+
|_| XML parser
|
| 7 |
+
|
| 8 |
+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
| 9 |
+
!! <blink>Expat is UNDERSTAFFED and WITHOUT FUNDING.</blink> !!
|
| 10 |
+
!! ~~~~~~~~~~~~ !!
|
| 11 |
+
!! The following topics need *additional skilled C developers* to progress !!
|
| 12 |
+
!! in a timely manner or at all (loosely ordered by descending priority): !!
|
| 13 |
+
!! _______________________ !!
|
| 14 |
+
!! - teaming up on fixing the UNFIXED SECURITY ISSUES listed at: !!
|
| 15 |
+
!! """"""""""""""""""""""" !!
|
| 16 |
+
!! https://github.com/libexpat/libexpat/issues/1160 !!
|
| 17 |
+
!! !!
|
| 18 |
+
!! - teaming up on researching and fixing future security reports and !!
|
| 19 |
+
!! ClusterFuzz findings with few-days-max response times in communication !!
|
| 20 |
+
!! in order to (1) have a sound fix ready before the end of a 90 days !!
|
| 21 |
+
!! grace period and (2) in a sustainable manner, !!
|
| 22 |
+
!! !!
|
| 23 |
+
!! - implementing and auto-testing XML 1.0r5 support !!
|
| 24 |
+
!! (needs discussion before pull requests), !!
|
| 25 |
+
!! !!
|
| 26 |
+
!! For details, please reach out via e-mail to sebastian@pipping.org so we !!
|
| 27 |
+
!! can schedule a voice call on the topic, in English or German. !!
|
| 28 |
+
!! !!
|
| 29 |
+
!! THANK YOU! Sebastian Pipping -- Berlin, 2026-03-17 !!
|
| 30 |
+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
| 31 |
+
|
| 32 |
+
Release 2.7.5 Tue March 17 2026
|
| 33 |
+
Security fixes:
|
| 34 |
+
#1158 CVE-2026-32776 -- Fix NULL function pointer dereference for
|
| 35 |
+
empty external parameter entities; it takes use of both
|
| 36 |
+
functions XML_ExternalEntityParserCreate and
|
| 37 |
+
XML_SetParamEntityParsing for an application to be
|
| 38 |
+
vulnerable.
|
| 39 |
+
#1161 #1162 CVE-2026-32777 -- Protect from XML_TOK_INSTANCE_START
|
| 40 |
+
infinite loop in function entityValueProcessor; it takes
|
| 41 |
+
use of both functions XML_ExternalEntityParserCreate and
|
| 42 |
+
XML_SetParamEntityParsing for an application to be
|
| 43 |
+
vulnerable.
|
| 44 |
+
#1163 CVE-2026-32778 -- Fix NULL dereference in function setContext
|
| 45 |
+
on retry after an earlier ouf-of-memory condition; it takes
|
| 46 |
+
use of function XML_ParserCreateNS or XML_ParserCreate_MM
|
| 47 |
+
for an application to be vulnerable.
|
| 48 |
+
#1160 Three more unfixed vulnerabilities left
|
| 49 |
+
|
| 50 |
+
Other changes:
|
| 51 |
+
#1146 #1147 Autotools: Fix condition for symbol versioning check, in
|
| 52 |
+
particular when compiling with slibtool (not libtool)
|
| 53 |
+
#1156 Address Cppcheck >=2.20.0 warnings
|
| 54 |
+
#1153 tests: Make test_buffer_can_grow_to_max work for MinGW on
|
| 55 |
+
Ubuntu 24.04
|
| 56 |
+
#1157 #1159 Version info bumped from 12:2:11 (libexpat*.so.1.11.2)
|
| 57 |
+
to 12:3:11 (libexpat*.so.1.11.3); see https://verbump.de/
|
| 58 |
+
for what these numbers do
|
| 59 |
+
|
| 60 |
+
Infrastructure:
|
| 61 |
+
#1148 CI: Fix FreeBSD and Solaris CI
|
| 62 |
+
#1149 CI: Bump to WASI SDK 30
|
| 63 |
+
#1153 CI: Adapt to breaking changes with Ubuntu 22.04
|
| 64 |
+
#1156 CI: Adapt to breaking changes in Cppcheck
|
| 65 |
+
|
| 66 |
+
Special thanks to:
|
| 67 |
+
Berkay Eren Ürün
|
| 68 |
+
Christian Ng
|
| 69 |
+
Fabio Scaccabarozzi
|
| 70 |
+
Francesco Bertolaccini
|
| 71 |
+
Mark Brand
|
| 72 |
+
Rhodri James
|
| 73 |
+
and
|
| 74 |
+
AddressSanitizer
|
| 75 |
+
Buttercup
|
| 76 |
+
OSS-Fuzz / ClusterFuzz
|
| 77 |
+
Trail of Bits
|
| 78 |
+
|
| 79 |
+
Release 2.7.4 Sat January 31 2026
|
| 80 |
+
Security fixes:
|
| 81 |
+
#1131 CVE-2026-24515 -- Function XML_ExternalEntityParserCreate
|
| 82 |
+
failed to copy the encoding handler data passed to
|
| 83 |
+
XML_SetUnknownEncodingHandler from the parent to the new
|
| 84 |
+
subparser. This can cause a NULL dereference (CWE-476) from
|
| 85 |
+
external entities that declare use of an unknown encoding.
|
| 86 |
+
The expected impact is denial of service. It takes use of
|
| 87 |
+
both functions XML_ExternalEntityParserCreate and
|
| 88 |
+
XML_SetUnknownEncodingHandler for an application to be
|
| 89 |
+
vulnerable.
|
| 90 |
+
#1075 CVE-2026-25210 -- Add missing check for integer overflow
|
| 91 |
+
related to buffer size determination in function doContent
|
| 92 |
+
|
| 93 |
+
Bug fixes:
|
| 94 |
+
#1073 lib: Fix missing undoing of group size expansion in doProlog
|
| 95 |
+
failure cases
|
| 96 |
+
#1107 xmlwf: Fix a memory leak
|
| 97 |
+
#1104 WASI: Fix format specifiers for 32bit WASI SDK
|
| 98 |
+
|
| 99 |
+
Other changes:
|
| 100 |
+
#1105 lib: Fix strict aliasing
|
| 101 |
+
#1106 lib: Leverage feature "flexible array member" of C99
|
| 102 |
+
#1051 lib: Swap (size_t)(-1) for C99 equivalent SIZE_MAX
|
| 103 |
+
#1109 lib|xmlwf: Return NULL instead of 0 for pointers
|
| 104 |
+
#1068 lib|Windows: Clean up use of macro _MSC_EXTENSIONS with MSVC
|
| 105 |
+
#1112 lib: Remove unused import
|
| 106 |
+
#1110 xmlwf: Warn about XXE in --help output (and man page)
|
| 107 |
+
#1102 #1103 WASI: Stop using getpid
|
| 108 |
+
#1113 #1130 Autotools: Drop file expat.m4 that provided obsolete Autoconf
|
| 109 |
+
macro AM_WITH_EXPAT
|
| 110 |
+
#1123 Autotools: Limit -Wno-pedantic-ms-format to MinGW
|
| 111 |
+
#1129 #1134 ..
|
| 112 |
+
#1087 Autotools|macOS: Sync CMake templates with CMake 4.0
|
| 113 |
+
#1139 #1140 Autotools|CMake: Introduce off-by-default symbol versioning
|
| 114 |
+
The related build system flags are:
|
| 115 |
+
- For Autotools, configure with --enable-symbol-versioning
|
| 116 |
+
- For CMake, configure with -DEXPAT_SYMBOL_VERSIONING=ON
|
| 117 |
+
Please double-check for consequences before activating
|
| 118 |
+
this inside distro packaging. Bug reports welcome!
|
| 119 |
+
#1117 Autotools|CMake: Remove libbsd support
|
| 120 |
+
#1105 Autotools|CMake: Stop using -fno-strict-aliasing, and use
|
| 121 |
+
-Wstrict-aliasing=3 instead
|
| 122 |
+
#1124 Autotools|CMake: Prefer command gsed (GNU sed) over sed
|
| 123 |
+
(e.g. for Solaris) inside fix-xmltest-log.sh
|
| 124 |
+
#1067 CMake: Detect and warn about unusable check_c_compiler_flag
|
| 125 |
+
#1137 CMake: Drop support for CMake <3.17
|
| 126 |
+
#1138 CMake|Windows: Fix libexpat.def.cmake version comments
|
| 127 |
+
|
| 128 |
+
#1086 #1110 docs: Add warning about external reference handlers and XXE
|
| 129 |
+
#1066 docs: Be explicit that parent parsers need to outlive
|
| 130 |
+
subparsers
|
| 131 |
+
#1089 ..
|
| 132 |
+
#1090 #1091 ..
|
| 133 |
+
#1092 #1093 ..
|
| 134 |
+
#1094 #1098 ..
|
| 135 |
+
#1115 #1116 docs: Misc non-content improvements to doc/reference.html
|
| 136 |
+
#1132 #1133 Version info bumped from 12:1:11 (libexpat*.so.1.11.1)
|
| 137 |
+
to 12:2:11 (libexpat*.so.1.11.2); see https://verbump.de/
|
| 138 |
+
for what these numbers do
|
| 139 |
+
|
| 140 |
+
Infrastructure:
|
| 141 |
+
#1119 #1121 Document guidelines for contributing to Expat
|
| 142 |
+
#1120 Introduce a pull request template
|
| 143 |
+
#1074 CI: Stop using about-to-be-removed image "macos-13"
|
| 144 |
+
#1083 #1088 CI: Mitigate random Wine crashes
|
| 145 |
+
#1104 CI: Cover compilation with WASI SDK
|
| 146 |
+
#1116 CI: Enforce clean doc XML formatting
|
| 147 |
+
#1124 ..
|
| 148 |
+
#1135 #1136 CI: Cover Solaris 11.4
|
| 149 |
+
#1125 CI: Extend CI coverage of FreeBSD
|
| 150 |
+
#1139 #1140 CI: Cover symbol versioning
|
| 151 |
+
#1114 xmlwf: Reformat helpgen code (using Black 25.12.0)
|
| 152 |
+
#1071 .gitignore: Add files CPackConfig.cmake and
|
| 153 |
+
CPackSourceConfig.cmake
|
| 154 |
+
|
| 155 |
+
Special thanks to:
|
| 156 |
+
Alfonso Gregory
|
| 157 |
+
Bénédikt Tran
|
| 158 |
+
Gordon Messmer
|
| 159 |
+
Hanno Böck
|
| 160 |
+
Jakub Kulík
|
| 161 |
+
Matthew Fernandez
|
| 162 |
+
Neil Pang
|
| 163 |
+
Rosen Penev
|
| 164 |
+
and
|
| 165 |
+
Artiphishell Inc.
|
| 166 |
+
|
| 167 |
+
Release 2.7.3 Wed September 24 2025
|
| 168 |
+
Security fixes:
|
| 169 |
+
#1046 #1048 Fix alignment of internal allocations for some non-amd64
|
| 170 |
+
architectures (e.g. sparc32); fixes up on the fix to
|
| 171 |
+
CVE-2025-59375 from #1034 (of Expat 2.7.2 and related
|
| 172 |
+
backports)
|
| 173 |
+
#1059 Fix a class of false positives where input should have been
|
| 174 |
+
rejected with error XML_ERROR_ASYNC_ENTITY; regression from
|
| 175 |
+
CVE-2024-8176 fix pull request #973 (of Expat 2.7.0 and
|
| 176 |
+
related backports). Please check the added unit tests for
|
| 177 |
+
example documents.
|
| 178 |
+
|
| 179 |
+
Other changes:
|
| 180 |
+
#1043 Prove and regression-proof absence of integer overflow
|
| 181 |
+
from function expat_realloc
|
| 182 |
+
#1062 Remove "harmless" cast that truncated a size_t to unsigned
|
| 183 |
+
#1049 Autotools: Remove "ln -s" discovery
|
| 184 |
+
#1054 docs: Be consistent with use of floating point around
|
| 185 |
+
XML_SetAllocTrackerMaximumAmplification
|
| 186 |
+
#1056 docs: Make it explicit that XML_GetCurrentColumnNumber
|
| 187 |
+
starts at 0
|
| 188 |
+
#1057 docs: Better integrate the effect of the activation
|
| 189 |
+
thresholds
|
| 190 |
+
#1058 docs: Fix an in-comment typo in expat.h
|
| 191 |
+
#1045 docs: Fix a typo in README.md
|
| 192 |
+
#1041 docs: Improve change log of release 2.7.2
|
| 193 |
+
#1053 xmlwf: Resolve use of functions XML_GetErrorLineNumber
|
| 194 |
+
and XML_GetErrorColumnNumber
|
| 195 |
+
#1032 Windows: Normalize .bat files to CRLF line endings
|
| 196 |
+
#1060 #1061 Version info bumped from 12:0:11 (libexpat*.so.1.11.0)
|
| 197 |
+
to 12:1:11 (libexpat*.so.1.11.1); see https://verbump.de/
|
| 198 |
+
for what these numbers do
|
| 199 |
+
|
| 200 |
+
Infrastructure:
|
| 201 |
+
#1047 #1050 CI: Cleanup UndefinedBehaviorSanitizer fatality
|
| 202 |
+
#1044 CI|Linux: Stop aborting at first job failure
|
| 203 |
+
#1052 CI|FreeBSD: Upgrade to FreeBSD 15.0
|
| 204 |
+
#1039 CI|FreeBSD: Do not install CMake meta-package
|
| 205 |
+
|
| 206 |
+
Special thanks to:
|
| 207 |
+
Bénédikt Tran
|
| 208 |
+
Berkay Eren Ürün
|
| 209 |
+
Daniel Engberg
|
| 210 |
+
Hanno Böck
|
| 211 |
+
Matthew Fernandez
|
| 212 |
+
Rolf Eike Beer
|
| 213 |
+
Sam James
|
| 214 |
+
Tim Bray
|
| 215 |
+
and
|
| 216 |
+
Clang/GCC UndefinedBehaviorSanitizer
|
| 217 |
+
OSS-Fuzz / ClusterFuzz
|
| 218 |
+
Z3 Theorem Prover
|
| 219 |
+
|
| 220 |
+
Release 2.7.2 Tue September 16 2025
|
| 221 |
+
Security fixes:
|
| 222 |
+
#1018 #1034 CVE-2025-59375 -- Disallow use of disproportional amounts of
|
| 223 |
+
dynamic memory from within an Expat parser (e.g. previously
|
| 224 |
+
a ~250 KiB sized document was able to cause allocation of
|
| 225 |
+
~800 MiB from the heap, i.e. an "amplification" of factor
|
| 226 |
+
~3,300); once a threshold (that defaults to 64 MiB) is
|
| 227 |
+
reached, a maximum amplification factor (that defaults to
|
| 228 |
+
100.0) is enforced, and violating documents are rejected
|
| 229 |
+
with an out-of-memory error.
|
| 230 |
+
There are two new API functions to fine-tune this new
|
| 231 |
+
behavior:
|
| 232 |
+
- XML_SetAllocTrackerActivationThreshold
|
| 233 |
+
- XML_SetAllocTrackerMaximumAmplification .
|
| 234 |
+
If you ever need to increase these defaults for non-attack
|
| 235 |
+
XML payload, please file a bug report with libexpat.
|
| 236 |
+
There is also a new environment variable
|
| 237 |
+
EXPAT_MALLOC_DEBUG=(0|1|2) to control the verbosity
|
| 238 |
+
of allocations debugging at runtime, disabled by default.
|
| 239 |
+
Known impact is (reliable and easy) denial of service:
|
| 240 |
+
CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H/E:H/RL:O/RC:C
|
| 241 |
+
(Base Score: 7.5, Temporal Score: 7.2)
|
| 242 |
+
Please note that a layer of compression around XML can
|
| 243 |
+
significantly reduce the minimum attack payload size.
|
| 244 |
+
Distributors intending to backport (or cherry-pick) the
|
| 245 |
+
fix need to copy 99% of the related pull request, not just
|
| 246 |
+
the "lib: Implement tracking of dynamic memory allocations"
|
| 247 |
+
commit, to not end up with a state that literally does both
|
| 248 |
+
too much and too little at the same time. Appending ".diff"
|
| 249 |
+
to the pull request URL could be of help.
|
| 250 |
+
|
| 251 |
+
Other changes:
|
| 252 |
+
#1008 #1017 Autotools|macOS: Sync CMake templates with CMake 3.31
|
| 253 |
+
#1007 CMake: Drop support for CMake <3.15
|
| 254 |
+
#1004 CMake: Fix off_t detection for -Werror
|
| 255 |
+
#1007 CMake|Windows: Fix -DEXPAT_MSVC_STATIC_CRT=ON
|
| 256 |
+
#1013 Windows: Drop support for Visual Studio <=16.0/2019
|
| 257 |
+
#1026 xmlwf: Mention supported environment variables in
|
| 258 |
+
--help output
|
| 259 |
+
#1024 xmlwf: Fix (internal) help generator
|
| 260 |
+
#1034 docs: Promote the contract to call function
|
| 261 |
+
XML_FreeContentModel when registering a custom
|
| 262 |
+
element declaration handler (via a call to function
|
| 263 |
+
XML_SetElementDeclHandler)
|
| 264 |
+
#1027 docs: Add missing <p>..</p> wrap
|
| 265 |
+
#994 docs: Drop AppVeyor badge
|
| 266 |
+
#1000 tests: Fix portable_strndup
|
| 267 |
+
#1036 Drop casts around malloc/free/realloc that C99 does not need
|
| 268 |
+
#1010 Replace empty for loops with while loops
|
| 269 |
+
#1011 Add const with internal XmlInitUnknownEncodingNS
|
| 270 |
+
#14 #1037 Drop an OpenVMS support leftover
|
| 271 |
+
#999 #1001 Address more clang-tidy warnings
|
| 272 |
+
#1030 #1038 Version info bumped from 11:2:10 (libexpat*.so.1.10.2)
|
| 273 |
+
to 12:0:11 (libexpat*.so.1.11.0); see https://verbump.de/
|
| 274 |
+
for what these numbers do
|
| 275 |
+
|
| 276 |
+
Infrastructure:
|
| 277 |
+
#1003 CI: Cover compilation on FreeBSD
|
| 278 |
+
#1009 #1035 CI: Upgrade Clang from 19 to 21
|
| 279 |
+
#1031 CI: Make calling Cppcheck without --suppress=objectIndex
|
| 280 |
+
and --suppress=unknownMacro possible
|
| 281 |
+
#1013 CI|Windows: Get off of deprecated image "windows-2019"
|
| 282 |
+
#1008 #1017 ..
|
| 283 |
+
#1023 #1025 CI: Adapt to breaking changes in GitHub Actions
|
| 284 |
+
|
| 285 |
+
Special thanks to:
|
| 286 |
+
Alexander Bluhm
|
| 287 |
+
Neil Pang
|
| 288 |
+
Theo Buehler
|
| 289 |
+
and
|
| 290 |
+
GNU Time
|
| 291 |
+
OSS-Fuzz / ClusterFuzz
|
| 292 |
+
Perl XML::Parser
|
| 293 |
+
|
| 294 |
+
Release 2.7.1 Thu March 27 2025
|
| 295 |
+
Bug fixes:
|
| 296 |
+
#980 #989 Restore event pointer behavior from Expat 2.6.4
|
| 297 |
+
(that the fix to CVE-2024-8176 changed in 2.7.0);
|
| 298 |
+
affected API functions are:
|
| 299 |
+
- XML_GetCurrentByteCount
|
| 300 |
+
- XML_GetCurrentByteIndex
|
| 301 |
+
- XML_GetCurrentColumnNumber
|
| 302 |
+
- XML_GetCurrentLineNumber
|
| 303 |
+
- XML_GetInputContext
|
| 304 |
+
|
| 305 |
+
Other changes:
|
| 306 |
+
#976 #977 Autotools: Integrate files "fuzz/xml_lpm_fuzzer.{cpp,proto}"
|
| 307 |
+
with Automake that were missing from 2.7.0 release tarballs
|
| 308 |
+
#983 #984 Fix printf format specifiers for 32bit Emscripten
|
| 309 |
+
#992 docs: Promote OpenSSF Best Practices self-certification
|
| 310 |
+
#978 tests/benchmark: Resolve mistaken double close
|
| 311 |
+
#986 Address Frama-C warnings
|
| 312 |
+
#990 #993 Version info bumped from 11:1:10 (libexpat*.so.1.10.1)
|
| 313 |
+
to 11:2:10 (libexpat*.so.1.10.2); see https://verbump.de/
|
| 314 |
+
for what these numbers do
|
| 315 |
+
|
| 316 |
+
Infrastructure:
|
| 317 |
+
#982 CI: Start running Perl XML::Parser integration tests
|
| 318 |
+
#987 CI: Enforce Clang Static Analyzer clean code
|
| 319 |
+
#991 CI: Re-enable warning clang-analyzer-valist.Uninitialized
|
| 320 |
+
for clang-tidy
|
| 321 |
+
#981 CI: Cover compilation with musl
|
| 322 |
+
#983 #984 CI: Cover compilation with 32bit Emscripten
|
| 323 |
+
#976 #977 CI: Protect against fuzzer files missing from future
|
| 324 |
+
release archives
|
| 325 |
+
|
| 326 |
+
Special thanks to:
|
| 327 |
+
Berkay Eren Ürün
|
| 328 |
+
Matthew Fernandez
|
| 329 |
+
and
|
| 330 |
+
Perl XML::Parser
|
| 331 |
+
|
| 332 |
+
Release 2.7.0 Thu March 13 2025
|
| 333 |
+
Security fixes:
|
| 334 |
+
#893 #973 CVE-2024-8176 -- Fix crash from chaining a large number
|
| 335 |
+
of entities caused by stack overflow by resolving use of
|
| 336 |
+
recursion, for all three uses of entities:
|
| 337 |
+
- general entities in character data ("<e>&g1;</e>")
|
| 338 |
+
- general entities in attribute values ("<e k1='&g1;'/>")
|
| 339 |
+
- parameter entities ("%p1;")
|
| 340 |
+
Known impact is (reliable and easy) denial of service:
|
| 341 |
+
CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H/E:H/RL:O/RC:C
|
| 342 |
+
(Base Score: 7.5, Temporal Score: 7.2)
|
| 343 |
+
Please note that a layer of compression around XML can
|
| 344 |
+
significantly reduce the minimum attack payload size.
|
| 345 |
+
|
| 346 |
+
Other changes:
|
| 347 |
+
#935 #937 Autotools: Make generated CMake files look for
|
| 348 |
+
libexpat.@SO_MAJOR@.dylib on macOS
|
| 349 |
+
#925 Autotools: Sync CMake templates with CMake 3.29
|
| 350 |
+
#945 #962 #966 CMake: Drop support for CMake <3.13
|
| 351 |
+
#942 CMake: Small fuzzing related improvements
|
| 352 |
+
#921 docs: Add missing documentation of error code
|
| 353 |
+
XML_ERROR_NOT_STARTED that was introduced with 2.6.4
|
| 354 |
+
#941 docs: Document need for C++11 compiler for use from C++
|
| 355 |
+
#959 tests/benchmark: Fix a (harmless) TOCTTOU
|
| 356 |
+
#944 Windows: Fix installer target location of file xmlwf.xml
|
| 357 |
+
for CMake
|
| 358 |
+
#953 Windows: Address warning -Wunknown-warning-option
|
| 359 |
+
about -Wno-pedantic-ms-format from LLVM MinGW
|
| 360 |
+
#971 Address Cppcheck warnings
|
| 361 |
+
#969 #970 Mass-migrate links from http:// to https://
|
| 362 |
+
#947 #958 ..
|
| 363 |
+
#974 #975 Document changes since the previous release
|
| 364 |
+
#974 #975 Version info bumped from 11:0:10 (libexpat*.so.1.10.0)
|
| 365 |
+
to 11:1:10 (libexpat*.so.1.10.1); see https://verbump.de/
|
| 366 |
+
for what these numbers do
|
| 367 |
+
|
| 368 |
+
Infrastructure:
|
| 369 |
+
#926 tests: Increase robustness
|
| 370 |
+
#927 #932 ..
|
| 371 |
+
#930 #933 tests: Increase test coverage
|
| 372 |
+
#617 #950 ..
|
| 373 |
+
#951 #952 ..
|
| 374 |
+
#954 #955 .. Fuzzing: Add new fuzzer "xml_lpm_fuzzer" based on
|
| 375 |
+
#961 Google's libprotobuf-mutator ("LPM")
|
| 376 |
+
#957 Fuzzing|CI: Start producing fuzzing code coverage reports
|
| 377 |
+
#936 CI: Pass -q -q for LCOV >=2.1 in coverage.sh
|
| 378 |
+
#942 CI: Small fuzzing related improvements
|
| 379 |
+
#139 #203 ..
|
| 380 |
+
#791 #946 CI: Make GitHub Actions build using MSVC on Windows and
|
| 381 |
+
produce 32bit and 64bit Windows binaries
|
| 382 |
+
#956 CI: Get off of about-to-be-removed Ubuntu 20.04
|
| 383 |
+
#960 #964 CI: Start uploading to Coverity Scan for static analysis
|
| 384 |
+
#972 CI: Stop loading DTD from the internet to address flaky CI
|
| 385 |
+
#971 CI: Adapt to breaking changes in Cppcheck
|
| 386 |
+
|
| 387 |
+
Special thanks to:
|
| 388 |
+
Alexander Gieringer
|
| 389 |
+
Berkay Eren Ürün
|
| 390 |
+
Hanno Böck
|
| 391 |
+
Jann Horn
|
| 392 |
+
Mark Brand
|
| 393 |
+
Sebastian Andrzej Siewior
|
| 394 |
+
Snild Dolkow
|
| 395 |
+
Thomas Pröll
|
| 396 |
+
Tomas Korbar
|
| 397 |
+
valord577
|
| 398 |
+
and
|
| 399 |
+
Google Project Zero
|
| 400 |
+
Linutronix
|
| 401 |
+
Red Hat
|
| 402 |
+
Siemens
|
| 403 |
+
|
| 404 |
+
Release 2.6.4 Wed November 6 2024
|
| 405 |
+
Security fixes:
|
| 406 |
+
#915 CVE-2024-50602 -- Fix crash within function XML_ResumeParser
|
| 407 |
+
from a NULL pointer dereference by disallowing function
|
| 408 |
+
XML_StopParser to (stop or) suspend an unstarted parser.
|
| 409 |
+
A new error code XML_ERROR_NOT_STARTED was introduced to
|
| 410 |
+
properly communicate this situation. // CWE-476 CWE-754
|
| 411 |
+
|
| 412 |
+
Other changes:
|
| 413 |
+
#903 CMake: Add alias target "expat::expat"
|
| 414 |
+
#905 docs: Document use via CMake >=3.18 with FetchContent
|
| 415 |
+
and SOURCE_SUBDIR and its consequences
|
| 416 |
+
#902 tests: Reduce use of global parser instance
|
| 417 |
+
#904 tests: Resolve duplicate handler
|
| 418 |
+
#317 #918 tests: Improve tests on doctype closing (ex CVE-2019-15903)
|
| 419 |
+
#914 Fix signedness of format strings
|
| 420 |
+
#915 For use from C++, expat.h started requiring C++11 due to
|
| 421 |
+
use of C99 features
|
| 422 |
+
#919 #920 Version info bumped from 10:3:9 (libexpat*.so.1.9.3)
|
| 423 |
+
to 11:0:10 (libexpat*.so.1.10.0); see https://verbump.de/
|
| 424 |
+
for what these numbers do
|
| 425 |
+
|
| 426 |
+
Infrastructure:
|
| 427 |
+
#907 CI: Upgrade Clang from 18 to 19
|
| 428 |
+
#913 CI: Drop macos-12 and add macos-15
|
| 429 |
+
#910 CI: Adapt to breaking changes in GitHub Actions
|
| 430 |
+
#898 Add missing entries to .gitignore
|
| 431 |
+
|
| 432 |
+
Special thanks to:
|
| 433 |
+
Hanno Böck
|
| 434 |
+
José Eduardo Gutiérrez Conejo
|
| 435 |
+
José Ricardo Cardona Quesada
|
| 436 |
+
|
| 437 |
+
Release 2.6.3 Wed September 4 2024
|
| 438 |
+
Security fixes:
|
| 439 |
+
#887 #890 CVE-2024-45490 -- Calling function XML_ParseBuffer with
|
| 440 |
+
len < 0 without noticing and then calling XML_GetBuffer
|
| 441 |
+
will have XML_ParseBuffer fail to recognize the problem
|
| 442 |
+
and XML_GetBuffer corrupt memory.
|
| 443 |
+
With the fix, XML_ParseBuffer now complains with error
|
| 444 |
+
XML_ERROR_INVALID_ARGUMENT just like sibling XML_Parse
|
| 445 |
+
has been doing since Expat 2.2.1, and now documented.
|
| 446 |
+
Impact is denial of service to potentially artitrary code
|
| 447 |
+
execution.
|
| 448 |
+
#888 #891 CVE-2024-45491 -- Internal function dtdCopy can have an
|
| 449 |
+
integer overflow for nDefaultAtts on 32-bit platforms
|
| 450 |
+
(where UINT_MAX equals SIZE_MAX).
|
| 451 |
+
Impact is denial of service to potentially artitrary code
|
| 452 |
+
execution.
|
| 453 |
+
#889 #892 CVE-2024-45492 -- Internal function nextScaffoldPart can
|
| 454 |
+
have an integer overflow for m_groupSize on 32-bit
|
| 455 |
+
platforms (where UINT_MAX equals SIZE_MAX).
|
| 456 |
+
Impact is denial of service to potentially artitrary code
|
| 457 |
+
execution.
|
| 458 |
+
|
| 459 |
+
Other changes:
|
| 460 |
+
#851 #879 Autotools: Sync CMake templates with CMake 3.28
|
| 461 |
+
#853 Autotools: Always provide path to find(1) for portability
|
| 462 |
+
#861 Autotools: Ensure that the m4 directory always exists.
|
| 463 |
+
#870 Autotools: Simplify handling of SIZEOF_VOID_P
|
| 464 |
+
#869 Autotools: Support non-GNU sed
|
| 465 |
+
#856 Autotools|CMake: Fix main() to main(void)
|
| 466 |
+
#865 Autotools|CMake: Fix compile tests for HAVE_SYSCALL_GETRANDOM
|
| 467 |
+
#863 Autotools|CMake: Stop requiring dos2unix
|
| 468 |
+
#854 #855 CMake: Fix check for symbols size_t and off_t
|
| 469 |
+
#864 docs|tests: Convert README to Markdown and update
|
| 470 |
+
#741 Windows: Drop support for Visual Studio <=15.0/2017
|
| 471 |
+
#886 Drop needless XML_DTD guards around is_param access
|
| 472 |
+
#885 Fix typo in a code comment
|
| 473 |
+
#894 #896 Version info bumped from 10:2:9 (libexpat*.so.1.9.2)
|
| 474 |
+
to 10:3:9 (libexpat*.so.1.9.3); see https://verbump.de/
|
| 475 |
+
for what these numbers do
|
| 476 |
+
|
| 477 |
+
Infrastructure:
|
| 478 |
+
#880 Readme: Promote the call for help
|
| 479 |
+
#868 CI: Fix various issues
|
| 480 |
+
#849 CI: Allow triggering GitHub Actions workflows manually
|
| 481 |
+
#851 #872 ..
|
| 482 |
+
#873 #879 CI: Adapt to breaking changes in GitHub Actions
|
| 483 |
+
|
| 484 |
+
Special thanks to:
|
| 485 |
+
Alexander Bluhm
|
| 486 |
+
Berkay Eren Ürün
|
| 487 |
+
Dag-Erling Smørgrav
|
| 488 |
+
Ferenc Géczi
|
| 489 |
+
TaiYou
|
| 490 |
+
|
| 491 |
+
Release 2.6.2 Wed March 13 2024
|
| 492 |
+
Security fixes:
|
| 493 |
+
#839 #842 CVE-2024-28757 -- Prevent billion laughs attacks with
|
| 494 |
+
isolated use of external parsers. Please see the commit
|
| 495 |
+
message of commit 1d50b80cf31de87750103656f6eb693746854aa8
|
| 496 |
+
for details.
|
| 497 |
+
|
| 498 |
+
Bug fixes:
|
| 499 |
+
#839 #841 Reject direct parameter entity recursion
|
| 500 |
+
and avoid the related undefined behavior
|
| 501 |
+
|
| 502 |
+
Other changes:
|
| 503 |
+
#847 Autotools: Fix build for DOCBOOK_TO_MAN containing spaces
|
| 504 |
+
#837 Add missing #821 and #824 to 2.6.1 change log
|
| 505 |
+
#838 #843 Version info bumped from 10:1:9 (libexpat*.so.1.9.1)
|
| 506 |
+
to 10:2:9 (libexpat*.so.1.9.2); see https://verbump.de/
|
| 507 |
+
for what these numbers do
|
| 508 |
+
|
| 509 |
+
Special thanks to:
|
| 510 |
+
Philippe Antoine
|
| 511 |
+
Tomas Korbar
|
| 512 |
+
and
|
| 513 |
+
Clang UndefinedBehaviorSanitizer
|
| 514 |
+
OSS-Fuzz / ClusterFuzz
|
| 515 |
+
|
| 516 |
+
Release 2.6.1 Thu February 29 2024
|
| 517 |
+
Bug fixes:
|
| 518 |
+
#817 Make tests independent of CPU speed, and thus more robust
|
| 519 |
+
#828 #836 Expose billion laughs API with XML_DTD defined and
|
| 520 |
+
XML_GE undefined, regression from 2.6.0
|
| 521 |
+
|
| 522 |
+
Other changes:
|
| 523 |
+
#829 Hide test-only code behind new internal macro
|
| 524 |
+
#833 Autotools: Reject expat_config.h.in defining SIZEOF_VOID_P
|
| 525 |
+
#821 #824 Autotools: Fix "make clean" for case:
|
| 526 |
+
./configure --without-docbook && make clean all
|
| 527 |
+
#819 Address compiler warnings
|
| 528 |
+
#832 #834 Version info bumped from 10:0:9 (libexpat*.so.1.9.0)
|
| 529 |
+
to 10:1:9 (libexpat*.so.1.9.1); see https://verbump.de/
|
| 530 |
+
for what these numbers do
|
| 531 |
+
|
| 532 |
+
Infrastructure:
|
| 533 |
+
#818 CI: Adapt to breaking changes in clang-format
|
| 534 |
+
|
| 535 |
+
Special thanks to:
|
| 536 |
+
David Hall
|
| 537 |
+
Snild Dolkow
|
| 538 |
+
|
| 539 |
+
Release 2.6.0 Tue February 6 2024
|
| 540 |
+
Security fixes:
|
| 541 |
+
#789 #814 CVE-2023-52425 -- Fix quadratic runtime issues with big tokens
|
| 542 |
+
that can cause denial of service, in partial where
|
| 543 |
+
dealing with compressed XML input. Applications
|
| 544 |
+
that parsed a document in one go -- a single call to
|
| 545 |
+
functions XML_Parse or XML_ParseBuffer -- were not affected.
|
| 546 |
+
The smaller the chunks/buffers you use for parsing
|
| 547 |
+
previously, the bigger the problem prior to the fix.
|
| 548 |
+
Backporters should be careful to no omit parts of
|
| 549 |
+
pull request #789 and to include earlier pull request #771,
|
| 550 |
+
in order to not break the fix.
|
| 551 |
+
#777 CVE-2023-52426 -- Fix billion laughs attacks for users
|
| 552 |
+
compiling *without* XML_DTD defined (which is not common).
|
| 553 |
+
Users with XML_DTD defined have been protected since
|
| 554 |
+
Expat >=2.4.0 (and that was CVE-2013-0340 back then).
|
| 555 |
+
|
| 556 |
+
Bug fixes:
|
| 557 |
+
#753 Fix parse-size-dependent "invalid token" error for
|
| 558 |
+
external entities that start with a byte order mark
|
| 559 |
+
#780 Fix NULL pointer dereference in setContext via
|
| 560 |
+
XML_ExternalEntityParserCreate for compilation with
|
| 561 |
+
XML_DTD undefined
|
| 562 |
+
#812 #813 Protect against closing entities out of order
|
| 563 |
+
|
| 564 |
+
Other changes:
|
| 565 |
+
#723 Improve support for arc4random/arc4random_buf
|
| 566 |
+
#771 #788 Improve buffer growth in XML_GetBuffer and XML_Parse
|
| 567 |
+
#761 #770 xmlwf: Support --help and --version
|
| 568 |
+
#759 #770 xmlwf: Support custom buffer size for XML_GetBuffer and read
|
| 569 |
+
#744 xmlwf: Improve language and URL clickability in help output
|
| 570 |
+
#673 examples: Add new example "element_declarations.c"
|
| 571 |
+
#764 Be stricter about macro XML_CONTEXT_BYTES at build time
|
| 572 |
+
#765 Make inclusion to expat_config.h consistent
|
| 573 |
+
#726 #727 Autotools: configure.ac: Support --disable-maintainer-mode
|
| 574 |
+
#678 #705 ..
|
| 575 |
+
#706 #733 #792 Autotools: Sync CMake templates with CMake 3.26
|
| 576 |
+
#795 Autotools: Make installation of shipped man page doc/xmlwf.1
|
| 577 |
+
independent of docbook2man availability
|
| 578 |
+
#815 Autotools|CMake: Add missing -DXML_STATIC to pkg-config file
|
| 579 |
+
section "Cflags.private" in order to fix compilation
|
| 580 |
+
against static libexpat using pkg-config on Windows
|
| 581 |
+
#724 #751 Autotools|CMake: Require a C99 compiler
|
| 582 |
+
(a de-facto requirement already since Expat 2.2.2 of 2017)
|
| 583 |
+
#793 Autotools|CMake: Fix PACKAGE_BUGREPORT variable
|
| 584 |
+
#750 #786 Autotools|CMake: Make test suite require a C++11 compiler
|
| 585 |
+
#749 CMake: Require CMake >=3.5.0
|
| 586 |
+
#672 CMake: Lowercase off_t and size_t to help a bug in Meson
|
| 587 |
+
#746 CMake: Sort xmlwf sources alphabetically
|
| 588 |
+
#785 CMake|Windows: Fix generation of DLL file version info
|
| 589 |
+
#790 CMake: Build tests/benchmark/benchmark.c as well for
|
| 590 |
+
a build with -DEXPAT_BUILD_TESTS=ON
|
| 591 |
+
#745 #757 docs: Document the importance of isFinal + adjust tests
|
| 592 |
+
accordingly
|
| 593 |
+
#736 docs: Improve use of "NULL" and "null"
|
| 594 |
+
#713 docs: Be specific about version of XML (XML 1.0r4)
|
| 595 |
+
and version of C (C99); (XML 1.0r5 will need a sponsor.)
|
| 596 |
+
#762 docs: reference.html: Promote function XML_ParseBuffer more
|
| 597 |
+
#779 docs: reference.html: Add HTML anchors to XML_* macros
|
| 598 |
+
#760 docs: reference.html: Upgrade to OK.css 1.2.0
|
| 599 |
+
#763 #739 docs: Fix typos
|
| 600 |
+
#696 docs|CI: Use HTTPS URLs instead of HTTP at various places
|
| 601 |
+
#669 #670 ..
|
| 602 |
+
#692 #703 ..
|
| 603 |
+
#733 #772 Address compiler warnings
|
| 604 |
+
#798 #800 Address clang-tidy warnings
|
| 605 |
+
#775 #776 Version info bumped from 9:10:8 (libexpat*.so.1.8.10)
|
| 606 |
+
to 10:0:9 (libexpat*.so.1.9.0); see https://verbump.de/
|
| 607 |
+
for what these numbers do
|
| 608 |
+
|
| 609 |
+
Infrastructure:
|
| 610 |
+
#700 #701 docs: Document security policy in file SECURITY.md
|
| 611 |
+
#766 docs: Improve parse buffer variables in-code documentation
|
| 612 |
+
#674 #738 ..
|
| 613 |
+
#740 #747 ..
|
| 614 |
+
#748 #781 #782 Refactor coverage and conformance tests
|
| 615 |
+
#714 #716 Refactor debug level variables to unsigned long
|
| 616 |
+
#671 Improve handling of empty environment variable value
|
| 617 |
+
in function getDebugLevel (without visible user effect)
|
| 618 |
+
#755 #774 ..
|
| 619 |
+
#758 #783 ..
|
| 620 |
+
#784 #787 tests: Improve test coverage with regard to parse chunk size
|
| 621 |
+
#660 #797 #801 Fuzzing: Improve fuzzing coverage
|
| 622 |
+
#367 #799 Fuzzing|CI: Start running OSS-Fuzz fuzzing regression tests
|
| 623 |
+
#698 #721 CI: Resolve some Travis CI leftovers
|
| 624 |
+
#669 CI: Be robust towards absence of Git tags
|
| 625 |
+
#693 #694 CI: Set permissions to "contents: read" for security
|
| 626 |
+
#709 CI: Pin all GitHub Actions to specific commits for security
|
| 627 |
+
#739 CI: Reject spelling errors using codespell
|
| 628 |
+
#798 CI: Enforce clang-tidy clean code
|
| 629 |
+
#773 #808 ..
|
| 630 |
+
#809 #810 CI: Upgrade Clang from 15 to 18
|
| 631 |
+
#796 CI: Start using Clang's Control Flow Integrity sanitizer
|
| 632 |
+
#675 #720 #722 CI: Adapt to breaking changes in GitHub Actions Ubuntu images
|
| 633 |
+
#689 CI: Adapt to breaking changes in Clang/LLVM Debian packaging
|
| 634 |
+
#763 CI: Adapt to breaking changes in codespell
|
| 635 |
+
#803 CI: Adapt to breaking changes in Cppcheck
|
| 636 |
+
|
| 637 |
+
Special thanks to:
|
| 638 |
+
Ivan Galkin
|
| 639 |
+
Joyce Brum
|
| 640 |
+
Philippe Antoine
|
| 641 |
+
Rhodri James
|
| 642 |
+
Snild Dolkow
|
| 643 |
+
spookyahell
|
| 644 |
+
Steven Garske
|
| 645 |
+
and
|
| 646 |
+
Clang AddressSanitizer
|
| 647 |
+
Clang UndefinedBehaviorSanitizer
|
| 648 |
+
codespell
|
| 649 |
+
GCC Farm Project
|
| 650 |
+
OSS-Fuzz
|
| 651 |
+
Sony Mobile
|
| 652 |
+
|
| 653 |
+
Release 2.5.0 Tue October 25 2022
|
| 654 |
+
Security fixes:
|
| 655 |
+
#616 #649 #650 CVE-2022-43680 -- Fix heap use-after-free after overeager
|
| 656 |
+
destruction of a shared DTD in function
|
| 657 |
+
XML_ExternalEntityParserCreate in out-of-memory situations.
|
| 658 |
+
Expected impact is denial of service or potentially
|
| 659 |
+
arbitrary code execution.
|
| 660 |
+
|
| 661 |
+
Bug fixes:
|
| 662 |
+
#612 #645 Fix corruption from undefined entities
|
| 663 |
+
#613 #654 Fix case when parsing was suspended while processing nested
|
| 664 |
+
entities
|
| 665 |
+
#616 #652 #653 Stop leaking opening tag bindings after a closing tag
|
| 666 |
+
mismatch error where a parser is reset through
|
| 667 |
+
XML_ParserReset and then reused to parse
|
| 668 |
+
#656 CMake: Fix generation of pkg-config file
|
| 669 |
+
#658 MinGW|CMake: Fix static library name
|
| 670 |
+
|
| 671 |
+
Other changes:
|
| 672 |
+
#663 Protect header expat_config.h from multiple inclusion
|
| 673 |
+
#666 examples: Make use of XML_GetBuffer and be more
|
| 674 |
+
consistent across examples
|
| 675 |
+
#648 Address compiler warnings
|
| 676 |
+
#667 #668 Version info bumped from 9:9:8 to 9:10:8;
|
| 677 |
+
see https://verbump.de/ for what these numbers do
|
| 678 |
+
|
| 679 |
+
Special thanks to:
|
| 680 |
+
Jann Horn
|
| 681 |
+
Mark Brand
|
| 682 |
+
Osyotr
|
| 683 |
+
Rhodri James
|
| 684 |
+
and
|
| 685 |
+
Google Project Zero
|
| 686 |
+
|
| 687 |
+
Release 2.4.9 Tue September 20 2022
|
| 688 |
+
Security fixes:
|
| 689 |
+
#629 #640 CVE-2022-40674 -- Heap use-after-free vulnerability in
|
| 690 |
+
function doContent. Expected impact is denial of service
|
| 691 |
+
or potentially arbitrary code execution.
|
| 692 |
+
|
| 693 |
+
Bug fixes:
|
| 694 |
+
#634 MinGW: Fix mis-compilation for -D__USE_MINGW_ANSI_STDIO=0
|
| 695 |
+
#614 docs: Fix documentation on effect of switch XML_DTD on
|
| 696 |
+
symbol visibility in doc/reference.html
|
| 697 |
+
|
| 698 |
+
Other changes:
|
| 699 |
+
#638 MinGW: Make fix-xmltest-log.sh drop more Wine bug output
|
| 700 |
+
#596 #625 Autotools: Sync CMake templates with CMake 3.22
|
| 701 |
+
#608 CMake: Migrate from use of CMAKE_*_POSTFIX to
|
| 702 |
+
dedicated variables EXPAT_*_POSTFIX to stop affecting
|
| 703 |
+
other projects
|
| 704 |
+
#597 #599 Windows|CMake: Add missing -DXML_STATIC to test runners
|
| 705 |
+
and fuzzers
|
| 706 |
+
#512 #621 Windows|CMake: Render .def file from a template to fix
|
| 707 |
+
linking with -DEXPAT_DTD=OFF and/or -DEXPAT_ATTR_INFO=ON
|
| 708 |
+
#611 #621 MinGW|CMake: Apply MSVC .def file when linking
|
| 709 |
+
#622 #624 MinGW|CMake: Sync library name with GNU Autotools,
|
| 710 |
+
i.e. produce libexpat-1.dll rather than libexpat.dll
|
| 711 |
+
by default. Filename libexpat.dll.a is unaffected.
|
| 712 |
+
#632 MinGW|CMake: Set missing variable CMAKE_RC_COMPILER in
|
| 713 |
+
toolchain file "cmake/mingw-toolchain.cmake" to avoid
|
| 714 |
+
error "windres: Command not found" on e.g. Ubuntu 20.04
|
| 715 |
+
#597 #627 CMake: Unify inconsistent use of set() and option() in
|
| 716 |
+
context of public build time options to take need for
|
| 717 |
+
set(.. FORCE) in projects using Expat by means of
|
| 718 |
+
add_subdirectory(..) off Expat's users' shoulders
|
| 719 |
+
#626 #641 Stop exporting API symbols when building a static library
|
| 720 |
+
#644 Resolve use of deprecated "fgrep" by "grep -F"
|
| 721 |
+
#620 CMake: Make documentation on variables a bit more consistent
|
| 722 |
+
#636 CMake: Drop leading whitespace from a #cmakedefine line in
|
| 723 |
+
file expat_config.h.cmake
|
| 724 |
+
#594 xmlwf: Fix harmless variable mix-up in function nsattcmp
|
| 725 |
+
#592 #593 #610 Address Cppcheck warnings
|
| 726 |
+
#643 Address Clang 15 compiler warnings
|
| 727 |
+
#642 #644 Version info bumped from 9:8:8 to 9:9:8;
|
| 728 |
+
see https://verbump.de/ for what these numbers do
|
| 729 |
+
|
| 730 |
+
Infrastructure:
|
| 731 |
+
#597 #598 CI: Windows: Start covering MSVC 2022
|
| 732 |
+
#619 CI: macOS: Migrate off deprecated macOS 10.15
|
| 733 |
+
#632 CI: Linux: Make migration off deprecated Ubuntu 18.04 work
|
| 734 |
+
#643 CI: Upgrade Clang from 14 to 15
|
| 735 |
+
#637 apply-clang-format.sh: Add support for BSD find
|
| 736 |
+
#633 coverage.sh: Exclude MinGW headers
|
| 737 |
+
#635 coverage.sh: Fix name collision for -funsigned-char
|
| 738 |
+
|
| 739 |
+
Special thanks to:
|
| 740 |
+
David Faure
|
| 741 |
+
Felix Wilhelm
|
| 742 |
+
Frank Bergmann
|
| 743 |
+
Rhodri James
|
| 744 |
+
Rosen Penev
|
| 745 |
+
Thijs Schreijer
|
| 746 |
+
Vincent Torri
|
| 747 |
+
and
|
| 748 |
+
Google Project Zero
|
| 749 |
+
|
| 750 |
+
Release 2.4.8 Mon March 28 2022
|
| 751 |
+
Other changes:
|
| 752 |
+
#587 pkg-config: Move "-lm" to section "Libs.private"
|
| 753 |
+
#587 CMake|MSVC: Fix pkg-config section "Libs"
|
| 754 |
+
#55 #582 CMake|macOS: Start using linker arguments
|
| 755 |
+
"-compatibility_version <version>" and
|
| 756 |
+
"-current_version <version>" in a way compatible with
|
| 757 |
+
GNU Libtool
|
| 758 |
+
#590 #591 Version info bumped from 9:7:8 to 9:8:8;
|
| 759 |
+
see https://verbump.de/ for what these numbers do
|
| 760 |
+
|
| 761 |
+
Infrastructure:
|
| 762 |
+
#589 CI: Upgrade Clang from 13 to 14
|
| 763 |
+
|
| 764 |
+
Special thanks to:
|
| 765 |
+
evpobr
|
| 766 |
+
Kai Pastor
|
| 767 |
+
Sam James
|
| 768 |
+
|
| 769 |
+
Release 2.4.7 Fri March 4 2022
|
| 770 |
+
Bug fixes:
|
| 771 |
+
#572 #577 Relax fix to CVE-2022-25236 (introduced with release 2.4.5)
|
| 772 |
+
with regard to all valid URI characters (RFC 3986),
|
| 773 |
+
i.e. the following set (excluding whitespace):
|
| 774 |
+
ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz
|
| 775 |
+
0123456789 % -._~ :/?#[]@ !$&'()*+,;=
|
| 776 |
+
|
| 777 |
+
Other changes:
|
| 778 |
+
#555 #570 #581 CMake|Windows: Store Expat version in the DLL
|
| 779 |
+
#577 Document consequences of namespace separator choices not just
|
| 780 |
+
in doc/reference.html but also in header <expat.h>
|
| 781 |
+
#577 Document Expat's lack of validation of namespace URIs against
|
| 782 |
+
RFC 3986, and that the XML 1.0r4 specification doesn't
|
| 783 |
+
require Expat to validate namespace URIs, and that Expat
|
| 784 |
+
may do more in that regard in future releases.
|
| 785 |
+
If you find need for strict RFC 3986 URI validation on
|
| 786 |
+
application level today, https://uriparser.github.io/ may
|
| 787 |
+
be of interest.
|
| 788 |
+
#579 Fix documentation of XML_EndDoctypeDeclHandler in <expat.h>
|
| 789 |
+
#575 Document that a call to XML_FreeContentModel can be done at
|
| 790 |
+
a later time from outside the element declaration handler
|
| 791 |
+
#574 Make hardcoded namespace URIs easier to find in code
|
| 792 |
+
#573 Update documentation on use of XML_POOR_ENTOPY on Solaris
|
| 793 |
+
#569 #571 tests: Resolve use of macros NAN and INFINITY for GNU G++
|
| 794 |
+
4.8.2 on Solaris.
|
| 795 |
+
#578 #580 Version info bumped from 9:6:8 to 9:7:8;
|
| 796 |
+
see https://verbump.de/ for what these numbers do
|
| 797 |
+
|
| 798 |
+
Special thanks to:
|
| 799 |
+
Jeffrey Walton
|
| 800 |
+
Johnny Jazeix
|
| 801 |
+
Thijs Schreijer
|
| 802 |
+
|
| 803 |
+
Release 2.4.6 Sun February 20 2022
|
| 804 |
+
Bug fixes:
|
| 805 |
+
#566 Fix a regression introduced by the fix for CVE-2022-25313
|
| 806 |
+
in release 2.4.5 that affects applications that (1)
|
| 807 |
+
call function XML_SetElementDeclHandler and (2) are
|
| 808 |
+
parsing XML that contains nested element declarations
|
| 809 |
+
(e.g. "<!ELEMENT junk ((bar|foo|xyz+), zebra*)>").
|
| 810 |
+
|
| 811 |
+
Other changes:
|
| 812 |
+
#567 #568 Version info bumped from 9:5:8 to 9:6:8;
|
| 813 |
+
see https://verbump.de/ for what these numbers do
|
| 814 |
+
|
| 815 |
+
Special thanks to:
|
| 816 |
+
Matt Sergeant
|
| 817 |
+
Samanta Navarro
|
| 818 |
+
Sergei Trofimovich
|
| 819 |
+
and
|
| 820 |
+
NixOS
|
| 821 |
+
Perl XML::Parser
|
| 822 |
+
|
| 823 |
+
Release 2.4.5 Fri February 18 2022
|
| 824 |
+
Security fixes:
|
| 825 |
+
#562 CVE-2022-25235 -- Passing malformed 2- and 3-byte UTF-8
|
| 826 |
+
sequences (e.g. from start tag names) to the XML
|
| 827 |
+
processing application on top of Expat can cause
|
| 828 |
+
arbitrary damage (e.g. code execution) depending
|
| 829 |
+
on how invalid UTF-8 is handled inside the XML
|
| 830 |
+
processor; validation was not their job but Expat's.
|
| 831 |
+
Exploits with code execution are known to exist.
|
| 832 |
+
#561 CVE-2022-25236 -- Passing (one or more) namespace separator
|
| 833 |
+
characters in "xmlns[:prefix]" attribute values
|
| 834 |
+
made Expat send malformed tag names to the XML
|
| 835 |
+
processor on top of Expat which can cause
|
| 836 |
+
arbitrary damage (e.g. code execution) depending
|
| 837 |
+
on such unexpectable cases are handled inside the XML
|
| 838 |
+
processor; validation was not their job but Expat's.
|
| 839 |
+
Exploits with code execution are known to exist.
|
| 840 |
+
#558 CVE-2022-25313 -- Fix stack exhaustion in doctype parsing
|
| 841 |
+
that could be triggered by e.g. a 2 megabytes
|
| 842 |
+
file with a large number of opening braces.
|
| 843 |
+
Expected impact is denial of service or potentially
|
| 844 |
+
arbitrary code execution.
|
| 845 |
+
#560 CVE-2022-25314 -- Fix integer overflow in function copyString;
|
| 846 |
+
only affects the encoding name parameter at parser creation
|
| 847 |
+
time which is often hardcoded (rather than user input),
|
| 848 |
+
takes a value in the gigabytes to trigger, and a 64-bit
|
| 849 |
+
machine. Expected impact is denial of service.
|
| 850 |
+
#559 CVE-2022-25315 -- Fix integer overflow in function storeRawNames;
|
| 851 |
+
needs input in the gigabytes and a 64-bit machine.
|
| 852 |
+
Expected impact is denial of service or potentially
|
| 853 |
+
arbitrary code execution.
|
| 854 |
+
|
| 855 |
+
Other changes:
|
| 856 |
+
#557 #564 Version info bumped from 9:4:8 to 9:5:8;
|
| 857 |
+
see https://verbump.de/ for what these numbers do
|
| 858 |
+
|
| 859 |
+
Special thanks to:
|
| 860 |
+
Ivan Fratric
|
| 861 |
+
Samanta Navarro
|
| 862 |
+
and
|
| 863 |
+
Google Project Zero
|
| 864 |
+
JetBrains
|
| 865 |
+
|
| 866 |
+
Release 2.4.4 Sun January 30 2022
|
| 867 |
+
Security fixes:
|
| 868 |
+
#550 CVE-2022-23852 -- Fix signed integer overflow
|
| 869 |
+
(undefined behavior) in function XML_GetBuffer
|
| 870 |
+
(that is also called by function XML_Parse internally)
|
| 871 |
+
for when XML_CONTEXT_BYTES is defined to >0 (which is both
|
| 872 |
+
common and default).
|
| 873 |
+
Impact is denial of service or more.
|
| 874 |
+
#551 CVE-2022-23990 -- Fix unsigned integer overflow in function
|
| 875 |
+
doProlog triggered by large content in element type
|
| 876 |
+
declarations when there is an element declaration handler
|
| 877 |
+
present (from a prior call to XML_SetElementDeclHandler).
|
| 878 |
+
Impact is denial of service or more.
|
| 879 |
+
|
| 880 |
+
Bug fixes:
|
| 881 |
+
#544 #545 xmlwf: Fix a memory leak on output file opening error
|
| 882 |
+
|
| 883 |
+
Other changes:
|
| 884 |
+
#546 Autotools: Fix broken CMake support under Cygwin
|
| 885 |
+
#554 Windows: Add missing files to the installer to fix
|
| 886 |
+
compilation with CMake from installed sources
|
| 887 |
+
#552 #554 Version info bumped from 9:3:8 to 9:4:8;
|
| 888 |
+
see https://verbump.de/ for what these numbers do
|
| 889 |
+
|
| 890 |
+
Special thanks to:
|
| 891 |
+
Carlo Bramini
|
| 892 |
+
hwt0415
|
| 893 |
+
Roland Illig
|
| 894 |
+
Samanta Navarro
|
| 895 |
+
and
|
| 896 |
+
Clang LeakSan and the Clang team
|
| 897 |
+
|
| 898 |
+
Release 2.4.3 Sun January 16 2022
|
| 899 |
+
Security fixes:
|
| 900 |
+
#531 #534 CVE-2021-45960 -- Fix issues with left shifts by >=29 places
|
| 901 |
+
resulting in
|
| 902 |
+
a) realloc acting as free
|
| 903 |
+
b) realloc allocating too few bytes
|
| 904 |
+
c) undefined behavior
|
| 905 |
+
depending on architecture and precise value
|
| 906 |
+
for XML documents with >=2^27+1 prefixed attributes
|
| 907 |
+
on a single XML tag a la
|
| 908 |
+
"<r xmlns:a='[..]' a:a123='[..]' [..] />"
|
| 909 |
+
where XML_ParserCreateNS is used to create the parser
|
| 910 |
+
(which needs argument "-n" when running xmlwf).
|
| 911 |
+
Impact is denial of service, or more.
|
| 912 |
+
#532 #538 CVE-2021-46143 (ZDI-CAN-16157) -- Fix integer overflow
|
| 913 |
+
on variable m_groupSize in function doProlog leading
|
| 914 |
+
to realloc acting as free.
|
| 915 |
+
Impact is denial of service or more.
|
| 916 |
+
#539 CVE-2022-22822 to CVE-2022-22827 -- Prevent integer overflows
|
| 917 |
+
near memory allocation at multiple places. Mitre assigned
|
| 918 |
+
a dedicated CVE for each involved internal C function:
|
| 919 |
+
- CVE-2022-22822 for function addBinding
|
| 920 |
+
- CVE-2022-22823 for function build_model
|
| 921 |
+
- CVE-2022-22824 for function defineAttribute
|
| 922 |
+
- CVE-2022-22825 for function lookup
|
| 923 |
+
- CVE-2022-22826 for function nextScaffoldPart
|
| 924 |
+
- CVE-2022-22827 for function storeAtts
|
| 925 |
+
Impact is denial of service or more.
|
| 926 |
+
|
| 927 |
+
Other changes:
|
| 928 |
+
#535 CMake: Make call to file(GENERATE [..]) work for CMake <3.19
|
| 929 |
+
#541 Autotools|CMake: MinGW: Make run.sh(.in) work for Cygwin
|
| 930 |
+
and MSYS2 by not going through Wine on these platforms
|
| 931 |
+
#527 #528 Address compiler warnings
|
| 932 |
+
#533 #543 Version info bumped from 9:2:8 to 9:3:8;
|
| 933 |
+
see https://verbump.de/ for what these numbers do
|
| 934 |
+
|
| 935 |
+
Infrastructure:
|
| 936 |
+
#536 CI: Check for realistic minimum CMake version
|
| 937 |
+
#529 #539 CI: Cover compilation with -m32
|
| 938 |
+
#529 CI: Store coverage reports as artifacts for download
|
| 939 |
+
#528 CI: Upgrade Clang from 11 to 13
|
| 940 |
+
|
| 941 |
+
Special thanks to:
|
| 942 |
+
An anonymous whitehat
|
| 943 |
+
Christopher Degawa
|
| 944 |
+
J. Peter Mugaas
|
| 945 |
+
Tyson Smith
|
| 946 |
+
and
|
| 947 |
+
GCC Farm Project
|
| 948 |
+
Trend Micro Zero Day Initiative
|
| 949 |
+
|
| 950 |
+
Release 2.4.2 Sun December 19 2021
|
| 951 |
+
Other changes:
|
| 952 |
+
#509 #510 Link againgst libm for function "isnan"
|
| 953 |
+
#513 #514 Include expat_config.h as early as possible
|
| 954 |
+
#498 Autotools: Include files with release archives:
|
| 955 |
+
- buildconf.sh
|
| 956 |
+
- fuzz/*.c
|
| 957 |
+
#507 #519 Autotools: Sync CMake templates with CMake 3.20
|
| 958 |
+
#495 #524 CMake: MinGW: Fix pkg-config section "Libs" for
|
| 959 |
+
- non-release build types (e.g. -DCMAKE_BUILD_TYPE=Debug)
|
| 960 |
+
- multi-config CMake generators (e.g. Ninja Multi-Config)
|
| 961 |
+
#502 #503 docs: Document that function XML_GetBuffer may return NULL
|
| 962 |
+
when asking for a buffer of 0 (zero) bytes size
|
| 963 |
+
#522 #523 docs: Fix return value docs for both
|
| 964 |
+
XML_SetBillionLaughsAttackProtection* functions
|
| 965 |
+
#525 #526 Version info bumped from 9:1:8 to 9:2:8;
|
| 966 |
+
see https://verbump.de/ for what these numbers do
|
| 967 |
+
|
| 968 |
+
Special thanks to:
|
| 969 |
+
Donghee Na
|
| 970 |
+
Joergen Ibsen
|
| 971 |
+
Kai Pastor
|
| 972 |
+
|
| 973 |
+
Release 2.4.1 Sun May 23 2021
|
| 974 |
+
Bug fixes:
|
| 975 |
+
#488 #490 Autotools: Fix installed header expat_config.h for multilib
|
| 976 |
+
systems; regression introduced in 2.4.0 by pull request #486
|
| 977 |
+
|
| 978 |
+
Other changes:
|
| 979 |
+
#491 #492 Version info bumped from 9:0:8 to 9:1:8;
|
| 980 |
+
see https://verbump.de/ for what these numbers do
|
| 981 |
+
|
| 982 |
+
Special thanks to:
|
| 983 |
+
Gentoo's QA check "multilib_check_headers"
|
| 984 |
+
|
| 985 |
+
Release 2.4.0 Sun May 23 2021
|
| 986 |
+
Security fixes:
|
| 987 |
+
#34 #466 #484 CVE-2013-0340/CWE-776 -- Protect against billion laughs attacks
|
| 988 |
+
(denial-of-service; flavors targeting CPU time or RAM or both,
|
| 989 |
+
leveraging general entities or parameter entities or both)
|
| 990 |
+
by tracking and limiting the input amplification factor
|
| 991 |
+
(<amplification> := (<direct> + <indirect>) / <direct>).
|
| 992 |
+
By conservative default, amplification up to a factor of 100.0
|
| 993 |
+
is tolerated and rejection only starts after 8 MiB of output bytes
|
| 994 |
+
(=<direct> + <indirect>) have been processed.
|
| 995 |
+
The fix adds the following to the API:
|
| 996 |
+
- A new error code XML_ERROR_AMPLIFICATION_LIMIT_BREACH to
|
| 997 |
+
signals this specific condition.
|
| 998 |
+
- Two new API functions ..
|
| 999 |
+
- XML_SetBillionLaughsAttackProtectionMaximumAmplification and
|
| 1000 |
+
- XML_SetBillionLaughsAttackProtectionActivationThreshold
|
| 1001 |
+
.. to further tighten billion laughs protection parameters
|
| 1002 |
+
when desired. Please see file "doc/reference.html" for details.
|
| 1003 |
+
If you ever need to increase the defaults for non-attack XML
|
| 1004 |
+
payload, please file a bug report with libexpat.
|
| 1005 |
+
- Two new XML_FEATURE_* constants ..
|
| 1006 |
+
- that can be queried using the XML_GetFeatureList function, and
|
| 1007 |
+
- that are shown in "xmlwf -v" output.
|
| 1008 |
+
- Two new environment variable switches ..
|
| 1009 |
+
- EXPAT_ACCOUNTING_DEBUG=(0|1|2|3) and
|
| 1010 |
+
- EXPAT_ENTITY_DEBUG=(0|1)
|
| 1011 |
+
.. for runtime debugging of accounting and entity processing.
|
| 1012 |
+
Specific behavior of these values may change in the future.
|
| 1013 |
+
- Two new command line arguments "-a FACTOR" and "-b BYTES"
|
| 1014 |
+
for xmlwf to further tighten billion laughs protection
|
| 1015 |
+
parameters when desired.
|
| 1016 |
+
If you ever need to increase the defaults for non-attack XML
|
| 1017 |
+
payload, please file a bug report with libexpat.
|
| 1018 |
+
|
| 1019 |
+
Bug fixes:
|
| 1020 |
+
#332 #470 For (non-default) compilation with -DEXPAT_MIN_SIZE=ON (CMake)
|
| 1021 |
+
or CPPFLAGS=-DXML_MIN_SIZE (GNU Autotools): Fix segfault
|
| 1022 |
+
for UTF-16 payloads containing CDATA sections.
|
| 1023 |
+
#485 #486 Autotools: Fix generated CMake files for non-64bit and
|
| 1024 |
+
non-Linux platforms (e.g. macOS and MinGW in particular)
|
| 1025 |
+
that were introduced with release 2.3.0
|
| 1026 |
+
|
| 1027 |
+
Other changes:
|
| 1028 |
+
#468 #469 xmlwf: Improve help output and the xmlwf man page
|
| 1029 |
+
#463 xmlwf: Improve maintainability through some refactoring
|
| 1030 |
+
#477 xmlwf: Fix man page DocBook validity
|
| 1031 |
+
#456 Autotools: Sync CMake templates with CMake 3.18
|
| 1032 |
+
#458 #459 CMake: Support absolute paths for both CMAKE_INSTALL_LIBDIR
|
| 1033 |
+
and CMAKE_INSTALL_INCLUDEDIR
|
| 1034 |
+
#471 #481 CMake: Add support for standard variable BUILD_SHARED_LIBS
|
| 1035 |
+
#457 Unexpose symbol _INTERNAL_trim_to_complete_utf8_characters
|
| 1036 |
+
#467 Resolve macro HAVE_EXPAT_CONFIG_H
|
| 1037 |
+
#472 Delete unused legacy helper file "conftools/PrintPath"
|
| 1038 |
+
#473 #483 Improve attribution
|
| 1039 |
+
#464 #465 #477 doc/reference.html: Fix XHTML validity
|
| 1040 |
+
#475 #478 doc/reference.html: Replace the 90s look by OK.css
|
| 1041 |
+
#479 Version info bumped from 8:0:7 to 9:0:8
|
| 1042 |
+
due to addition of new symbols and error codes;
|
| 1043 |
+
see https://verbump.de/ for what these numbers do
|
| 1044 |
+
|
| 1045 |
+
Infrastructure:
|
| 1046 |
+
#456 CI: Enable periodic runs
|
| 1047 |
+
#457 CI: Start covering the list of exported symbols
|
| 1048 |
+
#474 CI: Isolate coverage task
|
| 1049 |
+
#476 #482 CI: Adapt to breaking changes in image "ubuntu-18.04"
|
| 1050 |
+
#477 CI: Cover well-formedness and DocBook/XHTML validity
|
| 1051 |
+
of doc/reference.html and doc/xmlwf.xml
|
| 1052 |
+
|
| 1053 |
+
Special thanks to:
|
| 1054 |
+
Dimitry Andric
|
| 1055 |
+
Eero Helenius
|
| 1056 |
+
Nick Wellnhofer
|
| 1057 |
+
Rhodri James
|
| 1058 |
+
Tomas Korbar
|
| 1059 |
+
Yury Gribov
|
| 1060 |
+
and
|
| 1061 |
+
Clang LeakSan
|
| 1062 |
+
JetBrains
|
| 1063 |
+
OSS-Fuzz
|
| 1064 |
+
|
| 1065 |
+
Release 2.3.0 Thu March 25 2021
|
| 1066 |
+
Bug fixes:
|
| 1067 |
+
#438 When calling XML_ParseBuffer without a prior successful call to
|
| 1068 |
+
XML_GetBuffer as a user, no longer trigger undefined behavior
|
| 1069 |
+
(by adding an integer to a NULL pointer) but rather return
|
| 1070 |
+
XML_STATUS_ERROR and set the error code to (new) code
|
| 1071 |
+
XML_ERROR_NO_BUFFER. Found by UBSan (UndefinedBehaviorSanitizer)
|
| 1072 |
+
of Clang 11 (but not Clang 9).
|
| 1073 |
+
#444 xmlwf: Exit status 2 was used for both:
|
| 1074 |
+
- malformed input files (documented) and
|
| 1075 |
+
- invalid command-line arguments (undocumented).
|
| 1076 |
+
The case of invalid command-line arguments now
|
| 1077 |
+
has its own exit status 4, resolving the ambiguity.
|
| 1078 |
+
|
| 1079 |
+
Other changes:
|
| 1080 |
+
#439 xmlwf: Add argument -k to allow continuing after
|
| 1081 |
+
non-fatal errors
|
| 1082 |
+
#439 xmlwf: Add section about exit status to the -h help output
|
| 1083 |
+
#422 #426 #447 Windows: Drop support for Visual Studio <=14.0/2015
|
| 1084 |
+
#434 Windows: CMake: Detect unsupported Visual Studio at
|
| 1085 |
+
configure time (rather than at compile time)
|
| 1086 |
+
#382 #428 testrunner: Make verbose mode (argument "-v") report
|
| 1087 |
+
about passed tests, and make default mode report about
|
| 1088 |
+
failures, as well.
|
| 1089 |
+
#442 CMake: Call "enable_language(CXX)" prior to tinkering
|
| 1090 |
+
with CMAKE_CXX_* variables
|
| 1091 |
+
#448 Document use of libexpat from a CMake-based project
|
| 1092 |
+
#451 Autotools: Install CMake files as generated by CMake 3.19.6
|
| 1093 |
+
so that users with "find_package(expat [..] CONFIG [..])"
|
| 1094 |
+
are served on distributions that are *not* using the CMake
|
| 1095 |
+
build system inside for libexpat packaging
|
| 1096 |
+
#436 #437 Autotools: Drop obsolescent macro AC_HEADER_STDC
|
| 1097 |
+
#450 #452 Autotools: Resolve use of obsolete macro AC_CONFIG_HEADER
|
| 1098 |
+
#441 Address compiler warnings
|
| 1099 |
+
#443 Version info bumped from 7:12:6 to 8:0:7
|
| 1100 |
+
due to addition of error code XML_ERROR_NO_BUFFER
|
| 1101 |
+
(see https://verbump.de/ for what these numbers do)
|
| 1102 |
+
|
| 1103 |
+
Infrastructure:
|
| 1104 |
+
#435 #446 Replace Travis CI by GitHub Actions
|
| 1105 |
+
|
| 1106 |
+
Special thanks to:
|
| 1107 |
+
Alexander Richardson
|
| 1108 |
+
Oleksandr Popovych
|
| 1109 |
+
Thomas Beutlich
|
| 1110 |
+
Tim Bray
|
| 1111 |
+
and
|
| 1112 |
+
Clang LeakSan, Clang 11 UBSan and the Clang team
|
| 1113 |
+
|
| 1114 |
+
Release 2.2.10 Sat October 3 2020
|
| 1115 |
+
Bug fixes:
|
| 1116 |
+
#390 #395 #398 Fix undefined behavior during parsing caused by
|
| 1117 |
+
pointer arithmetic with NULL pointers
|
| 1118 |
+
#404 #405 Fix reading uninitialized variable during parsing
|
| 1119 |
+
#406 xmlwf: Add missing check for malloc NULL return
|
| 1120 |
+
|
| 1121 |
+
Other changes:
|
| 1122 |
+
#396 Windows: Drop support for Visual Studio <=8.0/2005
|
| 1123 |
+
#409 Windows: Add missing file "Changes" to the installer
|
| 1124 |
+
to fix compilation with CMake from installed sources
|
| 1125 |
+
#403 xmlwf: Document exit codes in xmlwf manpage and
|
| 1126 |
+
exit with code 3 (rather than code 1) for output errors
|
| 1127 |
+
when used with "-d DIRECTORY"
|
| 1128 |
+
#356 #359 MinGW: Provide declaration of rand_s for mingwrt <5.3.0
|
| 1129 |
+
#383 #392 Autotools: Use -Werror while configure tests the compiler
|
| 1130 |
+
for supported compile flags to avoid false positives
|
| 1131 |
+
#383 #393 #394 Autotools: Improve handling of user (C|CPP|CXX|LD)FLAGS,
|
| 1132 |
+
e.g. ensure that they have the last word over flags added
|
| 1133 |
+
while running ./configure
|
| 1134 |
+
#360 CMake: Create libexpatw.{dll,so} and expatw.pc (with emphasis
|
| 1135 |
+
on suffix "w") with -DEXPAT_CHAR_TYPE=(ushort|wchar_t)
|
| 1136 |
+
#360 CMake: Detect and deny unsupported build combinations
|
| 1137 |
+
involving -DEXPAT_CHAR_TYPE=(ushort|wchar_t)
|
| 1138 |
+
#360 CMake: Install pre-compiled shipped xmlwf.1 manpage in case
|
| 1139 |
+
of -DEXPAT_BUILD_DOCS=OFF
|
| 1140 |
+
#375 #380 #419 CMake: Fix use of Expat by means of add_subdirectory
|
| 1141 |
+
#407 #408 CMake: Keep expat target name constant at "expat"
|
| 1142 |
+
(i.e. refrain from using the target name to control
|
| 1143 |
+
build artifact filenames)
|
| 1144 |
+
#385 CMake: Fix compilation with -DEXPAT_SHARED_LIBS=OFF for
|
| 1145 |
+
Windows
|
| 1146 |
+
CMake: Expose man page compilation as target "xmlwf-manpage"
|
| 1147 |
+
#413 #414 CMake: Introduce option EXPAT_BUILD_PKGCONFIG
|
| 1148 |
+
to control generation of pkg-config file "expat.pc"
|
| 1149 |
+
#424 CMake: Add minimalistic support for building binary packages
|
| 1150 |
+
with CMake target "package"; based on CPack
|
| 1151 |
+
#366 CMake: Add option -DEXPAT_OSSFUZZ_BUILD=(ON|OFF) with
|
| 1152 |
+
default OFF to build fuzzer code against OSS-Fuzz and
|
| 1153 |
+
related environment variable LIB_FUZZING_ENGINE
|
| 1154 |
+
#354 Fix testsuite for -DEXPAT_DTD=OFF and -DEXPAT_NS=OFF, each
|
| 1155 |
+
#354 #355 ..
|
| 1156 |
+
#356 #412 Address compiler warnings
|
| 1157 |
+
#368 #369 Address pngcheck warnings with doc/*.png images
|
| 1158 |
+
#425 Version info bumped from 7:11:6 to 7:12:6
|
| 1159 |
+
|
| 1160 |
+
Special thanks to:
|
| 1161 |
+
asavah
|
| 1162 |
+
Ben Wagner
|
| 1163 |
+
Bhargava Shastry
|
| 1164 |
+
Frank Landgraf
|
| 1165 |
+
Jeffrey Walton
|
| 1166 |
+
Joe Orton
|
| 1167 |
+
Kleber Tarcísio
|
| 1168 |
+
Ma Lin
|
| 1169 |
+
Maciej Sroczyński
|
| 1170 |
+
Mohammed Khajapasha
|
| 1171 |
+
Vadim Zeitlin
|
| 1172 |
+
and
|
| 1173 |
+
Cppcheck 2.0 and the Cppcheck team
|
| 1174 |
+
|
| 1175 |
+
Release 2.2.9 Wed September 25 2019
|
| 1176 |
+
Other changes:
|
| 1177 |
+
examples: Drop executable bits from elements.c
|
| 1178 |
+
#349 Windows: Change the name of the Windows DLLs from expat*.dll
|
| 1179 |
+
to libexpat*.dll once more (regression from 2.2.8, first
|
| 1180 |
+
fixed in 1.95.3, issue #61 on SourceForge today,
|
| 1181 |
+
was issue #432456 back then); needs a fix due
|
| 1182 |
+
case-insensitive file systems on Windows and the fact that
|
| 1183 |
+
Perl's XML::Parser::Expat compiles into Expat.dll.
|
| 1184 |
+
#347 Windows: Only define _CRT_RAND_S if not defined
|
| 1185 |
+
Version info bumped from 7:10:6 to 7:11:6
|
| 1186 |
+
|
| 1187 |
+
Special thanks to:
|
| 1188 |
+
Ben Wagner
|
| 1189 |
+
|
| 1190 |
+
Release 2.2.8 Fri September 13 2019
|
| 1191 |
+
Security fixes:
|
| 1192 |
+
#317 #318 CVE-2019-15903 -- Fix heap overflow triggered by
|
| 1193 |
+
XML_GetCurrentLineNumber (or XML_GetCurrentColumnNumber),
|
| 1194 |
+
and deny internal entities closing the doctype;
|
| 1195 |
+
fixed in commit c20b758c332d9a13afbbb276d30db1d183a85d43
|
| 1196 |
+
|
| 1197 |
+
Bug fixes:
|
| 1198 |
+
#240 Fix cases where XML_StopParser did not have any effect
|
| 1199 |
+
when called from inside of an end element handler
|
| 1200 |
+
#341 xmlwf: Fix exit code for operation without "-d DIRECTORY";
|
| 1201 |
+
previously, only "-d DIRECTORY" would give you a proper
|
| 1202 |
+
exit code:
|
| 1203 |
+
# xmlwf -d . <<<'<not well-formed>' 2>/dev/null ; echo $?
|
| 1204 |
+
2
|
| 1205 |
+
# xmlwf <<<'<not well-formed>' 2>/dev/null ; echo $?
|
| 1206 |
+
0
|
| 1207 |
+
Now both cases return exit code 2.
|
| 1208 |
+
|
| 1209 |
+
Other changes:
|
| 1210 |
+
#299 #302 Windows: Replace LoadLibrary hack to access
|
| 1211 |
+
unofficial API function SystemFunction036 (RtlGenRandom)
|
| 1212 |
+
by using official API function rand_s (needs WinXP+)
|
| 1213 |
+
#325 Windows: Drop support for Visual Studio <=7.1/2003
|
| 1214 |
+
and document supported compilers in README.md
|
| 1215 |
+
#286 Windows: Remove COM code from xmlwf; in case it turns
|
| 1216 |
+
out needed later, there will be a dedicated repository
|
| 1217 |
+
below https://github.com/libexpat/ for that code
|
| 1218 |
+
#322 Windows: Remove explicit MSVC solution and project files.
|
| 1219 |
+
You can generate Visual Studio solution files through
|
| 1220 |
+
CMake, e.g.: cmake -G"Visual Studio 15 2017" .
|
| 1221 |
+
#338 xmlwf: Make "xmlwf -h" help output more friendly
|
| 1222 |
+
#339 examples: Improve elements.c
|
| 1223 |
+
#244 #264 Autotools: Add argument --enable-xml-attr-info
|
| 1224 |
+
#239 #301 Autotools: Add arguments
|
| 1225 |
+
--with-getrandom
|
| 1226 |
+
--without-getrandom
|
| 1227 |
+
--with-sys-getrandom
|
| 1228 |
+
--without-sys-getrandom
|
| 1229 |
+
#312 #343 Autotools: Fix linking issues with "./configure LD=clang"
|
| 1230 |
+
Autotools: Fix "make run-xmltest" for out-of-source builds
|
| 1231 |
+
#329 #336 CMake: Pull all options from Expat <=2.2.7 into namespace
|
| 1232 |
+
prefix EXPAT_ with the exception of DOCBOOK_TO_MAN:
|
| 1233 |
+
- BUILD_doc -> EXPAT_BUILD_DOCS (plural)
|
| 1234 |
+
- BUILD_examples -> EXPAT_BUILD_EXAMPLES
|
| 1235 |
+
- BUILD_shared -> EXPAT_SHARED_LIBS
|
| 1236 |
+
- BUILD_tests -> EXPAT_BUILD_TESTS
|
| 1237 |
+
- BUILD_tools -> EXPAT_BUILD_TOOLS
|
| 1238 |
+
- DOCBOOK_TO_MAN -> DOCBOOK_TO_MAN (unchanged)
|
| 1239 |
+
- INSTALL -> EXPAT_ENABLE_INSTALL
|
| 1240 |
+
- MSVC_USE_STATIC_CRT -> EXPAT_MSVC_STATIC_CRT
|
| 1241 |
+
- USE_libbsd -> EXPAT_WITH_LIBBSD
|
| 1242 |
+
- WARNINGS_AS_ERRORS -> EXPAT_WARNINGS_AS_ERRORS
|
| 1243 |
+
- XML_CONTEXT_BYTES -> EXPAT_CONTEXT_BYTES
|
| 1244 |
+
- XML_DEV_URANDOM -> EXPAT_DEV_URANDOM
|
| 1245 |
+
- XML_DTD -> EXPAT_DTD
|
| 1246 |
+
- XML_NS -> EXPAT_NS
|
| 1247 |
+
- XML_UNICODE -> EXPAT_CHAR_TYPE=ushort (!)
|
| 1248 |
+
- XML_UNICODE_WCHAR_T -> EXPAT_CHAR_TYPE=wchar_t (!)
|
| 1249 |
+
#244 #264 CMake: Add argument -DEXPAT_ATTR_INFO=(ON|OFF),
|
| 1250 |
+
default OFF
|
| 1251 |
+
#326 CMake: Add argument -DEXPAT_LARGE_SIZE=(ON|OFF),
|
| 1252 |
+
default OFF
|
| 1253 |
+
#328 CMake: Add argument -DEXPAT_MIN_SIZE=(ON|OFF),
|
| 1254 |
+
default OFF
|
| 1255 |
+
#239 #277 CMake: Add arguments
|
| 1256 |
+
-DEXPAT_WITH_GETRANDOM=(ON|OFF|AUTO), default AUTO
|
| 1257 |
+
-DEXPAT_WITH_SYS_GETRANDOM=(ON|OFF|AUTO), default AUTO
|
| 1258 |
+
#326 CMake: Install expat_config.h to include directory
|
| 1259 |
+
#326 CMake: Generate and install configuration files for
|
| 1260 |
+
future find_package(expat [..] CONFIG [..])
|
| 1261 |
+
CMake: Now produces a summary of applied configuration
|
| 1262 |
+
CMake: Require C++ compiler only when tests are enabled
|
| 1263 |
+
#330 CMake: Fix compilation for 16bit character types,
|
| 1264 |
+
i.e. ex -DXML_UNICODE=ON (and ex -DXML_UNICODE_WCHAR_T=ON)
|
| 1265 |
+
#265 CMake: Fix linking with MinGW
|
| 1266 |
+
#330 CMake: Add full support for MinGW; to enable, use
|
| 1267 |
+
-DCMAKE_TOOLCHAIN_FILE=[expat]/cmake/mingw-toolchain.cmake
|
| 1268 |
+
#330 CMake: Port "make run-xmltest" from GNU Autotools to CMake
|
| 1269 |
+
#316 CMake: Windows: Make binary postfix match MSVC
|
| 1270 |
+
Old: expat[d].lib
|
| 1271 |
+
New: expat[w][d][MD|MT].lib
|
| 1272 |
+
CMake: Migrate files from Windows to Unix line endings
|
| 1273 |
+
#308 CMake: Integrate OSS-Fuzz fuzzers, option
|
| 1274 |
+
-DEXPAT_BUILD_FUZZERS=(ON|OFF), default OFF
|
| 1275 |
+
#14 Drop an OpenVMS support leftover
|
| 1276 |
+
#235 #268 ..
|
| 1277 |
+
#270 #310 ..
|
| 1278 |
+
#313 #331 #333 Address compiler warnings
|
| 1279 |
+
#282 #283 ..
|
| 1280 |
+
#284 #285 Address cppcheck warnings
|
| 1281 |
+
#294 #295 Address Clang Static Analyzer warnings
|
| 1282 |
+
#24 #293 Mass-apply clang-format 9 (and ensure conformance during CI)
|
| 1283 |
+
Version info bumped from 7:9:6 to 7:10:6
|
| 1284 |
+
|
| 1285 |
+
Special thanks to:
|
| 1286 |
+
David Loffredo
|
| 1287 |
+
Joonun Jang
|
| 1288 |
+
Kishore Kunche
|
| 1289 |
+
Marco Maggi
|
| 1290 |
+
Mitch Phillips
|
| 1291 |
+
Mohammed Khajapasha
|
| 1292 |
+
Rolf Ade
|
| 1293 |
+
xantares
|
| 1294 |
+
Zhongyuan Zhou
|
| 1295 |
+
|
| 1296 |
+
Release 2.2.7 Wed June 19 2019
|
| 1297 |
+
Security fixes:
|
| 1298 |
+
#186 #262 CVE-2018-20843 -- Fix extraction of namespace prefixes from
|
| 1299 |
+
XML names; XML names with multiple colons could end up in
|
| 1300 |
+
the wrong namespace, and take a high amount of RAM and CPU
|
| 1301 |
+
resources while processing, opening the door to
|
| 1302 |
+
use for denial-of-service attacks
|
| 1303 |
+
|
| 1304 |
+
Other changes:
|
| 1305 |
+
#195 #197 Autotools/CMake: Utilize -fvisibility=hidden to stop
|
| 1306 |
+
exporting non-API symbols
|
| 1307 |
+
#227 Autotools: Add --without-examples and --without-tests
|
| 1308 |
+
#228 Autotools: Modernize configure.ac
|
| 1309 |
+
#245 #246 Autotools: Fix check for -fvisibility=hidden for Clang
|
| 1310 |
+
#247 #248 Autotools: Fix compilation for lack of docbook2x-man
|
| 1311 |
+
#236 #258 Autotools: Produce .tar.{gz,lz,xz} release archives
|
| 1312 |
+
#212 CMake: Make libdir of pkgconfig expat.pc support multilib
|
| 1313 |
+
#158 #263 CMake: Build man page in PROJECT_BINARY_DIR not _SOURCE_DIR
|
| 1314 |
+
#219 Remove fallback to bcopy, assume that memmove(3) exists
|
| 1315 |
+
#257 Use portable "/usr/bin/env bash" shebang (e.g. for OpenBSD)
|
| 1316 |
+
#243 Windows: Fix syntax of .def module definition files
|
| 1317 |
+
Version info bumped from 7:8:6 to 7:9:6
|
| 1318 |
+
|
| 1319 |
+
Special thanks to:
|
| 1320 |
+
Benjamin Peterson
|
| 1321 |
+
Caolán McNamara
|
| 1322 |
+
Hanno Böck
|
| 1323 |
+
KangLin
|
| 1324 |
+
Kishore Kunche
|
| 1325 |
+
Marco Maggi
|
| 1326 |
+
Rhodri James
|
| 1327 |
+
Sebastian Dröge
|
| 1328 |
+
userwithuid
|
| 1329 |
+
Yury Gribov
|
| 1330 |
+
|
| 1331 |
+
Release 2.2.6 Sun August 12 2018
|
| 1332 |
+
Bug fixes:
|
| 1333 |
+
#170 #206 Avoid doing arithmetic with NULL pointers in XML_GetBuffer
|
| 1334 |
+
#204 #205 Fix 2.2.5 regression with suspend-resume while parsing
|
| 1335 |
+
a document like '<root/>'
|
| 1336 |
+
|
| 1337 |
+
Other changes:
|
| 1338 |
+
#165 #168 Autotools: Fix docbook-related configure syntax error
|
| 1339 |
+
#166 Autotools: Avoid grep option `-q` for Solaris
|
| 1340 |
+
#167 Autotools: Support
|
| 1341 |
+
./configure DOCBOOK_TO_MAN="xmlto man --skip-validation"
|
| 1342 |
+
#159 #167 Autotools: Support DOCBOOK_TO_MAN command which produces
|
| 1343 |
+
xmlwf.1 rather than XMLWF.1; also covers case insensitive
|
| 1344 |
+
file systems
|
| 1345 |
+
#181 Autotools: Drop -rpath option passed to libtool
|
| 1346 |
+
#188 Autotools: Detect and deny SGML docbook2man as ours is XML
|
| 1347 |
+
#188 Autotools/CMake: Support command db2x_docbook2man as well
|
| 1348 |
+
#174 CMake: Introduce option WARNINGS_AS_ERRORS, defaults to OFF
|
| 1349 |
+
#184 #185 CMake: Introduce option MSVC_USE_STATIC_CRT, defaults to OFF
|
| 1350 |
+
#207 #208 CMake: Introduce option XML_UNICODE and XML_UNICODE_WCHAR_T,
|
| 1351 |
+
both defaulting to OFF
|
| 1352 |
+
#175 CMake: Prefer check_symbol_exists over check_function_exists
|
| 1353 |
+
#176 CMake: Create the same pkg-config file as with GNU Autotools
|
| 1354 |
+
#178 #179 CMake: Use GNUInstallDirs module to set proper defaults for
|
| 1355 |
+
install directories
|
| 1356 |
+
#208 CMake: Utilize expat_config.h.cmake for XML_DEV_URANDOM
|
| 1357 |
+
#180 Windows: Fix compilation of test suite for Visual Studio 2008
|
| 1358 |
+
#131 #173 #202 Address compiler warnings
|
| 1359 |
+
#187 #190 #200 Fix miscellaneous typos
|
| 1360 |
+
Version info bumped from 7:7:6 to 7:8:6
|
| 1361 |
+
|
| 1362 |
+
Special thanks to:
|
| 1363 |
+
Anton Maklakov
|
| 1364 |
+
Benjamin Peterson
|
| 1365 |
+
Brad King
|
| 1366 |
+
Franek Korta
|
| 1367 |
+
Frank Rast
|
| 1368 |
+
Joe Orton
|
| 1369 |
+
luzpaz
|
| 1370 |
+
Pedro Vicente
|
| 1371 |
+
Rainer Jung
|
| 1372 |
+
Rhodri James
|
| 1373 |
+
Rolf Ade
|
| 1374 |
+
Rolf Eike Beer
|
| 1375 |
+
Thomas Beutlich
|
| 1376 |
+
Tomasz Kłoczko
|
| 1377 |
+
|
| 1378 |
+
Release 2.2.5 Tue October 31 2017
|
| 1379 |
+
Bug fixes:
|
| 1380 |
+
#8 If the parser runs out of memory, make sure its internal
|
| 1381 |
+
state reflects the memory it actually has, not the memory
|
| 1382 |
+
it wanted to have.
|
| 1383 |
+
#11 The default handler wasn't being called when it should for
|
| 1384 |
+
a SYSTEM or PUBLIC doctype if an entity declaration handler
|
| 1385 |
+
was registered.
|
| 1386 |
+
#137 #138 Fix a case of mistakenly reported parsing success where
|
| 1387 |
+
XML_StopParser was called from an element handler
|
| 1388 |
+
#162 Function XML_ErrorString was returning NULL rather than
|
| 1389 |
+
a message for code XML_ERROR_INVALID_ARGUMENT
|
| 1390 |
+
introduced with release 2.2.1
|
| 1391 |
+
|
| 1392 |
+
Other changes:
|
| 1393 |
+
#106 xmlwf: Add argument -N adding notation declarations
|
| 1394 |
+
#75 #106 Test suite: Resolve expected failure cases where xmlwf
|
| 1395 |
+
output was incomplete
|
| 1396 |
+
#127 Windows: Fix test suite compilation
|
| 1397 |
+
#126 #127 Windows: Fix compilation for Visual Studio 2012
|
| 1398 |
+
Windows: Upgrade shipped project files to Visual Studio 2017
|
| 1399 |
+
#33 #132 tests: Mass-fix compilation for XML_UNICODE_WCHAR_T
|
| 1400 |
+
#129 examples: Fix compilation for XML_UNICODE_WCHAR_T
|
| 1401 |
+
#130 benchmark: Fix compilation for XML_UNICODE_WCHAR_T
|
| 1402 |
+
#144 xmlwf: Fix compilation for XML_UNICODE_WCHAR_T; still needs
|
| 1403 |
+
Windows or MinGW for 2-byte wchar_t
|
| 1404 |
+
#9 Address two Clang Static Analyzer false positives
|
| 1405 |
+
#59 Resolve troublesome macros hiding parser struct membership
|
| 1406 |
+
and dereferencing that pointer
|
| 1407 |
+
#6 Resolve superfluous internal malloc/realloc switch
|
| 1408 |
+
#153 #155 Improve docbook2x-man detection
|
| 1409 |
+
#160 Undefine NDEBUG in the test suite (rather than rejecting it)
|
| 1410 |
+
#161 Address compiler warnings
|
| 1411 |
+
Version info bumped from 7:6:6 to 7:7:6
|
| 1412 |
+
|
| 1413 |
+
Special thanks to:
|
| 1414 |
+
Benbuck Nason
|
| 1415 |
+
Hans Wennborg
|
| 1416 |
+
José Gutiérrez de la Concha
|
| 1417 |
+
Pedro Monreal Gonzalez
|
| 1418 |
+
Rhodri James
|
| 1419 |
+
Rolf Ade
|
| 1420 |
+
Stephen Groat
|
| 1421 |
+
and
|
| 1422 |
+
Core Infrastructure Initiative
|
| 1423 |
+
|
| 1424 |
+
Release 2.2.4 Sat August 19 2017
|
| 1425 |
+
Bug fixes:
|
| 1426 |
+
#115 Fix copying of partial characters for UTF-8 input
|
| 1427 |
+
|
| 1428 |
+
Other changes:
|
| 1429 |
+
#109 Fix "make check" for non-x86 architectures that default
|
| 1430 |
+
to unsigned type char (-128..127 rather than 0..255)
|
| 1431 |
+
#109 coverage.sh: Cover -funsigned-char
|
| 1432 |
+
Autotools: Introduce --without-xmlwf argument
|
| 1433 |
+
#65 Autotools: Replace handwritten Makefile with GNU Automake
|
| 1434 |
+
#43 CMake: Auto-detect high quality entropy extractors, add new
|
| 1435 |
+
option USE_libbsd=ON to use arc4random_buf of libbsd
|
| 1436 |
+
#74 CMake: Add -fno-strict-aliasing only where supported
|
| 1437 |
+
#114 CMake: Always honor manually set BUILD_* options
|
| 1438 |
+
#114 CMake: Compile man page if docbook2x-man is available, only
|
| 1439 |
+
#117 Include file tests/xmltest.log.expected in source tarball
|
| 1440 |
+
(required for "make run-xmltest")
|
| 1441 |
+
#117 Include (existing) Visual Studio 2013 files in source tarball
|
| 1442 |
+
Improve test suite error output
|
| 1443 |
+
#111 Fix some typos in documentation
|
| 1444 |
+
Version info bumped from 7:5:6 to 7:6:6
|
| 1445 |
+
|
| 1446 |
+
Special thanks to:
|
| 1447 |
+
Jakub Wilk
|
| 1448 |
+
Joe Orton
|
| 1449 |
+
Lin Tian
|
| 1450 |
+
Rolf Eike Beer
|
| 1451 |
+
|
| 1452 |
+
Release 2.2.3 Wed August 2 2017
|
| 1453 |
+
Security fixes:
|
| 1454 |
+
#82 CVE-2017-11742 -- Windows: Fix DLL hijacking vulnerability
|
| 1455 |
+
using Steve Holme's LoadLibrary wrapper for/of cURL
|
| 1456 |
+
|
| 1457 |
+
Bug fixes:
|
| 1458 |
+
#85 Fix a dangling pointer issue related to realloc
|
| 1459 |
+
|
| 1460 |
+
Other changes:
|
| 1461 |
+
Increase code coverage
|
| 1462 |
+
#91 Linux: Allow getrandom to fail if nonblocking pool has not
|
| 1463 |
+
yet been initialized and read /dev/urandom then, instead.
|
| 1464 |
+
This is in line with what recent Python does.
|
| 1465 |
+
#81 Pre-10.7/Lion macOS: Support entropy from arc4random
|
| 1466 |
+
#86 Check that a UTF-16 encoding in an XML declaration has the
|
| 1467 |
+
right endianness
|
| 1468 |
+
#4 #5 #7 Recover correctly when some reallocations fail
|
| 1469 |
+
Repair "./configure && make" for systems without any
|
| 1470 |
+
provider of high quality entropy
|
| 1471 |
+
and try reading /dev/urandom on those
|
| 1472 |
+
Ensure that user-defined character encodings have converter
|
| 1473 |
+
functions when they are needed
|
| 1474 |
+
Fix mis-leading description of argument -c in xmlwf.1
|
| 1475 |
+
Rely on macro HAVE_ARC4RANDOM_BUF (rather than __CloudABI__)
|
| 1476 |
+
for CloudABI
|
| 1477 |
+
#100 Fix use of SIPHASH_MAIN in siphash.h
|
| 1478 |
+
#23 Test suite: Fix memory leaks
|
| 1479 |
+
Version info bumped from 7:4:6 to 7:5:6
|
| 1480 |
+
|
| 1481 |
+
Special thanks to:
|
| 1482 |
+
Chanho Park
|
| 1483 |
+
Joe Orton
|
| 1484 |
+
Pascal Cuoq
|
| 1485 |
+
Rhodri James
|
| 1486 |
+
Simon McVittie
|
| 1487 |
+
Vadim Zeitlin
|
| 1488 |
+
Viktor Szakats
|
| 1489 |
+
and
|
| 1490 |
+
Core Infrastructure Initiative
|
| 1491 |
+
|
| 1492 |
+
Release 2.2.2 Wed July 12 2017
|
| 1493 |
+
Security fixes:
|
| 1494 |
+
#43 Protect against compilation without any source of high
|
| 1495 |
+
quality entropy enabled, e.g. with CMake build system;
|
| 1496 |
+
commit ff0207e6076e9828e536b8d9cd45c9c92069b895
|
| 1497 |
+
#60 Windows with _UNICODE:
|
| 1498 |
+
Unintended use of LoadLibraryW with a non-wide string
|
| 1499 |
+
resulted in failure to load advapi32.dll and degradation
|
| 1500 |
+
in quality of used entropy when compiled with _UNICODE for
|
| 1501 |
+
Windows; you can launch existing binaries with
|
| 1502 |
+
EXPAT_ENTROPY_DEBUG=1 in the environment to inspect the
|
| 1503 |
+
quality of entropy used during runtime; commits
|
| 1504 |
+
* 95b95032f907ef1cd17ee7a9a1768010a825d61d
|
| 1505 |
+
* 73a5a2e9c081f49f2d775cf7ced864158b68dc80
|
| 1506 |
+
[MOX-006] Fix non-NULL parser parameter validation in XML_Parse;
|
| 1507 |
+
resulted in NULL dereference, previously;
|
| 1508 |
+
commit ac256dafdffc9622ab0dc2c62fcecb0dfcfa71fe
|
| 1509 |
+
|
| 1510 |
+
Bug fixes:
|
| 1511 |
+
#69 Fix improper use of unsigned long long integer literals
|
| 1512 |
+
|
| 1513 |
+
Other changes:
|
| 1514 |
+
#73 Start requiring a C99 compiler
|
| 1515 |
+
#49 Fix "==" Bashism in configure script
|
| 1516 |
+
#50 Fix too eager getrandom detection for Debian GNU/kFreeBSD
|
| 1517 |
+
#52 and macOS
|
| 1518 |
+
#51 Address lack of stdint.h in Visual Studio 2003 to 2008
|
| 1519 |
+
#58 Address compile warnings
|
| 1520 |
+
#68 Fix "./buildconf.sh && ./configure" for some versions
|
| 1521 |
+
of Dash for /bin/sh
|
| 1522 |
+
#72 CMake: Ease use of Expat in context of a parent project
|
| 1523 |
+
with multiple CMakeLists.txt files
|
| 1524 |
+
#72 CMake: Resolve mistaken executable permissions
|
| 1525 |
+
#76 Address compile warning with -DNDEBUG (not recommended!)
|
| 1526 |
+
#77 Address compile warning about macro redefinition
|
| 1527 |
+
|
| 1528 |
+
Special thanks to:
|
| 1529 |
+
Alexander Bluhm
|
| 1530 |
+
Ben Boeckel
|
| 1531 |
+
Cătălin Răceanu
|
| 1532 |
+
Kerin Millar
|
| 1533 |
+
László Böszörményi
|
| 1534 |
+
S. P. Zeidler
|
| 1535 |
+
Segev Finer
|
| 1536 |
+
Václav Slavík
|
| 1537 |
+
Victor Stinner
|
| 1538 |
+
Viktor Szakats
|
| 1539 |
+
and
|
| 1540 |
+
Radically Open Security
|
| 1541 |
+
|
| 1542 |
+
Release 2.2.1 Sat June 17 2017
|
| 1543 |
+
Security fixes:
|
| 1544 |
+
CVE-2017-9233 -- External entity infinite loop DoS
|
| 1545 |
+
Details: https://libexpat.github.io/doc/cve-2017-9233/
|
| 1546 |
+
Commit c4bf96bb51dd2a1b0e185374362ee136fe2c9d7f
|
| 1547 |
+
[MOX-002] CVE-2016-9063 -- Detect integer overflow; commit
|
| 1548 |
+
d4f735b88d9932bd5039df2335eefdd0723dbe20
|
| 1549 |
+
(Fixed version of existing downstream patches!)
|
| 1550 |
+
(SF.net) #539 Fix regression from fix to CVE-2016-0718 cutting off
|
| 1551 |
+
longer tag names; commits
|
| 1552 |
+
* 896b6c1fd3b842f377d1b62135dccf0a579cf65d
|
| 1553 |
+
* af507cef2c93cb8d40062a0abe43a4f4e9158fb2
|
| 1554 |
+
#16 * 0dbbf43fdb20f593ddf4fa1ff67288000dd4a7fd
|
| 1555 |
+
#25 More integer overflow detection (function poolGrow); commits
|
| 1556 |
+
* 810b74e4703dcfdd8f404e3cb177d44684775143
|
| 1557 |
+
* 44178553f3539ce69d34abee77a05e879a7982ac
|
| 1558 |
+
[MOX-002] Detect overflow from len=INT_MAX call to XML_Parse; commits
|
| 1559 |
+
* 4be2cb5afcc018d996f34bbbce6374b7befad47f
|
| 1560 |
+
* 7e5b71b748491b6e459e5c9a1d090820f94544d8
|
| 1561 |
+
[MOX-005] #30 Use high quality entropy for hash initialization:
|
| 1562 |
+
* arc4random_buf on BSD, systems with libbsd
|
| 1563 |
+
(when configured with --with-libbsd), CloudABI
|
| 1564 |
+
* RtlGenRandom on Windows XP / Server 2003 and later
|
| 1565 |
+
* getrandom on Linux 3.17+
|
| 1566 |
+
In a way, that's still part of CVE-2016-5300.
|
| 1567 |
+
https://github.com/libexpat/libexpat/pull/30/commits
|
| 1568 |
+
[MOX-005] For the low quality entropy extraction fallback code,
|
| 1569 |
+
the parser instance address can no longer leak, commit
|
| 1570 |
+
04ad658bd3079dd15cb60fc67087900f0ff4b083
|
| 1571 |
+
[MOX-003] Prevent use of uninitialised variable; commit
|
| 1572 |
+
[MOX-004] a4dc944f37b664a3ca7199c624a98ee37babdb4b
|
| 1573 |
+
Add missing parameter validation to public API functions
|
| 1574 |
+
and dedicated error code XML_ERROR_INVALID_ARGUMENT:
|
| 1575 |
+
[MOX-006] * NULL checks; commits
|
| 1576 |
+
* d37f74b2b7149a3a95a680c4c4cd2a451a51d60a (merge/many)
|
| 1577 |
+
* 9ed727064b675b7180c98cb3d4f75efba6966681
|
| 1578 |
+
* 6a747c837c50114dfa413994e07c0ba477be4534
|
| 1579 |
+
* Negative length (XML_Parse); commit
|
| 1580 |
+
[MOX-002] 70db8d2538a10f4c022655d6895e4c3e78692e7f
|
| 1581 |
+
[MOX-001] #35 Change hash algorithm to William Ahern's version of SipHash
|
| 1582 |
+
to go further with fixing CVE-2012-0876.
|
| 1583 |
+
https://github.com/libexpat/libexpat/pull/39/commits
|
| 1584 |
+
|
| 1585 |
+
Bug fixes:
|
| 1586 |
+
#32 Fix sharing of hash salt across parsers;
|
| 1587 |
+
relevant where XML_ExternalEntityParserCreate is called
|
| 1588 |
+
prior to XML_Parse, in particular (e.g. FBReader)
|
| 1589 |
+
#28 xmlwf: Auto-disable use of memory-mapping (and parsing
|
| 1590 |
+
as a single chunk) for files larger than ~1 GB (2^30 bytes)
|
| 1591 |
+
rather than failing with error "out of memory"
|
| 1592 |
+
#3 Fix double free after malloc failure in DTD code; commit
|
| 1593 |
+
7ae9c3d3af433cd4defe95234eae7dc8ed15637f
|
| 1594 |
+
#17 Fix memory leak on parser error for unbound XML attribute
|
| 1595 |
+
prefix with new namespaces defined in the same tag;
|
| 1596 |
+
found by Google's OSS-Fuzz; commits
|
| 1597 |
+
* 16f87daae5a16132e479e4f71862128c7a915c73
|
| 1598 |
+
* b47dbc9745932c160893d433220e462bd605f8cd
|
| 1599 |
+
xmlwf on Windows: Add missing calls to CloseHandle
|
| 1600 |
+
|
| 1601 |
+
New features:
|
| 1602 |
+
#30 Introduced environment switch EXPAT_ENTROPY_DEBUG=1
|
| 1603 |
+
for runtime debugging of entropy extraction
|
| 1604 |
+
|
| 1605 |
+
Other changes:
|
| 1606 |
+
Increase code coverage
|
| 1607 |
+
#33 Reject use of XML_UNICODE_WCHAR_T with sizeof(wchar_t) != 2;
|
| 1608 |
+
XML_UNICODE_WCHAR_T was never meant to be used outside
|
| 1609 |
+
of Windows; 4-byte wchar_t is common on Linux
|
| 1610 |
+
(SF.net) #538 Start using -fno-strict-aliasing
|
| 1611 |
+
(SF.net) #540 Support compilation against cloudlibc of CloudABI
|
| 1612 |
+
Allow MinGW cross-compilation
|
| 1613 |
+
(SF.net) #534 CMake: Introduce option "BUILD_doc" (enabled by default)
|
| 1614 |
+
to bypass compilation of the xmlwf.1 man page
|
| 1615 |
+
(SF.net) pr2 CMake: Introduce option "INSTALL" (enabled by default)
|
| 1616 |
+
to bypass installation of expat files
|
| 1617 |
+
CMake: Fix ninja support
|
| 1618 |
+
Autotools: Add parameters --enable-xml-context [COUNT]
|
| 1619 |
+
and --disable-xml-context; default of context of 1024
|
| 1620 |
+
bytes enabled unchanged
|
| 1621 |
+
#14 Drop AmigaOS 4.x code and includes
|
| 1622 |
+
#14 Drop ancient build systems:
|
| 1623 |
+
* Borland C++ Builder
|
| 1624 |
+
* OpenVMS
|
| 1625 |
+
* Open Watcom
|
| 1626 |
+
* Visual Studio 6.0
|
| 1627 |
+
* Pre-X Mac OS (MPW Makefile)
|
| 1628 |
+
If you happen to rely on some of these, please get in
|
| 1629 |
+
touch for joining with maintenance.
|
| 1630 |
+
#10 Move from WIN32 to _WIN32
|
| 1631 |
+
#13 Fix "make run-xmltest" order instability
|
| 1632 |
+
Address compile warnings
|
| 1633 |
+
Bump version info from 7:2:6 to 7:3:6
|
| 1634 |
+
Add AUTHORS file
|
| 1635 |
+
|
| 1636 |
+
Infrastructure:
|
| 1637 |
+
#1 Migrate from SourceForge to GitHub (except downloads):
|
| 1638 |
+
https://github.com/libexpat/
|
| 1639 |
+
#1 Re-create http://libexpat.org/ project website
|
| 1640 |
+
Start utilizing Travis CI
|
| 1641 |
+
|
| 1642 |
+
Special thanks to:
|
| 1643 |
+
Andy Wang
|
| 1644 |
+
Don Lewis
|
| 1645 |
+
Ed Schouten
|
| 1646 |
+
Karl Waclawek
|
| 1647 |
+
Pascal Cuoq
|
| 1648 |
+
Rhodri James
|
| 1649 |
+
Sergei Nikulov
|
| 1650 |
+
Tobias Taschner
|
| 1651 |
+
Viktor Szakats
|
| 1652 |
+
and
|
| 1653 |
+
Core Infrastructure Initiative
|
| 1654 |
+
Mozilla Foundation (MOSS Track 3: Secure Open Source)
|
| 1655 |
+
Radically Open Security
|
| 1656 |
+
|
| 1657 |
+
Release 2.2.0 Tue June 21 2016
|
| 1658 |
+
Security fixes:
|
| 1659 |
+
#537 CVE-2016-0718 -- Fix crash on malformed input
|
| 1660 |
+
CVE-2016-4472 -- Improve insufficient fix to CVE-2015-1283 /
|
| 1661 |
+
CVE-2015-2716 introduced with Expat 2.1.1
|
| 1662 |
+
#499 CVE-2016-5300 -- Use more entropy for hash initialization
|
| 1663 |
+
than the original fix to CVE-2012-0876
|
| 1664 |
+
#519 CVE-2012-6702 -- Resolve troublesome internal call to srand
|
| 1665 |
+
that was introduced with Expat 2.1.0
|
| 1666 |
+
when addressing CVE-2012-0876 (issue #496)
|
| 1667 |
+
|
| 1668 |
+
Bug fixes:
|
| 1669 |
+
Fix uninitialized reads of size 1
|
| 1670 |
+
(e.g. in little2_updatePosition)
|
| 1671 |
+
Fix detection of UTF-8 character boundaries
|
| 1672 |
+
|
| 1673 |
+
Other changes:
|
| 1674 |
+
#532 Fix compilation for Visual Studio 2010 (keyword "C99")
|
| 1675 |
+
Autotools: Resolve use of "$<" to better support bmake
|
| 1676 |
+
Autotools: Add QA script "qa.sh" (and make target "qa")
|
| 1677 |
+
Autotools: Respect CXXFLAGS if given
|
| 1678 |
+
Autotools: Fix "make run-xmltest"
|
| 1679 |
+
Autotools: Have "make run-xmltest" check for expected output
|
| 1680 |
+
p90 CMake: Fix static build (BUILD_shared=OFF) on Windows
|
| 1681 |
+
#536 CMake: Add soversion, support -DNO_SONAME=yes to bypass
|
| 1682 |
+
#323 CMake: Add suffix "d" to differentiate debug from release
|
| 1683 |
+
CMake: Define WIN32 with CMake on Windows
|
| 1684 |
+
Annotate memory allocators for GCC
|
| 1685 |
+
Address all currently known compile warnings
|
| 1686 |
+
Make sure that API symbols remain visible despite
|
| 1687 |
+
-fvisibility=hidden
|
| 1688 |
+
Remove executable flag from source files
|
| 1689 |
+
Resolve COMPILED_FROM_DSP in favor of WIN32
|
| 1690 |
+
|
| 1691 |
+
Special thanks to:
|
| 1692 |
+
Björn Lindahl
|
| 1693 |
+
Christian Heimes
|
| 1694 |
+
Cristian Rodríguez
|
| 1695 |
+
Daniel Krügler
|
| 1696 |
+
Gustavo Grieco
|
| 1697 |
+
Karl Waclawek
|
| 1698 |
+
László Böszörményi
|
| 1699 |
+
Marco Grassi
|
| 1700 |
+
Pascal Cuoq
|
| 1701 |
+
Sergei Nikulov
|
| 1702 |
+
Thomas Beutlich
|
| 1703 |
+
Warren Young
|
| 1704 |
+
Yann Droneaud
|
| 1705 |
+
|
| 1706 |
+
Release 2.1.1 Sat March 12 2016
|
| 1707 |
+
Security fixes:
|
| 1708 |
+
#582: CVE-2015-1283 - Multiple integer overflows in XML_GetBuffer
|
| 1709 |
+
|
| 1710 |
+
Bug fixes:
|
| 1711 |
+
#502: Fix potential null pointer dereference
|
| 1712 |
+
#520: Symbol XML_SetHashSalt was not exported
|
| 1713 |
+
Output of "xmlwf -h" was incomplete
|
| 1714 |
+
|
| 1715 |
+
Other changes:
|
| 1716 |
+
#503: Document behavior of calling XML_SetHashSalt with salt 0
|
| 1717 |
+
Minor improvements to man page xmlwf(1)
|
| 1718 |
+
Improvements to the experimental CMake build system
|
| 1719 |
+
libtool now invoked with --verbose
|
| 1720 |
+
|
| 1721 |
+
Release 2.1.0 Sat March 24 2012
|
| 1722 |
+
- Security fixes:
|
| 1723 |
+
#2958794: CVE-2012-1148 - Memory leak in poolGrow.
|
| 1724 |
+
#2895533: CVE-2012-1147 - Resource leak in readfilemap.c.
|
| 1725 |
+
#3496608: CVE-2012-0876 - Hash DOS attack.
|
| 1726 |
+
#2894085: CVE-2009-3560 - Buffer over-read and crash in big2_toUtf8().
|
| 1727 |
+
#1990430: CVE-2009-3720 - Parser crash with special UTF-8 sequences.
|
| 1728 |
+
- Bug Fixes:
|
| 1729 |
+
#1742315: Harmful XML_ParserCreateNS suggestion.
|
| 1730 |
+
#1785430: Expat build fails on linux-amd64 with gcc version>=4.1 -O3.
|
| 1731 |
+
#1983953, 2517952, 2517962, 2649838:
|
| 1732 |
+
Build modifications using autoreconf instead of buildconf.sh.
|
| 1733 |
+
#2815947, #2884086: OBJEXT and EXEEXT support while building.
|
| 1734 |
+
#2517938: xmlwf should return non-zero exit status if not well-formed.
|
| 1735 |
+
#2517946: Wrong statement about XMLDecl in xmlwf.1 and xmlwf.sgml.
|
| 1736 |
+
#2855609: Dangling positionPtr after error.
|
| 1737 |
+
#2990652: CMake support.
|
| 1738 |
+
#3010819: UNEXPECTED_STATE with a trailing "%" in entity value.
|
| 1739 |
+
#3206497: Uninitialized memory returned from XML_Parse.
|
| 1740 |
+
#3287849: make check fails on mingw-w64.
|
| 1741 |
+
- Patches:
|
| 1742 |
+
#1749198: pkg-config support.
|
| 1743 |
+
#3010222: Fix for bug #3010819.
|
| 1744 |
+
#3312568: CMake support.
|
| 1745 |
+
#3446384: Report byte offsets for attr names and values.
|
| 1746 |
+
- New Features / API changes:
|
| 1747 |
+
Added new API member XML_SetHashSalt() that allows setting an initial
|
| 1748 |
+
value (salt) for hash calculations. This is part of the fix for
|
| 1749 |
+
bug #3496608 to randomize hash parameters.
|
| 1750 |
+
When compiled with XML_ATTR_INFO defined, adds new API member
|
| 1751 |
+
XML_GetAttributeInfo() that allows retrieving the byte
|
| 1752 |
+
offsets for attribute names and values (patch #3446384).
|
| 1753 |
+
Added CMake build system.
|
| 1754 |
+
See bug #2990652 and patch #3312568.
|
| 1755 |
+
Added run-benchmark target to Makefile.in - relies on testdata module
|
| 1756 |
+
present in the same relative location as in the repository.
|
| 1757 |
+
|
| 1758 |
+
Release 2.0.1 Tue June 5 2007
|
| 1759 |
+
- Fixed bugs #1515266, #1515600: The character data handler's calling
|
| 1760 |
+
of XML_StopParser() was not handled properly; if the parser was
|
| 1761 |
+
stopped and the handler set to NULL, the parser would segfault.
|
| 1762 |
+
- Fixed bug #1690883: Expat failed on EBCDIC systems as it assumed
|
| 1763 |
+
some character constants to be ASCII encoded.
|
| 1764 |
+
- Minor cleanups of the test harness.
|
| 1765 |
+
- Fixed xmlwf bug #1513566: "out of memory" error on file size zero.
|
| 1766 |
+
- Fixed outline.c bug #1543233: missing a final XML_ParserFree() call.
|
| 1767 |
+
- Fixes and improvements for Windows platform:
|
| 1768 |
+
bugs #1409451, #1476160, #1548182, #1602769, #1717322.
|
| 1769 |
+
- Build fixes for various platforms:
|
| 1770 |
+
HP-UX, Tru64, Solaris 9: patch #1437840, bug #1196180.
|
| 1771 |
+
All Unix: #1554618 (refreshed config.sub/config.guess).
|
| 1772 |
+
#1490371, #1613457: support both, DESTDIR and INSTALL_ROOT,
|
| 1773 |
+
without relying on GNU-Make specific features.
|
| 1774 |
+
#1647805: Patched configure.in to work better with Intel compiler.
|
| 1775 |
+
- Fixes to Makefile.in to have make check work correctly:
|
| 1776 |
+
bugs #1408143, #1535603, #1536684.
|
| 1777 |
+
- Added Open Watcom support: patch #1523242.
|
| 1778 |
+
|
| 1779 |
+
Release 2.0.0 Wed Jan 11 2006
|
| 1780 |
+
- We no longer use the "check" library for C unit testing; we
|
| 1781 |
+
always use the (partial) internal implementation of the API.
|
| 1782 |
+
- Report XML_NS setting via XML_GetFeatureList().
|
| 1783 |
+
- Fixed headers for use from C++.
|
| 1784 |
+
- XML_GetCurrentLineNumber() and XML_GetCurrentColumnNumber()
|
| 1785 |
+
now return unsigned integers.
|
| 1786 |
+
- Added XML_LARGE_SIZE switch to enable 64-bit integers for
|
| 1787 |
+
byte indexes and line/column numbers.
|
| 1788 |
+
- Updated to use libtool 1.5.22 (the most recent).
|
| 1789 |
+
- Added support for AmigaOS.
|
| 1790 |
+
- Some mostly minor bug fixes. SF issues include: #1006708,
|
| 1791 |
+
#1021776, #1023646, #1114960, #1156398, #1221160, #1271642.
|
| 1792 |
+
|
| 1793 |
+
Release 1.95.8 Fri Jul 23 2004
|
| 1794 |
+
- Major new feature: suspend/resume. Handlers can now request
|
| 1795 |
+
that a parse be suspended for later resumption or aborted
|
| 1796 |
+
altogether. See "Temporarily Stopping Parsing" in the
|
| 1797 |
+
documentation for more details.
|
| 1798 |
+
- Some mostly minor bug fixes, but compilation should no
|
| 1799 |
+
longer generate warnings on most platforms. SF issues
|
| 1800 |
+
include: #827319, #840173, #846309, #888329, #896188, #923913,
|
| 1801 |
+
#928113, #961698, #985192.
|
| 1802 |
+
|
| 1803 |
+
Release 1.95.7 Mon Oct 20 2003
|
| 1804 |
+
- Fixed enum XML_Status issue (reported on SourceForge many
|
| 1805 |
+
times), so compilers that are properly picky will be happy.
|
| 1806 |
+
- Introduced an XMLCALL macro to control the calling
|
| 1807 |
+
convention used by the Expat API; this macro should be used
|
| 1808 |
+
to annotate prototypes and definitions of callback
|
| 1809 |
+
implementations in code compiled with a calling convention
|
| 1810 |
+
other than the default convention for the host platform.
|
| 1811 |
+
- Improved ability to build without the configure-generated
|
| 1812 |
+
expat_config.h header. This is useful for applications
|
| 1813 |
+
which embed Expat rather than linking in the library.
|
| 1814 |
+
- Fixed a variety of bugs: see SF issues #458907, #609603,
|
| 1815 |
+
#676844, #679754, #692878, #692964, #695401, #699323, #699487,
|
| 1816 |
+
#820946.
|
| 1817 |
+
- Improved hash table lookups.
|
| 1818 |
+
- Added more regression tests and improved documentation.
|
| 1819 |
+
|
| 1820 |
+
Release 1.95.6 Tue Jan 28 2003
|
| 1821 |
+
- Added XML_FreeContentModel().
|
| 1822 |
+
- Added XML_MemMalloc(), XML_MemRealloc(), XML_MemFree().
|
| 1823 |
+
- Fixed a variety of bugs: see SF issues #615606, #616863,
|
| 1824 |
+
#618199, #653180, #673791.
|
| 1825 |
+
- Enhanced the regression test suite.
|
| 1826 |
+
- Man page improvements: includes SF issue #632146.
|
| 1827 |
+
|
| 1828 |
+
Release 1.95.5 Fri Sep 6 2002
|
| 1829 |
+
- Added XML_UseForeignDTD() for improved SAX2 support.
|
| 1830 |
+
- Added XML_GetFeatureList().
|
| 1831 |
+
- Defined XML_Bool type and the values XML_TRUE and XML_FALSE.
|
| 1832 |
+
- Use an incomplete struct instead of a void* for the parser
|
| 1833 |
+
(may not retain).
|
| 1834 |
+
- Fixed UTF-8 decoding bug that caused legal UTF-8 to be rejected.
|
| 1835 |
+
- Finally fixed bug where default handler would report DTD
|
| 1836 |
+
events that were already handled by another handler.
|
| 1837 |
+
Initial patch contributed by Darryl Miles.
|
| 1838 |
+
- Removed unnecessary DllMain() function that caused static
|
| 1839 |
+
linking into a DLL to be difficult.
|
| 1840 |
+
- Added VC++ projects for building static libraries.
|
| 1841 |
+
- Reduced line-length for all source code and headers to be
|
| 1842 |
+
no longer than 80 characters, to help with AS/400 support.
|
| 1843 |
+
- Reduced memory copying during parsing (SF patch #600964).
|
| 1844 |
+
- Fixed a variety of bugs: see SF issues #580793, #434664,
|
| 1845 |
+
#483514, #580503, #581069, #584041, #584183, #584832, #585537,
|
| 1846 |
+
#596555, #596678, #598352, #598944, #599715, #600479, #600971.
|
| 1847 |
+
|
| 1848 |
+
Release 1.95.4 Fri Jul 12 2002
|
| 1849 |
+
- Added support for VMS, contributed by Craig Berry. See
|
| 1850 |
+
vms/README.vms for more information.
|
| 1851 |
+
- Added Mac OS (classic) support, with a makefile for MPW,
|
| 1852 |
+
contributed by Thomas Wegner and Daryle Walker.
|
| 1853 |
+
- Added Borland C++ Builder 5 / BCC 5.5 support, contributed
|
| 1854 |
+
by Patrick McConnell (SF patch #538032).
|
| 1855 |
+
- Fixed a variety of bugs: see SF issues #441449, #563184,
|
| 1856 |
+
#564342, #566334, #566901, #569461, #570263, #575168, #579196.
|
| 1857 |
+
- Made skippedEntityHandler conform to SAX2 (see source comment)
|
| 1858 |
+
- Re-implemented WFC: Entity Declared from XML 1.0 spec and
|
| 1859 |
+
added a new error "entity declared in parameter entity":
|
| 1860 |
+
see SF bug report #569461 and SF patch #578161
|
| 1861 |
+
- Re-implemented section 5.1 from XML 1.0 spec:
|
| 1862 |
+
see SF bug report #570263 and SF patch #578161
|
| 1863 |
+
|
| 1864 |
+
Release 1.95.3 Mon Jun 3 2002
|
| 1865 |
+
- Added a project to the MSVC workspace to create a wchar_t
|
| 1866 |
+
version of the library; the DLLs are named libexpatw.dll.
|
| 1867 |
+
- Changed the name of the Windows DLLs from expat.dll to
|
| 1868 |
+
libexpat.dll; this fixes SF bug #432456.
|
| 1869 |
+
- Added the XML_ParserReset() API function.
|
| 1870 |
+
- Fixed XML_SetReturnNSTriplet() to work for element names.
|
| 1871 |
+
- Made the XML_UNICODE builds usable (thanks, Karl!).
|
| 1872 |
+
- Allow xmlwf to read from standard input.
|
| 1873 |
+
- Install a man page for xmlwf on Unix systems.
|
| 1874 |
+
- Fixed many bugs; see SF bug reports #231864, #461380, #464837,
|
| 1875 |
+
#466885, #469226, #477667, #484419, #487840, #494749, #496505,
|
| 1876 |
+
#547350. Other bugs which we can't test as easily may also
|
| 1877 |
+
have been fixed, especially in the area of build support.
|
| 1878 |
+
|
| 1879 |
+
Release 1.95.2 Fri Jul 27 2001
|
| 1880 |
+
- More changes to make MSVC happy with the build; add a single
|
| 1881 |
+
workspace to support both the library and xmlwf application.
|
| 1882 |
+
- Added a Windows installer for Windows users; includes
|
| 1883 |
+
xmlwf.exe.
|
| 1884 |
+
- Added compile-time constants that can be used to determine the
|
| 1885 |
+
Expat version
|
| 1886 |
+
- Removed a lot of GNU-specific dependencies to aide portability
|
| 1887 |
+
among the various Unix flavors.
|
| 1888 |
+
- Fix the UTF-8 BOM bug.
|
| 1889 |
+
- Cleaned up warning messages for several compilers.
|
| 1890 |
+
- Added the -Wall, -Wstrict-prototypes options for GCC.
|
| 1891 |
+
|
| 1892 |
+
Release 1.95.1 Sun Oct 22 15:11:36 EDT 2000
|
| 1893 |
+
- Changes to get expat to build under Microsoft compiler
|
| 1894 |
+
- Removed all aborts and instead return an UNEXPECTED_STATE error.
|
| 1895 |
+
- Fixed a bug where a stray '%' in an entity value would cause an
|
| 1896 |
+
abort.
|
| 1897 |
+
- Defined XML_SetEndNamespaceDeclHandler. Thanks to Darryl Miles for
|
| 1898 |
+
finding this oversight.
|
| 1899 |
+
- Changed default patterns in lib/Makefile.in to fit non-GNU makes
|
| 1900 |
+
Thanks to robin@unrated.net for reporting and providing an
|
| 1901 |
+
account to test on.
|
| 1902 |
+
- The reference had the wrong label for XML_SetStartNamespaceDecl.
|
| 1903 |
+
Reported by an anonymous user.
|
| 1904 |
+
|
| 1905 |
+
Release 1.95.0 Fri Sep 29 2000
|
| 1906 |
+
- XML_ParserCreate_MM
|
| 1907 |
+
Allows you to set a memory management suite to replace the
|
| 1908 |
+
standard malloc,realloc, and free.
|
| 1909 |
+
- XML_SetReturnNSTriplet
|
| 1910 |
+
If you turn this feature on when namespace processing is in
|
| 1911 |
+
effect, then qualified, prefixed element and attribute names
|
| 1912 |
+
are returned as "uri|name|prefix" where '|' is whatever
|
| 1913 |
+
separator character is used in namespace processing.
|
| 1914 |
+
- Merged in features from perl-expat
|
| 1915 |
+
o XML_SetElementDeclHandler
|
| 1916 |
+
o XML_SetAttlistDeclHandler
|
| 1917 |
+
o XML_SetXmlDeclHandler
|
| 1918 |
+
o XML_SetEntityDeclHandler
|
| 1919 |
+
o StartDoctypeDeclHandler takes 3 additional parameters:
|
| 1920 |
+
sysid, pubid, has_internal_subset
|
| 1921 |
+
o Many paired handler setters (like XML_SetElementHandler)
|
| 1922 |
+
now have corresponding individual handler setters
|
| 1923 |
+
o XML_GetInputContext for getting the input context of
|
| 1924 |
+
the current parse position.
|
| 1925 |
+
- Added reference material
|
| 1926 |
+
- Packaged into a distribution that builds a sharable library
|
git/mingw64/share/doc/git-doc/BreakingChanges.adoc
ADDED
|
@@ -0,0 +1,335 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
= Upcoming breaking changes
|
| 2 |
+
|
| 3 |
+
The Git project aims to ensure backwards compatibility to the best extent
|
| 4 |
+
possible. Minor releases will not break backwards compatibility unless there is
|
| 5 |
+
a very strong reason to do so, like for example a security vulnerability.
|
| 6 |
+
|
| 7 |
+
Regardless of that, due to the age of the Git project, it is only natural to
|
| 8 |
+
accumulate a backlog of backwards-incompatible changes that will eventually be
|
| 9 |
+
required to keep the project aligned with a changing world. These changes fall
|
| 10 |
+
into several categories:
|
| 11 |
+
|
| 12 |
+
* Changes to long established defaults.
|
| 13 |
+
* Concepts that have been replaced with a superior design.
|
| 14 |
+
* Concepts, commands, configuration or options that have been lacking in major
|
| 15 |
+
ways and that cannot be fixed and which will thus be removed without any
|
| 16 |
+
replacement.
|
| 17 |
+
|
| 18 |
+
Explicitly not included in this list are fixes to minor bugs that may cause a
|
| 19 |
+
change in user-visible behavior.
|
| 20 |
+
|
| 21 |
+
The Git project irregularly releases breaking versions that deliberately break
|
| 22 |
+
backwards compatibility with older versions. This is done to ensure that Git
|
| 23 |
+
remains relevant, safe and maintainable going forward. The release cadence of
|
| 24 |
+
breaking versions is typically measured in multiple years. We had the following
|
| 25 |
+
major breaking releases in the past:
|
| 26 |
+
|
| 27 |
+
* Git 1.6.0, released in August 2008.
|
| 28 |
+
* Git 2.0, released in May 2014.
|
| 29 |
+
|
| 30 |
+
We use <major>.<minor> release numbers these days, starting from Git 2.0. For
|
| 31 |
+
future releases, our plan is to increment <major> in the release number when we
|
| 32 |
+
make the next breaking release. Before Git 2.0, the release numbers were
|
| 33 |
+
1.<major>.<minor> with the intention to increment <major> for "usual" breaking
|
| 34 |
+
releases, reserving the jump to Git 2.0 for really large backward-compatibility
|
| 35 |
+
breaking changes.
|
| 36 |
+
|
| 37 |
+
The intent of this document is to track upcoming deprecations for future
|
| 38 |
+
breaking releases. Furthermore, this document also tracks what will _not_ be
|
| 39 |
+
deprecated. This is done such that the outcome of discussions document both
|
| 40 |
+
when the discussion favors deprecation, but also when it rejects a deprecation.
|
| 41 |
+
|
| 42 |
+
Items should have a clear summary of the reasons why we do or do not want to
|
| 43 |
+
make the described change that can be easily understood without having to read
|
| 44 |
+
the mailing list discussions. If there are alternatives to the changed feature,
|
| 45 |
+
those alternatives should be pointed out to our users.
|
| 46 |
+
|
| 47 |
+
All items should be accompanied by references to relevant mailing list threads
|
| 48 |
+
where the deprecation was discussed. These references use message-IDs, which
|
| 49 |
+
can visited via
|
| 50 |
+
|
| 51 |
+
https://lore.kernel.org/git/$message_id/
|
| 52 |
+
|
| 53 |
+
to see the message and its surrounding discussion. Such a reference is there to
|
| 54 |
+
make it easier for you to find how the project reached consensus on the
|
| 55 |
+
described item back then.
|
| 56 |
+
|
| 57 |
+
This is a living document as the environment surrounding the project changes
|
| 58 |
+
over time. If circumstances change, an earlier decision to deprecate or change
|
| 59 |
+
something may need to be revisited from time to time. So do not take items on
|
| 60 |
+
this list to mean "it is settled, do not waste our time bringing it up again".
|
| 61 |
+
|
| 62 |
+
== Procedure
|
| 63 |
+
|
| 64 |
+
Discussing the desire to make breaking changes, declaring that breaking
|
| 65 |
+
changes are made at a certain version boundary, and recording these
|
| 66 |
+
decisions in this document, are necessary but not sufficient.
|
| 67 |
+
Because such changes are expected to be numerous, and the design and
|
| 68 |
+
implementation of them are expected to span over time, they have to
|
| 69 |
+
be deployable trivially at such a version boundary, prepared over long
|
| 70 |
+
time.
|
| 71 |
+
|
| 72 |
+
The breaking changes MUST be guarded with the a compile-time switch,
|
| 73 |
+
WITH_BREAKING_CHANGES, to help this process. When built with it,
|
| 74 |
+
the resulting Git binary together with its documentation would
|
| 75 |
+
behave as if these breaking changes slated for the next big version
|
| 76 |
+
boundary are already in effect. We also have a CI job to exercise
|
| 77 |
+
the work-in-progress version of Git with these breaking changes.
|
| 78 |
+
|
| 79 |
+
|
| 80 |
+
== Git 3.0
|
| 81 |
+
|
| 82 |
+
The following subsections document upcoming breaking changes for Git 3.0. There
|
| 83 |
+
is no planned release date for this breaking version yet.
|
| 84 |
+
|
| 85 |
+
Proposed changes and removals only include items which are "ready" to be done.
|
| 86 |
+
In other words, this is not supposed to be a wishlist of features that should
|
| 87 |
+
be changed to or replaced in case the alternative was implemented already.
|
| 88 |
+
|
| 89 |
+
=== Changes
|
| 90 |
+
|
| 91 |
+
* The default hash function for new repositories will be changed from "sha1"
|
| 92 |
+
to "sha256". SHA-1 has been deprecated by NIST in 2011 and is nowadays
|
| 93 |
+
recommended against in FIPS 140-2 and similar certifications. Furthermore,
|
| 94 |
+
there are practical attacks on SHA-1 that weaken its cryptographic properties:
|
| 95 |
+
+
|
| 96 |
+
** The SHAppening (2015). The first demonstration of a practical attack
|
| 97 |
+
against SHA-1 with 2^57 operations.
|
| 98 |
+
** SHAttered (2017). Generation of two valid PDF files with 2^63 operations.
|
| 99 |
+
** Birthday-Near-Collision (2019). This attack allows for chosen prefix
|
| 100 |
+
attacks with 2^68 operations.
|
| 101 |
+
** Shambles (2020). This attack allows for chosen prefix attacks with 2^63
|
| 102 |
+
operations.
|
| 103 |
+
+
|
| 104 |
+
While we have protections in place against known attacks, it is expected
|
| 105 |
+
that more attacks against SHA-1 will be found by future research. Paired
|
| 106 |
+
with the ever-growing capability of hardware, it is only a matter of time
|
| 107 |
+
before SHA-1 will be considered broken completely. We want to be prepared
|
| 108 |
+
and will thus change the default hash algorithm to "sha256" for newly
|
| 109 |
+
initialized repositories.
|
| 110 |
+
+
|
| 111 |
+
An important requirement for this change is that the ecosystem is ready to
|
| 112 |
+
support the "sha256" object format. This includes popular Git libraries,
|
| 113 |
+
applications and forges.
|
| 114 |
+
+
|
| 115 |
+
There is no plan to deprecate the "sha1" object format at this point in time.
|
| 116 |
+
+
|
| 117 |
+
Cf. <2f5de416-04ba-c23d-1e0b-83bb655829a7@zombino.com>,
|
| 118 |
+
<20170223155046.e7nxivfwqqoprsqj@LykOS.localdomain>,
|
| 119 |
+
<CA+EOSBncr=4a4d8n9xS4FNehyebpmX8JiUwCsXD47EQDE+DiUQ@mail.gmail.com>.
|
| 120 |
+
|
| 121 |
+
* The default storage format for references in newly created repositories will
|
| 122 |
+
be changed from "files" to "reftable". The "reftable" format provides
|
| 123 |
+
multiple advantages over the "files" format:
|
| 124 |
+
+
|
| 125 |
+
** It is impossible to store two references that only differ in casing on
|
| 126 |
+
case-insensitive filesystems with the "files" format. This issue is common
|
| 127 |
+
on Windows and macOS platforms. As the "reftable" backend does not use
|
| 128 |
+
filesystem paths to encode reference names this problem goes away.
|
| 129 |
+
** Similarly, macOS normalizes path names that contain unicode characters,
|
| 130 |
+
which has the consequence that you cannot store two names with unicode
|
| 131 |
+
characters that are encoded differently with the "files" backend. Again,
|
| 132 |
+
this is not an issue with the "reftable" backend.
|
| 133 |
+
** Deleting references with the "files" backend requires Git to rewrite the
|
| 134 |
+
complete "packed-refs" file. In large repositories with many references
|
| 135 |
+
this file can easily be dozens of megabytes in size, in extreme cases it
|
| 136 |
+
may be gigabytes. The "reftable" backend uses tombstone markers for
|
| 137 |
+
deleted references and thus does not have to rewrite all of its data.
|
| 138 |
+
** Repository housekeeping with the "files" backend typically performs
|
| 139 |
+
all-into-one repacks of references. This can be quite expensive, and
|
| 140 |
+
consequently housekeeping is a tradeoff between the number of loose
|
| 141 |
+
references that accumulate and slow down operations that read references,
|
| 142 |
+
and compressing those loose references into the "packed-refs" file. The
|
| 143 |
+
"reftable" backend uses geometric compaction after every write, which
|
| 144 |
+
amortizes costs and ensures that the backend is always in a
|
| 145 |
+
well-maintained state.
|
| 146 |
+
** Operations that write multiple references at once are not atomic with the
|
| 147 |
+
"files" backend. Consequently, Git may see in-between states when it reads
|
| 148 |
+
references while a reference transaction is in the process of being
|
| 149 |
+
committed to disk.
|
| 150 |
+
** Writing many references at once is slow with the "files" backend because
|
| 151 |
+
every reference is created as a separate file. The "reftable" backend
|
| 152 |
+
significantly outperforms the "files" backend by multiple orders of
|
| 153 |
+
magnitude.
|
| 154 |
+
** The reftable backend uses a binary format with prefix compression for
|
| 155 |
+
reference names. As a result, the format uses less space compared to the
|
| 156 |
+
"packed-refs" file.
|
| 157 |
+
+
|
| 158 |
+
Users that get immediate benefit from the "reftable" backend could continue to
|
| 159 |
+
opt-in to the "reftable" format manually by setting the "init.defaultRefFormat"
|
| 160 |
+
config. But defaults matter, and we think that overall users will have a better
|
| 161 |
+
experience with less platform-specific quirks when they use the new backend by
|
| 162 |
+
default.
|
| 163 |
+
+
|
| 164 |
+
A prerequisite for this change is that the ecosystem is ready to support the
|
| 165 |
+
"reftable" format. Most importantly, alternative implementations of Git like
|
| 166 |
+
JGit, libgit2 and Gitoxide need to support it.
|
| 167 |
+
|
| 168 |
+
* In new repositories, the default branch name will be `main`. We have been
|
| 169 |
+
warning that the default name will change since 675704c74dd (init:
|
| 170 |
+
provide useful advice about init.defaultBranch, 2020-12-11). The new name
|
| 171 |
+
matches the default branch name used in new repositories by many of the
|
| 172 |
+
big Git forges.
|
| 173 |
+
|
| 174 |
+
* Git will require Rust as a mandatory part of the build process. While Git
|
| 175 |
+
already started to adopt Rust in Git 2.49, all parts written in Rust are
|
| 176 |
+
optional for the time being. This includes:
|
| 177 |
+
+
|
| 178 |
+
** The Rust wrapper around libgit.a that is part of "contrib/" and which has
|
| 179 |
+
been introduced in Git 2.49.
|
| 180 |
+
** Subsystems that have an alternative implementation in Rust to test
|
| 181 |
+
interoperability between our C and Rust codebase.
|
| 182 |
+
** Newly written features that are not mission critical for a fully functional
|
| 183 |
+
Git client.
|
| 184 |
+
+
|
| 185 |
+
These changes are meant as test balloons to allow distributors of Git to prepare
|
| 186 |
+
for Rust becoming a mandatory part of the build process. There will be multiple
|
| 187 |
+
milestones for the introduction of Rust:
|
| 188 |
+
+
|
| 189 |
+
--
|
| 190 |
+
1. Initially, with Git 2.52, support for Rust will be auto-detected by Meson and
|
| 191 |
+
disabled in our Makefile so that the project can sort out the initial
|
| 192 |
+
infrastructure.
|
| 193 |
+
2. In Git 2.55, both build systems will default-enable support for Rust.
|
| 194 |
+
Consequently, builds will break by default if Rust is not available on the
|
| 195 |
+
build host. The use of Rust can still be explicitly disabled via build
|
| 196 |
+
flags.
|
| 197 |
+
3. In Git 3.0, the build options will be removed and support for Rust is
|
| 198 |
+
mandatory.
|
| 199 |
+
--
|
| 200 |
+
+
|
| 201 |
+
You can explicitly ask both Meson and our Makefile-based system to enable Rust
|
| 202 |
+
by saying `meson configure -Drust=enabled` and `make WITH_RUST=YesPlease`,
|
| 203 |
+
respectively.
|
| 204 |
+
+
|
| 205 |
+
The Git project will declare the last version before Git 3.0 to be a long-term
|
| 206 |
+
support release. This long-term release will receive important bug fixes for at
|
| 207 |
+
least four release cycles and security fixes for six release cycles. The Git
|
| 208 |
+
project will hand over maintainership of the long-term release to distributors
|
| 209 |
+
in case they need to extend the life of that long-term release even further.
|
| 210 |
+
Details of how this long-term release will be handed over to the community will
|
| 211 |
+
be discussed once the Git project decides to stop officially supporting it.
|
| 212 |
+
+
|
| 213 |
+
We will evaluate the impact on downstream distributions before making Rust
|
| 214 |
+
mandatory in Git 3.0. If we see that the impact on downstream distributions
|
| 215 |
+
would be significant, we may decide to defer this change to a subsequent minor
|
| 216 |
+
release. This evaluation will also take into account our own experience with
|
| 217 |
+
how painful it is to keep Rust an optional component.
|
| 218 |
+
|
| 219 |
+
=== Removals
|
| 220 |
+
|
| 221 |
+
* Support for grafting commits has long been superseded by git-replace(1).
|
| 222 |
+
Grafts are inferior to replacement refs:
|
| 223 |
+
+
|
| 224 |
+
** Grafts are a local-only mechanism and cannot be shared across
|
| 225 |
+
repositories.
|
| 226 |
+
** Grafts can lead to hard-to-diagnose problems when transferring objects
|
| 227 |
+
between repositories.
|
| 228 |
+
+
|
| 229 |
+
The grafting mechanism has been marked as outdated since e650d0643b (docs: mark
|
| 230 |
+
info/grafts as outdated, 2014-03-05) and will be removed.
|
| 231 |
+
+
|
| 232 |
+
Cf. <20140304174806.GA11561@sigill.intra.peff.net>.
|
| 233 |
+
|
| 234 |
+
* The git-pack-redundant(1) command can be used to remove redundant pack files.
|
| 235 |
+
The subcommand is unusably slow and the reason why nobody reports it as a
|
| 236 |
+
performance bug is suspected to be the absence of users. We have nominated
|
| 237 |
+
the command for removal and have started to emit a user-visible warning in
|
| 238 |
+
c3b58472be (pack-redundant: gauge the usage before proposing its removal,
|
| 239 |
+
2020-08-25) whenever the command is executed.
|
| 240 |
+
+
|
| 241 |
+
So far there was a single complaint about somebody still using the command, but
|
| 242 |
+
that complaint did not cause us to reverse course. On the contrary, we have
|
| 243 |
+
doubled down on the deprecation and starting with 4406522b76 (pack-redundant:
|
| 244 |
+
escalate deprecation warning to an error, 2023-03-23), the command dies unless
|
| 245 |
+
the user passes the `--i-still-use-this` option.
|
| 246 |
+
+
|
| 247 |
+
There have not been any subsequent complaints, so this command will finally be
|
| 248 |
+
removed.
|
| 249 |
+
+
|
| 250 |
+
Cf. <xmqq1rjuz6n3.fsf_-_@gitster.c.googlers.com>,
|
| 251 |
+
<CAKvOHKAFXQwt4D8yUCCkf_TQL79mYaJ=KAKhtpDNTvHJFuX1NA@mail.gmail.com>,
|
| 252 |
+
<20230323204047.GA9290@coredump.intra.peff.net>,
|
| 253 |
+
|
| 254 |
+
* Support for storing shorthands for remote URLs in "$GIT_COMMON_DIR/branches/"
|
| 255 |
+
and "$GIT_COMMON_DIR/remotes/" has been long superseded by storing remotes in
|
| 256 |
+
the repository configuration.
|
| 257 |
+
+
|
| 258 |
+
The mechanism has originally been introduced in f170e4b39d ([PATCH] fetch/pull:
|
| 259 |
+
short-hand notation for remote repositories., 2005-07-16) and was superseded by
|
| 260 |
+
6687f8fea2 ([PATCH] Use .git/remote/origin, not .git/branches/origin.,
|
| 261 |
+
2005-08-20), where we switched from ".git/branches/" to ".git/remotes/". That
|
| 262 |
+
commit already mentions an upcoming deprecation of the ".git/branches/"
|
| 263 |
+
directory, and starting with a1d4aa7424 (Add repository-layout document.,
|
| 264 |
+
2005-09-01) we have also marked this layout as deprecated. Eventually we also
|
| 265 |
+
started to migrate away from ".git/remotes/" in favor of config-based remotes,
|
| 266 |
+
and we have marked the directory as legacy in 3d3d282146 (Documentation:
|
| 267 |
+
Grammar correction, wording fixes and cleanup, 2011-08-23)
|
| 268 |
+
+
|
| 269 |
+
As our documentation mentions, these directories are unlikely to be used in
|
| 270 |
+
modern repositories and most users aren't even aware of these mechanisms. They
|
| 271 |
+
have been deprecated for almost 20 years and 14 years respectively, and we are
|
| 272 |
+
not aware of any active users that have complained about this deprecation.
|
| 273 |
+
Furthermore, the ".git/branches/" directory is nowadays misleadingly named and
|
| 274 |
+
may cause confusion as "branches" are almost exclusively used in the context of
|
| 275 |
+
references.
|
| 276 |
+
+
|
| 277 |
+
These features will be removed.
|
| 278 |
+
|
| 279 |
+
* Support for "--stdin" option in the "name-rev" command was
|
| 280 |
+
deprecated (and hidden from the documentation) in the Git 2.40
|
| 281 |
+
timeframe, in preference to its synonym "--annotate-stdin". Git 3.0
|
| 282 |
+
removes the support for "--stdin" altogether.
|
| 283 |
+
|
| 284 |
+
* The git-whatchanged(1) command has outlived its usefulness more than
|
| 285 |
+
10 years ago, and takes more keystrokes to type than its rough
|
| 286 |
+
equivalent `git log --raw`. We have nominated the command for
|
| 287 |
+
removal, have changed the command to refuse to work unless the
|
| 288 |
+
`--i-still-use-this` option is given, and asked the users to report
|
| 289 |
+
when they do so.
|
| 290 |
+
+
|
| 291 |
+
The command will be removed.
|
| 292 |
+
|
| 293 |
+
* Support for `core.commentString=auto` has been deprecated and will
|
| 294 |
+
be removed in Git 3.0.
|
| 295 |
+
+
|
| 296 |
+
cf. <xmqqa59i45wc.fsf@gitster.g>
|
| 297 |
+
|
| 298 |
+
* Support for `core.preferSymlinkRefs=true` has been deprecated and will be
|
| 299 |
+
removed in Git 3.0. Writing symbolic refs as symbolic links will be phased
|
| 300 |
+
out in favor of using plain files using the textual representation of
|
| 301 |
+
symbolic refs.
|
| 302 |
+
+
|
| 303 |
+
Symbolic references were initially always stored as a symbolic link. This was
|
| 304 |
+
changed in 9b143c6e15 (Teach update-ref about a symbolic ref stored in a
|
| 305 |
+
textfile., 2005-09-25), where a new textual symref format was introduced to
|
| 306 |
+
store those symbolic refs in a plain file. In 9f0bb90d16
|
| 307 |
+
(core.prefersymlinkrefs: use symlinks for .git/HEAD, 2006-05-02), the Git
|
| 308 |
+
project switched the default to use the textual symrefs in favor of symbolic
|
| 309 |
+
links.
|
| 310 |
+
+
|
| 311 |
+
The migration away from symbolic links has happened almost 20 years ago by now,
|
| 312 |
+
and there is no known reason why one should prefer them nowadays. Furthermore,
|
| 313 |
+
symbolic links are not supported on some platforms.
|
| 314 |
+
+
|
| 315 |
+
Note that only the writing side for such symbolic links is deprecated. Reading
|
| 316 |
+
such symbolic links is still supported for now.
|
| 317 |
+
|
| 318 |
+
== Superseded features that will not be deprecated
|
| 319 |
+
|
| 320 |
+
Some features have gained newer replacements that aim to improve the design in
|
| 321 |
+
certain ways. The fact that there is a replacement does not automatically mean
|
| 322 |
+
that the old way of doing things will eventually be removed. This section tracks
|
| 323 |
+
those features with newer alternatives.
|
| 324 |
+
|
| 325 |
+
* The features git-checkout(1) offers are covered by the pair of commands
|
| 326 |
+
git-restore(1) and git-switch(1). Because the use of git-checkout(1) is still
|
| 327 |
+
widespread, and it is not expected that this will change anytime soon, all
|
| 328 |
+
three commands will stay.
|
| 329 |
+
+
|
| 330 |
+
This decision may get revisited in case we ever figure out that there are
|
| 331 |
+
almost no users of any of the commands anymore.
|
| 332 |
+
+
|
| 333 |
+
Cf. <xmqqttjazwwa.fsf@gitster.g>,
|
| 334 |
+
<xmqqleeubork.fsf@gitster.g>,
|
| 335 |
+
<112b6568912a6de6672bf5592c3a718e@manjaro.org>.
|
git/mingw64/share/doc/git-doc/BreakingChanges.html
ADDED
|
@@ -0,0 +1,940 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>Upcoming breaking changes</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="article">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>Upcoming breaking changes</h1>
|
| 445 |
+
</div>
|
| 446 |
+
<div id="content">
|
| 447 |
+
<div id="preamble">
|
| 448 |
+
<div class="sectionbody">
|
| 449 |
+
<div class="paragraph">
|
| 450 |
+
<p>The Git project aims to ensure backwards compatibility to the best extent
|
| 451 |
+
possible. Minor releases will not break backwards compatibility unless there is
|
| 452 |
+
a very strong reason to do so, like for example a security vulnerability.</p>
|
| 453 |
+
</div>
|
| 454 |
+
<div class="paragraph">
|
| 455 |
+
<p>Regardless of that, due to the age of the Git project, it is only natural to
|
| 456 |
+
accumulate a backlog of backwards-incompatible changes that will eventually be
|
| 457 |
+
required to keep the project aligned with a changing world. These changes fall
|
| 458 |
+
into several categories:</p>
|
| 459 |
+
</div>
|
| 460 |
+
<div class="ulist">
|
| 461 |
+
<ul>
|
| 462 |
+
<li>
|
| 463 |
+
<p>Changes to long established defaults.</p>
|
| 464 |
+
</li>
|
| 465 |
+
<li>
|
| 466 |
+
<p>Concepts that have been replaced with a superior design.</p>
|
| 467 |
+
</li>
|
| 468 |
+
<li>
|
| 469 |
+
<p>Concepts, commands, configuration or options that have been lacking in major
|
| 470 |
+
ways and that cannot be fixed and which will thus be removed without any
|
| 471 |
+
replacement.</p>
|
| 472 |
+
</li>
|
| 473 |
+
</ul>
|
| 474 |
+
</div>
|
| 475 |
+
<div class="paragraph">
|
| 476 |
+
<p>Explicitly not included in this list are fixes to minor bugs that may cause a
|
| 477 |
+
change in user-visible behavior.</p>
|
| 478 |
+
</div>
|
| 479 |
+
<div class="paragraph">
|
| 480 |
+
<p>The Git project irregularly releases breaking versions that deliberately break
|
| 481 |
+
backwards compatibility with older versions. This is done to ensure that Git
|
| 482 |
+
remains relevant, safe and maintainable going forward. The release cadence of
|
| 483 |
+
breaking versions is typically measured in multiple years. We had the following
|
| 484 |
+
major breaking releases in the past:</p>
|
| 485 |
+
</div>
|
| 486 |
+
<div class="ulist">
|
| 487 |
+
<ul>
|
| 488 |
+
<li>
|
| 489 |
+
<p>Git 1.6.0, released in August 2008.</p>
|
| 490 |
+
</li>
|
| 491 |
+
<li>
|
| 492 |
+
<p>Git 2.0, released in May 2014.</p>
|
| 493 |
+
</li>
|
| 494 |
+
</ul>
|
| 495 |
+
</div>
|
| 496 |
+
<div class="paragraph">
|
| 497 |
+
<p>We use <major>.<minor> release numbers these days, starting from Git 2.0. For
|
| 498 |
+
future releases, our plan is to increment <major> in the release number when we
|
| 499 |
+
make the next breaking release. Before Git 2.0, the release numbers were
|
| 500 |
+
1.<major>.<minor> with the intention to increment <major> for "usual" breaking
|
| 501 |
+
releases, reserving the jump to Git 2.0 for really large backward-compatibility
|
| 502 |
+
breaking changes.</p>
|
| 503 |
+
</div>
|
| 504 |
+
<div class="paragraph">
|
| 505 |
+
<p>The intent of this document is to track upcoming deprecations for future
|
| 506 |
+
breaking releases. Furthermore, this document also tracks what will <em>not</em> be
|
| 507 |
+
deprecated. This is done such that the outcome of discussions document both
|
| 508 |
+
when the discussion favors deprecation, but also when it rejects a deprecation.</p>
|
| 509 |
+
</div>
|
| 510 |
+
<div class="paragraph">
|
| 511 |
+
<p>Items should have a clear summary of the reasons why we do or do not want to
|
| 512 |
+
make the described change that can be easily understood without having to read
|
| 513 |
+
the mailing list discussions. If there are alternatives to the changed feature,
|
| 514 |
+
those alternatives should be pointed out to our users.</p>
|
| 515 |
+
</div>
|
| 516 |
+
<div class="paragraph">
|
| 517 |
+
<p>All items should be accompanied by references to relevant mailing list threads
|
| 518 |
+
where the deprecation was discussed. These references use message-IDs, which
|
| 519 |
+
can visited via</p>
|
| 520 |
+
</div>
|
| 521 |
+
<div class="literalblock">
|
| 522 |
+
<div class="content">
|
| 523 |
+
<pre>https://lore.kernel.org/git/$message_id/</pre>
|
| 524 |
+
</div>
|
| 525 |
+
</div>
|
| 526 |
+
<div class="paragraph">
|
| 527 |
+
<p>to see the message and its surrounding discussion. Such a reference is there to
|
| 528 |
+
make it easier for you to find how the project reached consensus on the
|
| 529 |
+
described item back then.</p>
|
| 530 |
+
</div>
|
| 531 |
+
<div class="paragraph">
|
| 532 |
+
<p>This is a living document as the environment surrounding the project changes
|
| 533 |
+
over time. If circumstances change, an earlier decision to deprecate or change
|
| 534 |
+
something may need to be revisited from time to time. So do not take items on
|
| 535 |
+
this list to mean "it is settled, do not waste our time bringing it up again".</p>
|
| 536 |
+
</div>
|
| 537 |
+
</div>
|
| 538 |
+
</div>
|
| 539 |
+
<div class="sect1">
|
| 540 |
+
<h2 id="_procedure">Procedure</h2>
|
| 541 |
+
<div class="sectionbody">
|
| 542 |
+
<div class="paragraph">
|
| 543 |
+
<p>Discussing the desire to make breaking changes, declaring that breaking
|
| 544 |
+
changes are made at a certain version boundary, and recording these
|
| 545 |
+
decisions in this document, are necessary but not sufficient.
|
| 546 |
+
Because such changes are expected to be numerous, and the design and
|
| 547 |
+
implementation of them are expected to span over time, they have to
|
| 548 |
+
be deployable trivially at such a version boundary, prepared over long
|
| 549 |
+
time.</p>
|
| 550 |
+
</div>
|
| 551 |
+
<div class="paragraph">
|
| 552 |
+
<p>The breaking changes MUST be guarded with the a compile-time switch,
|
| 553 |
+
WITH_BREAKING_CHANGES, to help this process. When built with it,
|
| 554 |
+
the resulting Git binary together with its documentation would
|
| 555 |
+
behave as if these breaking changes slated for the next big version
|
| 556 |
+
boundary are already in effect. We also have a CI job to exercise
|
| 557 |
+
the work-in-progress version of Git with these breaking changes.</p>
|
| 558 |
+
</div>
|
| 559 |
+
</div>
|
| 560 |
+
</div>
|
| 561 |
+
<div class="sect1">
|
| 562 |
+
<h2 id="_git_3_0">Git 3.0</h2>
|
| 563 |
+
<div class="sectionbody">
|
| 564 |
+
<div class="paragraph">
|
| 565 |
+
<p>The following subsections document upcoming breaking changes for Git 3.0. There
|
| 566 |
+
is no planned release date for this breaking version yet.</p>
|
| 567 |
+
</div>
|
| 568 |
+
<div class="paragraph">
|
| 569 |
+
<p>Proposed changes and removals only include items which are "ready" to be done.
|
| 570 |
+
In other words, this is not supposed to be a wishlist of features that should
|
| 571 |
+
be changed to or replaced in case the alternative was implemented already.</p>
|
| 572 |
+
</div>
|
| 573 |
+
<div class="sect2">
|
| 574 |
+
<h3 id="_changes">Changes</h3>
|
| 575 |
+
<div class="ulist">
|
| 576 |
+
<ul>
|
| 577 |
+
<li>
|
| 578 |
+
<p>The default hash function for new repositories will be changed from "sha1"
|
| 579 |
+
to "sha256". SHA-1 has been deprecated by NIST in 2011 and is nowadays
|
| 580 |
+
recommended against in FIPS 140-2 and similar certifications. Furthermore,
|
| 581 |
+
there are practical attacks on SHA-1 that weaken its cryptographic properties:</p>
|
| 582 |
+
<div class="ulist">
|
| 583 |
+
<ul>
|
| 584 |
+
<li>
|
| 585 |
+
<p>The SHAppening (2015). The first demonstration of a practical attack
|
| 586 |
+
against SHA-1 with 2^57 operations.</p>
|
| 587 |
+
</li>
|
| 588 |
+
<li>
|
| 589 |
+
<p>SHAttered (2017). Generation of two valid PDF files with 2^63 operations.</p>
|
| 590 |
+
</li>
|
| 591 |
+
<li>
|
| 592 |
+
<p>Birthday-Near-Collision (2019). This attack allows for chosen prefix
|
| 593 |
+
attacks with 2^68 operations.</p>
|
| 594 |
+
</li>
|
| 595 |
+
<li>
|
| 596 |
+
<p>Shambles (2020). This attack allows for chosen prefix attacks with 2^63
|
| 597 |
+
operations.</p>
|
| 598 |
+
<div class="paragraph">
|
| 599 |
+
<p>While we have protections in place against known attacks, it is expected
|
| 600 |
+
that more attacks against SHA-1 will be found by future research. Paired
|
| 601 |
+
with the ever-growing capability of hardware, it is only a matter of time
|
| 602 |
+
before SHA-1 will be considered broken completely. We want to be prepared
|
| 603 |
+
and will thus change the default hash algorithm to "sha256" for newly
|
| 604 |
+
initialized repositories.</p>
|
| 605 |
+
</div>
|
| 606 |
+
<div class="paragraph">
|
| 607 |
+
<p>An important requirement for this change is that the ecosystem is ready to
|
| 608 |
+
support the "sha256" object format. This includes popular Git libraries,
|
| 609 |
+
applications and forges.</p>
|
| 610 |
+
</div>
|
| 611 |
+
<div class="paragraph">
|
| 612 |
+
<p>There is no plan to deprecate the "sha1" object format at this point in time.</p>
|
| 613 |
+
</div>
|
| 614 |
+
<div class="paragraph">
|
| 615 |
+
<p>Cf. <<a href="mailto:2f5de416-04ba-c23d-1e0b-83bb655829a7@zombino.com">2f5de416-04ba-c23d-1e0b-83bb655829a7@zombino.com</a>>,
|
| 616 |
+
<20170223155046.e7nxivfwqqoprsqj@LykOS.localdomain>,
|
| 617 |
+
<CA+EOSBncr=<a href="mailto:4a4d8n9xS4FNehyebpmX8JiUwCsXD47EQDE+DiUQ@mail.gmail.com">4a4d8n9xS4FNehyebpmX8JiUwCsXD47EQDE+DiUQ@mail.gmail.com</a>>.</p>
|
| 618 |
+
</div>
|
| 619 |
+
</li>
|
| 620 |
+
</ul>
|
| 621 |
+
</div>
|
| 622 |
+
</li>
|
| 623 |
+
<li>
|
| 624 |
+
<p>The default storage format for references in newly created repositories will
|
| 625 |
+
be changed from "files" to "reftable". The "reftable" format provides
|
| 626 |
+
multiple advantages over the "files" format:</p>
|
| 627 |
+
<div class="ulist">
|
| 628 |
+
<ul>
|
| 629 |
+
<li>
|
| 630 |
+
<p>It is impossible to store two references that only differ in casing on
|
| 631 |
+
case-insensitive filesystems with the "files" format. This issue is common
|
| 632 |
+
on Windows and macOS platforms. As the "reftable" backend does not use
|
| 633 |
+
filesystem paths to encode reference names this problem goes away.</p>
|
| 634 |
+
</li>
|
| 635 |
+
<li>
|
| 636 |
+
<p>Similarly, macOS normalizes path names that contain unicode characters,
|
| 637 |
+
which has the consequence that you cannot store two names with unicode
|
| 638 |
+
characters that are encoded differently with the "files" backend. Again,
|
| 639 |
+
this is not an issue with the "reftable" backend.</p>
|
| 640 |
+
</li>
|
| 641 |
+
<li>
|
| 642 |
+
<p>Deleting references with the "files" backend requires Git to rewrite the
|
| 643 |
+
complete "packed-refs" file. In large repositories with many references
|
| 644 |
+
this file can easily be dozens of megabytes in size, in extreme cases it
|
| 645 |
+
may be gigabytes. The "reftable" backend uses tombstone markers for
|
| 646 |
+
deleted references and thus does not have to rewrite all of its data.</p>
|
| 647 |
+
</li>
|
| 648 |
+
<li>
|
| 649 |
+
<p>Repository housekeeping with the "files" backend typically performs
|
| 650 |
+
all-into-one repacks of references. This can be quite expensive, and
|
| 651 |
+
consequently housekeeping is a tradeoff between the number of loose
|
| 652 |
+
references that accumulate and slow down operations that read references,
|
| 653 |
+
and compressing those loose references into the "packed-refs" file. The
|
| 654 |
+
"reftable" backend uses geometric compaction after every write, which
|
| 655 |
+
amortizes costs and ensures that the backend is always in a
|
| 656 |
+
well-maintained state.</p>
|
| 657 |
+
</li>
|
| 658 |
+
<li>
|
| 659 |
+
<p>Operations that write multiple references at once are not atomic with the
|
| 660 |
+
"files" backend. Consequently, Git may see in-between states when it reads
|
| 661 |
+
references while a reference transaction is in the process of being
|
| 662 |
+
committed to disk.</p>
|
| 663 |
+
</li>
|
| 664 |
+
<li>
|
| 665 |
+
<p>Writing many references at once is slow with the "files" backend because
|
| 666 |
+
every reference is created as a separate file. The "reftable" backend
|
| 667 |
+
significantly outperforms the "files" backend by multiple orders of
|
| 668 |
+
magnitude.</p>
|
| 669 |
+
</li>
|
| 670 |
+
<li>
|
| 671 |
+
<p>The reftable backend uses a binary format with prefix compression for
|
| 672 |
+
reference names. As a result, the format uses less space compared to the
|
| 673 |
+
"packed-refs" file.</p>
|
| 674 |
+
<div class="paragraph">
|
| 675 |
+
<p>Users that get immediate benefit from the "reftable" backend could continue to
|
| 676 |
+
opt-in to the "reftable" format manually by setting the "init.defaultRefFormat"
|
| 677 |
+
config. But defaults matter, and we think that overall users will have a better
|
| 678 |
+
experience with less platform-specific quirks when they use the new backend by
|
| 679 |
+
default.</p>
|
| 680 |
+
</div>
|
| 681 |
+
<div class="paragraph">
|
| 682 |
+
<p>A prerequisite for this change is that the ecosystem is ready to support the
|
| 683 |
+
"reftable" format. Most importantly, alternative implementations of Git like
|
| 684 |
+
JGit, libgit2 and Gitoxide need to support it.</p>
|
| 685 |
+
</div>
|
| 686 |
+
</li>
|
| 687 |
+
</ul>
|
| 688 |
+
</div>
|
| 689 |
+
</li>
|
| 690 |
+
<li>
|
| 691 |
+
<p>In new repositories, the default branch name will be <code>main</code>. We have been
|
| 692 |
+
warning that the default name will change since 675704c74dd (init:
|
| 693 |
+
provide useful advice about init.defaultBranch, 2020-12-11). The new name
|
| 694 |
+
matches the default branch name used in new repositories by many of the
|
| 695 |
+
big Git forges.</p>
|
| 696 |
+
</li>
|
| 697 |
+
<li>
|
| 698 |
+
<p>Git will require Rust as a mandatory part of the build process. While Git
|
| 699 |
+
already started to adopt Rust in Git 2.49, all parts written in Rust are
|
| 700 |
+
optional for the time being. This includes:</p>
|
| 701 |
+
<div class="ulist">
|
| 702 |
+
<ul>
|
| 703 |
+
<li>
|
| 704 |
+
<p>The Rust wrapper around libgit.a that is part of "contrib/" and which has
|
| 705 |
+
been introduced in Git 2.49.</p>
|
| 706 |
+
</li>
|
| 707 |
+
<li>
|
| 708 |
+
<p>Subsystems that have an alternative implementation in Rust to test
|
| 709 |
+
interoperability between our C and Rust codebase.</p>
|
| 710 |
+
</li>
|
| 711 |
+
<li>
|
| 712 |
+
<p>Newly written features that are not mission critical for a fully functional
|
| 713 |
+
Git client.</p>
|
| 714 |
+
<div class="paragraph">
|
| 715 |
+
<p>These changes are meant as test balloons to allow distributors of Git to prepare
|
| 716 |
+
for Rust becoming a mandatory part of the build process. There will be multiple
|
| 717 |
+
milestones for the introduction of Rust:</p>
|
| 718 |
+
</div>
|
| 719 |
+
<div class="openblock">
|
| 720 |
+
<div class="content">
|
| 721 |
+
<div class="olist arabic">
|
| 722 |
+
<ol class="arabic">
|
| 723 |
+
<li>
|
| 724 |
+
<p>Initially, with Git 2.52, support for Rust will be auto-detected by Meson and
|
| 725 |
+
disabled in our Makefile so that the project can sort out the initial
|
| 726 |
+
infrastructure.</p>
|
| 727 |
+
</li>
|
| 728 |
+
<li>
|
| 729 |
+
<p>In Git 2.55, both build systems will default-enable support for Rust.
|
| 730 |
+
Consequently, builds will break by default if Rust is not available on the
|
| 731 |
+
build host. The use of Rust can still be explicitly disabled via build
|
| 732 |
+
flags.</p>
|
| 733 |
+
</li>
|
| 734 |
+
<li>
|
| 735 |
+
<p>In Git 3.0, the build options will be removed and support for Rust is
|
| 736 |
+
mandatory.</p>
|
| 737 |
+
</li>
|
| 738 |
+
</ol>
|
| 739 |
+
</div>
|
| 740 |
+
</div>
|
| 741 |
+
</div>
|
| 742 |
+
<div class="paragraph">
|
| 743 |
+
<p>You can explicitly ask both Meson and our Makefile-based system to enable Rust
|
| 744 |
+
by saying <code>meson</code> <code>configure</code> <code>-Drust=enabled</code> and <code>make</code> <code>WITH_RUST=YesPlease</code>,
|
| 745 |
+
respectively.</p>
|
| 746 |
+
</div>
|
| 747 |
+
<div class="paragraph">
|
| 748 |
+
<p>The Git project will declare the last version before Git 3.0 to be a long-term
|
| 749 |
+
support release. This long-term release will receive important bug fixes for at
|
| 750 |
+
least four release cycles and security fixes for six release cycles. The Git
|
| 751 |
+
project will hand over maintainership of the long-term release to distributors
|
| 752 |
+
in case they need to extend the life of that long-term release even further.
|
| 753 |
+
Details of how this long-term release will be handed over to the community will
|
| 754 |
+
be discussed once the Git project decides to stop officially supporting it.</p>
|
| 755 |
+
</div>
|
| 756 |
+
<div class="paragraph">
|
| 757 |
+
<p>We will evaluate the impact on downstream distributions before making Rust
|
| 758 |
+
mandatory in Git 3.0. If we see that the impact on downstream distributions
|
| 759 |
+
would be significant, we may decide to defer this change to a subsequent minor
|
| 760 |
+
release. This evaluation will also take into account our own experience with
|
| 761 |
+
how painful it is to keep Rust an optional component.</p>
|
| 762 |
+
</div>
|
| 763 |
+
</li>
|
| 764 |
+
</ul>
|
| 765 |
+
</div>
|
| 766 |
+
</li>
|
| 767 |
+
</ul>
|
| 768 |
+
</div>
|
| 769 |
+
</div>
|
| 770 |
+
<div class="sect2">
|
| 771 |
+
<h3 id="_removals">Removals</h3>
|
| 772 |
+
<div class="ulist">
|
| 773 |
+
<ul>
|
| 774 |
+
<li>
|
| 775 |
+
<p>Support for grafting commits has long been superseded by git-replace(1).
|
| 776 |
+
Grafts are inferior to replacement refs:</p>
|
| 777 |
+
<div class="ulist">
|
| 778 |
+
<ul>
|
| 779 |
+
<li>
|
| 780 |
+
<p>Grafts are a local-only mechanism and cannot be shared across
|
| 781 |
+
repositories.</p>
|
| 782 |
+
</li>
|
| 783 |
+
<li>
|
| 784 |
+
<p>Grafts can lead to hard-to-diagnose problems when transferring objects
|
| 785 |
+
between repositories.</p>
|
| 786 |
+
<div class="paragraph">
|
| 787 |
+
<p>The grafting mechanism has been marked as outdated since e650d0643b (docs: mark
|
| 788 |
+
info/grafts as outdated, 2014-03-05) and will be removed.</p>
|
| 789 |
+
</div>
|
| 790 |
+
<div class="paragraph">
|
| 791 |
+
<p>Cf. <<a href="mailto:20140304174806.GA11561@sigill.intra.peff.net">20140304174806.GA11561@sigill.intra.peff.net</a>>.</p>
|
| 792 |
+
</div>
|
| 793 |
+
</li>
|
| 794 |
+
</ul>
|
| 795 |
+
</div>
|
| 796 |
+
</li>
|
| 797 |
+
<li>
|
| 798 |
+
<p>The git-pack-redundant(1) command can be used to remove redundant pack files.
|
| 799 |
+
The subcommand is unusably slow and the reason why nobody reports it as a
|
| 800 |
+
performance bug is suspected to be the absence of users. We have nominated
|
| 801 |
+
the command for removal and have started to emit a user-visible warning in
|
| 802 |
+
c3b58472be (pack-redundant: gauge the usage before proposing its removal,
|
| 803 |
+
2020-08-25) whenever the command is executed.</p>
|
| 804 |
+
<div class="paragraph">
|
| 805 |
+
<p>So far there was a single complaint about somebody still using the command, but
|
| 806 |
+
that complaint did not cause us to reverse course. On the contrary, we have
|
| 807 |
+
doubled down on the deprecation and starting with 4406522b76 (pack-redundant:
|
| 808 |
+
escalate deprecation warning to an error, 2023-03-23), the command dies unless
|
| 809 |
+
the user passes the <code>--i-still-use-this</code> option.</p>
|
| 810 |
+
</div>
|
| 811 |
+
<div class="paragraph">
|
| 812 |
+
<p>There have not been any subsequent complaints, so this command will finally be
|
| 813 |
+
removed.</p>
|
| 814 |
+
</div>
|
| 815 |
+
<div class="paragraph">
|
| 816 |
+
<p>Cf. <<a href="mailto:xmqq1rjuz6n3.fsf_-_@gitster.c.googlers.com">xmqq1rjuz6n3.fsf_-_@gitster.c.googlers.com</a>>,
|
| 817 |
+
<CAKvOHKAFXQwt4D8yUCCkf_TQL79mYaJ=<a href="mailto:KAKhtpDNTvHJFuX1NA@mail.gmail.com">KAKhtpDNTvHJFuX1NA@mail.gmail.com</a>>,
|
| 818 |
+
<<a href="mailto:20230323204047.GA9290@coredump.intra.peff.net">20230323204047.GA9290@coredump.intra.peff.net</a>>,</p>
|
| 819 |
+
</div>
|
| 820 |
+
</li>
|
| 821 |
+
<li>
|
| 822 |
+
<p>Support for storing shorthands for remote URLs in "$GIT_COMMON_DIR/branches/"
|
| 823 |
+
and "$GIT_COMMON_DIR/remotes/" has been long superseded by storing remotes in
|
| 824 |
+
the repository configuration.</p>
|
| 825 |
+
<div class="paragraph">
|
| 826 |
+
<p>The mechanism has originally been introduced in f170e4b39d ([PATCH] fetch/pull:
|
| 827 |
+
short-hand notation for remote repositories., 2005-07-16) and was superseded by
|
| 828 |
+
6687f8fea2 ([PATCH] Use .git/remote/origin, not .git/branches/origin.,
|
| 829 |
+
2005-08-20), where we switched from ".git/branches/" to ".git/remotes/". That
|
| 830 |
+
commit already mentions an upcoming deprecation of the ".git/branches/"
|
| 831 |
+
directory, and starting with a1d4aa7424 (Add repository-layout document.,
|
| 832 |
+
2005-09-01) we have also marked this layout as deprecated. Eventually we also
|
| 833 |
+
started to migrate away from ".git/remotes/" in favor of config-based remotes,
|
| 834 |
+
and we have marked the directory as legacy in 3d3d282146 (Documentation:
|
| 835 |
+
Grammar correction, wording fixes and cleanup, 2011-08-23)</p>
|
| 836 |
+
</div>
|
| 837 |
+
<div class="paragraph">
|
| 838 |
+
<p>As our documentation mentions, these directories are unlikely to be used in
|
| 839 |
+
modern repositories and most users aren’t even aware of these mechanisms. They
|
| 840 |
+
have been deprecated for almost 20 years and 14 years respectively, and we are
|
| 841 |
+
not aware of any active users that have complained about this deprecation.
|
| 842 |
+
Furthermore, the ".git/branches/" directory is nowadays misleadingly named and
|
| 843 |
+
may cause confusion as "branches" are almost exclusively used in the context of
|
| 844 |
+
references.</p>
|
| 845 |
+
</div>
|
| 846 |
+
<div class="paragraph">
|
| 847 |
+
<p>These features will be removed.</p>
|
| 848 |
+
</div>
|
| 849 |
+
</li>
|
| 850 |
+
<li>
|
| 851 |
+
<p>Support for "--stdin" option in the "name-rev" command was
|
| 852 |
+
deprecated (and hidden from the documentation) in the Git 2.40
|
| 853 |
+
timeframe, in preference to its synonym "--annotate-stdin". Git 3.0
|
| 854 |
+
removes the support for "--stdin" altogether.</p>
|
| 855 |
+
</li>
|
| 856 |
+
<li>
|
| 857 |
+
<p>The git-whatchanged(1) command has outlived its usefulness more than
|
| 858 |
+
10 years ago, and takes more keystrokes to type than its rough
|
| 859 |
+
equivalent <code>git</code> <code>log</code> <code>--raw</code>. We have nominated the command for
|
| 860 |
+
removal, have changed the command to refuse to work unless the
|
| 861 |
+
<code>--i-still-use-this</code> option is given, and asked the users to report
|
| 862 |
+
when they do so.</p>
|
| 863 |
+
<div class="paragraph">
|
| 864 |
+
<p>The command will be removed.</p>
|
| 865 |
+
</div>
|
| 866 |
+
</li>
|
| 867 |
+
<li>
|
| 868 |
+
<p>Support for <code>core.commentString=auto</code> has been deprecated and will
|
| 869 |
+
be removed in Git 3.0.</p>
|
| 870 |
+
<div class="paragraph">
|
| 871 |
+
<p>cf. <xmqqa59i45wc.fsf@gitster.g></p>
|
| 872 |
+
</div>
|
| 873 |
+
</li>
|
| 874 |
+
<li>
|
| 875 |
+
<p>Support for <code>core.preferSymlinkRefs=true</code> has been deprecated and will be
|
| 876 |
+
removed in Git 3.0. Writing symbolic refs as symbolic links will be phased
|
| 877 |
+
out in favor of using plain files using the textual representation of
|
| 878 |
+
symbolic refs.</p>
|
| 879 |
+
<div class="paragraph">
|
| 880 |
+
<p>Symbolic references were initially always stored as a symbolic link. This was
|
| 881 |
+
changed in 9b143c6e15 (Teach update-ref about a symbolic ref stored in a
|
| 882 |
+
textfile., 2005-09-25), where a new textual symref format was introduced to
|
| 883 |
+
store those symbolic refs in a plain file. In 9f0bb90d16
|
| 884 |
+
(core.prefersymlinkrefs: use symlinks for .git/HEAD, 2006-05-02), the Git
|
| 885 |
+
project switched the default to use the textual symrefs in favor of symbolic
|
| 886 |
+
links.</p>
|
| 887 |
+
</div>
|
| 888 |
+
<div class="paragraph">
|
| 889 |
+
<p>The migration away from symbolic links has happened almost 20 years ago by now,
|
| 890 |
+
and there is no known reason why one should prefer them nowadays. Furthermore,
|
| 891 |
+
symbolic links are not supported on some platforms.</p>
|
| 892 |
+
</div>
|
| 893 |
+
<div class="paragraph">
|
| 894 |
+
<p>Note that only the writing side for such symbolic links is deprecated. Reading
|
| 895 |
+
such symbolic links is still supported for now.</p>
|
| 896 |
+
</div>
|
| 897 |
+
</li>
|
| 898 |
+
</ul>
|
| 899 |
+
</div>
|
| 900 |
+
</div>
|
| 901 |
+
</div>
|
| 902 |
+
</div>
|
| 903 |
+
<div class="sect1">
|
| 904 |
+
<h2 id="_superseded_features_that_will_not_be_deprecated">Superseded features that will not be deprecated</h2>
|
| 905 |
+
<div class="sectionbody">
|
| 906 |
+
<div class="paragraph">
|
| 907 |
+
<p>Some features have gained newer replacements that aim to improve the design in
|
| 908 |
+
certain ways. The fact that there is a replacement does not automatically mean
|
| 909 |
+
that the old way of doing things will eventually be removed. This section tracks
|
| 910 |
+
those features with newer alternatives.</p>
|
| 911 |
+
</div>
|
| 912 |
+
<div class="ulist">
|
| 913 |
+
<ul>
|
| 914 |
+
<li>
|
| 915 |
+
<p>The features git-checkout(1) offers are covered by the pair of commands
|
| 916 |
+
git-restore(1) and git-switch(1). Because the use of git-checkout(1) is still
|
| 917 |
+
widespread, and it is not expected that this will change anytime soon, all
|
| 918 |
+
three commands will stay.</p>
|
| 919 |
+
<div class="paragraph">
|
| 920 |
+
<p>This decision may get revisited in case we ever figure out that there are
|
| 921 |
+
almost no users of any of the commands anymore.</p>
|
| 922 |
+
</div>
|
| 923 |
+
<div class="paragraph">
|
| 924 |
+
<p>Cf. <xmqqttjazwwa.fsf@gitster.g>,
|
| 925 |
+
<xmqqleeubork.fsf@gitster.g>,
|
| 926 |
+
<<a href="mailto:112b6568912a6de6672bf5592c3a718e@manjaro.org">112b6568912a6de6672bf5592c3a718e@manjaro.org</a>>.</p>
|
| 927 |
+
</div>
|
| 928 |
+
</li>
|
| 929 |
+
</ul>
|
| 930 |
+
</div>
|
| 931 |
+
</div>
|
| 932 |
+
</div>
|
| 933 |
+
</div>
|
| 934 |
+
<div id="footer">
|
| 935 |
+
<div id="footer-text">
|
| 936 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 937 |
+
</div>
|
| 938 |
+
</div>
|
| 939 |
+
</body>
|
| 940 |
+
</html>
|
git/mingw64/share/doc/git-doc/DecisionMaking.adoc
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Decision-Making Process in the Git Project
|
| 2 |
+
==========================================
|
| 3 |
+
|
| 4 |
+
Introduction
|
| 5 |
+
------------
|
| 6 |
+
This document describes the current decision-making process in the Git
|
| 7 |
+
project. It is a descriptive rather than prescriptive doc; that is, we want to
|
| 8 |
+
describe how things work in practice rather than explicitly recommending any
|
| 9 |
+
particular process or changes to the current process.
|
| 10 |
+
|
| 11 |
+
Here we document how the project makes decisions for discussions
|
| 12 |
+
(with or without patches), in scale larger than an individual patch
|
| 13 |
+
series (which is fully covered by the SubmittingPatches document).
|
| 14 |
+
|
| 15 |
+
|
| 16 |
+
Larger Discussions (with patches)
|
| 17 |
+
---------------------------------
|
| 18 |
+
As with discussions on an individual patch series, starting a larger-scale
|
| 19 |
+
discussion often begins by sending a patch or series to the list. This might
|
| 20 |
+
take the form of an initial design doc, with implementation following in later
|
| 21 |
+
iterations of the series (for example,
|
| 22 |
+
link:https://lore.kernel.org/git/0169ce6fb9ccafc089b74ae406db0d1a8ff8ac65.1688165272.git.steadmon@google.com/[adding unit tests] or
|
| 23 |
+
link:https://lore.kernel.org/git/20200420235310.94493-1-emilyshaffer@google.com/[config-based hooks]),
|
| 24 |
+
or it might include a full implementation from the beginning.
|
| 25 |
+
In either case, discussion progresses the same way for an individual patch series,
|
| 26 |
+
until consensus is reached or the topic is dropped.
|
| 27 |
+
|
| 28 |
+
|
| 29 |
+
Larger Discussions (without patches)
|
| 30 |
+
------------------------------------
|
| 31 |
+
Occasionally, larger discussions might occur without an associated patch series.
|
| 32 |
+
These may be very large-scale technical decisions that are beyond the scope of
|
| 33 |
+
even a single large patch series, or they may be more open-ended,
|
| 34 |
+
policy-oriented discussions (examples:
|
| 35 |
+
link:https://lore.kernel.org/git/ZZ77NQkSuiRxRDwt@nand.local/[introducing Rust]
|
| 36 |
+
or link:https://lore.kernel.org/git/YHofmWcIAidkvJiD@google.com/[improving submodule UX]).
|
| 37 |
+
In either case, discussion progresses as described above for general patch series.
|
| 38 |
+
|
| 39 |
+
For larger discussions without a patch series or other concrete implementation,
|
| 40 |
+
it may be hard to judge when consensus has been reached, as there are not any
|
| 41 |
+
official guidelines. If discussion stalls at this point, it may be helpful to
|
| 42 |
+
restart discussion with an RFC patch series (such as a partial, unfinished
|
| 43 |
+
implementation or proof of concept) that can be more easily debated.
|
| 44 |
+
|
| 45 |
+
When consensus is reached that it is a good idea, the original
|
| 46 |
+
proposer is expected to coordinate the effort to make it happen,
|
| 47 |
+
with help from others who were involved in the discussion, as
|
| 48 |
+
needed.
|
| 49 |
+
|
| 50 |
+
For decisions that require code changes, it is often the case that the original
|
| 51 |
+
proposer will follow up with a patch series, although it is also common for
|
| 52 |
+
other interested parties to provide an implementation (or parts of the
|
| 53 |
+
implementation, for very large changes).
|
| 54 |
+
|
| 55 |
+
For non-technical decisions such as community norms or processes, it is up to
|
| 56 |
+
the community as a whole to implement and sustain agreed-upon changes.
|
| 57 |
+
The project leadership committee (PLC) may help the implementation of
|
| 58 |
+
policy decisions.
|
| 59 |
+
|
| 60 |
+
|
| 61 |
+
Other Discussion Venues
|
| 62 |
+
-----------------------
|
| 63 |
+
Occasionally decision proposals are presented off-list, e.g. at the semi-regular
|
| 64 |
+
Contributors' Summit. While higher-bandwidth face-to-face discussion is often
|
| 65 |
+
useful for quickly reaching consensus among attendees, generally we expect to
|
| 66 |
+
summarize the discussion in notes that can later be presented on-list. For an
|
| 67 |
+
example, see the thread
|
| 68 |
+
link:https://lore.kernel.org/git/AC2EB721-2979-43FD-922D-C5076A57F24B@jramsay.com.au/[Notes
|
| 69 |
+
from Git Contributor Summit, Los Angeles (April 5, 2020)] by James Ramsay.
|
| 70 |
+
|
| 71 |
+
We prefer that "official" discussion happens on the list so that the full
|
| 72 |
+
community has opportunity to engage in discussion. This also means that the
|
| 73 |
+
mailing list archives contain a more-or-less complete history of project
|
| 74 |
+
discussions and decisions.
|
git/mingw64/share/doc/git-doc/DecisionMaking.html
ADDED
|
@@ -0,0 +1,545 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>Decision-Making Process in the Git Project</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="article">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>Decision-Making Process in the Git Project</h1>
|
| 445 |
+
</div>
|
| 446 |
+
<div id="content">
|
| 447 |
+
<div class="sect1">
|
| 448 |
+
<h2 id="_introduction">Introduction</h2>
|
| 449 |
+
<div class="sectionbody">
|
| 450 |
+
<div class="paragraph">
|
| 451 |
+
<p>This document describes the current decision-making process in the Git
|
| 452 |
+
project. It is a descriptive rather than prescriptive doc; that is, we want to
|
| 453 |
+
describe how things work in practice rather than explicitly recommending any
|
| 454 |
+
particular process or changes to the current process.</p>
|
| 455 |
+
</div>
|
| 456 |
+
<div class="paragraph">
|
| 457 |
+
<p>Here we document how the project makes decisions for discussions
|
| 458 |
+
(with or without patches), in scale larger than an individual patch
|
| 459 |
+
series (which is fully covered by the SubmittingPatches document).</p>
|
| 460 |
+
</div>
|
| 461 |
+
</div>
|
| 462 |
+
</div>
|
| 463 |
+
<div class="sect1">
|
| 464 |
+
<h2 id="_larger_discussions_with_patches">Larger Discussions (with patches)</h2>
|
| 465 |
+
<div class="sectionbody">
|
| 466 |
+
<div class="paragraph">
|
| 467 |
+
<p>As with discussions on an individual patch series, starting a larger-scale
|
| 468 |
+
discussion often begins by sending a patch or series to the list. This might
|
| 469 |
+
take the form of an initial design doc, with implementation following in later
|
| 470 |
+
iterations of the series (for example,
|
| 471 |
+
<a href="https://lore.kernel.org/git/0169ce6fb9ccafc089b74ae406db0d1a8ff8ac65.1688165272.git.steadmon@google.com/">adding unit tests</a> or
|
| 472 |
+
<a href="https://lore.kernel.org/git/20200420235310.94493-1-emilyshaffer@google.com/">config-based hooks</a>),
|
| 473 |
+
or it might include a full implementation from the beginning.
|
| 474 |
+
In either case, discussion progresses the same way for an individual patch series,
|
| 475 |
+
until consensus is reached or the topic is dropped.</p>
|
| 476 |
+
</div>
|
| 477 |
+
</div>
|
| 478 |
+
</div>
|
| 479 |
+
<div class="sect1">
|
| 480 |
+
<h2 id="_larger_discussions_without_patches">Larger Discussions (without patches)</h2>
|
| 481 |
+
<div class="sectionbody">
|
| 482 |
+
<div class="paragraph">
|
| 483 |
+
<p>Occasionally, larger discussions might occur without an associated patch series.
|
| 484 |
+
These may be very large-scale technical decisions that are beyond the scope of
|
| 485 |
+
even a single large patch series, or they may be more open-ended,
|
| 486 |
+
policy-oriented discussions (examples:
|
| 487 |
+
<a href="https://lore.kernel.org/git/ZZ77NQkSuiRxRDwt@nand.local/">introducing Rust</a>
|
| 488 |
+
or <a href="https://lore.kernel.org/git/YHofmWcIAidkvJiD@google.com/">improving submodule UX</a>).
|
| 489 |
+
In either case, discussion progresses as described above for general patch series.</p>
|
| 490 |
+
</div>
|
| 491 |
+
<div class="paragraph">
|
| 492 |
+
<p>For larger discussions without a patch series or other concrete implementation,
|
| 493 |
+
it may be hard to judge when consensus has been reached, as there are not any
|
| 494 |
+
official guidelines. If discussion stalls at this point, it may be helpful to
|
| 495 |
+
restart discussion with an RFC patch series (such as a partial, unfinished
|
| 496 |
+
implementation or proof of concept) that can be more easily debated.</p>
|
| 497 |
+
</div>
|
| 498 |
+
<div class="paragraph">
|
| 499 |
+
<p>When consensus is reached that it is a good idea, the original
|
| 500 |
+
proposer is expected to coordinate the effort to make it happen,
|
| 501 |
+
with help from others who were involved in the discussion, as
|
| 502 |
+
needed.</p>
|
| 503 |
+
</div>
|
| 504 |
+
<div class="paragraph">
|
| 505 |
+
<p>For decisions that require code changes, it is often the case that the original
|
| 506 |
+
proposer will follow up with a patch series, although it is also common for
|
| 507 |
+
other interested parties to provide an implementation (or parts of the
|
| 508 |
+
implementation, for very large changes).</p>
|
| 509 |
+
</div>
|
| 510 |
+
<div class="paragraph">
|
| 511 |
+
<p>For non-technical decisions such as community norms or processes, it is up to
|
| 512 |
+
the community as a whole to implement and sustain agreed-upon changes.
|
| 513 |
+
The project leadership committee (PLC) may help the implementation of
|
| 514 |
+
policy decisions.</p>
|
| 515 |
+
</div>
|
| 516 |
+
</div>
|
| 517 |
+
</div>
|
| 518 |
+
<div class="sect1">
|
| 519 |
+
<h2 id="_other_discussion_venues">Other Discussion Venues</h2>
|
| 520 |
+
<div class="sectionbody">
|
| 521 |
+
<div class="paragraph">
|
| 522 |
+
<p>Occasionally decision proposals are presented off-list, e.g. at the semi-regular
|
| 523 |
+
Contributors' Summit. While higher-bandwidth face-to-face discussion is often
|
| 524 |
+
useful for quickly reaching consensus among attendees, generally we expect to
|
| 525 |
+
summarize the discussion in notes that can later be presented on-list. For an
|
| 526 |
+
example, see the thread
|
| 527 |
+
<a href="https://lore.kernel.org/git/AC2EB721-2979-43FD-922D-C5076A57F24B@jramsay.com.au/">Notes
|
| 528 |
+
from Git Contributor Summit, Los Angeles (April 5, 2020)</a> by James Ramsay.</p>
|
| 529 |
+
</div>
|
| 530 |
+
<div class="paragraph">
|
| 531 |
+
<p>We prefer that "official" discussion happens on the list so that the full
|
| 532 |
+
community has opportunity to engage in discussion. This also means that the
|
| 533 |
+
mailing list archives contain a more-or-less complete history of project
|
| 534 |
+
discussions and decisions.</p>
|
| 535 |
+
</div>
|
| 536 |
+
</div>
|
| 537 |
+
</div>
|
| 538 |
+
</div>
|
| 539 |
+
<div id="footer">
|
| 540 |
+
<div id="footer-text">
|
| 541 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 542 |
+
</div>
|
| 543 |
+
</div>
|
| 544 |
+
</body>
|
| 545 |
+
</html>
|
git/mingw64/share/doc/git-doc/blame-options.adoc
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
`-b`::
|
| 2 |
+
Show blank SHA-1 for boundary commits. This can also
|
| 3 |
+
be controlled via the `blame.blankBoundary` config option.
|
| 4 |
+
|
| 5 |
+
`--root`::
|
| 6 |
+
Do not treat root commits as boundaries. This can also be
|
| 7 |
+
controlled via the `blame.showRoot` config option.
|
| 8 |
+
|
| 9 |
+
`--show-stats`::
|
| 10 |
+
Include additional statistics at the end of blame output.
|
| 11 |
+
|
| 12 |
+
`-L <start>,<end>`::
|
| 13 |
+
`-L :<funcname>`::
|
| 14 |
+
Annotate only the line range given by `<start>,<end>`,
|
| 15 |
+
or by the function name regex _<funcname>_.
|
| 16 |
+
May be specified multiple times. Overlapping ranges are allowed.
|
| 17 |
+
+
|
| 18 |
+
_<start>_ and _<end>_ are optional. `-L <start>` or `-L <start>,` spans from
|
| 19 |
+
_<start>_ to end of file. `-L ,<end>` spans from start of file to _<end>_.
|
| 20 |
+
+
|
| 21 |
+
include::line-range-format.adoc[]
|
| 22 |
+
|
| 23 |
+
`-l`::
|
| 24 |
+
Show long rev (Default: off).
|
| 25 |
+
|
| 26 |
+
`-t`::
|
| 27 |
+
Show raw timestamp (Default: off).
|
| 28 |
+
|
| 29 |
+
`-S <revs-file>`::
|
| 30 |
+
Use revisions from _<revs-file>_ instead of calling
|
| 31 |
+
linkgit:git-rev-list[1].
|
| 32 |
+
|
| 33 |
+
`--reverse <start>..<end>`::
|
| 34 |
+
Walk history forward instead of backward. Instead of showing
|
| 35 |
+
the revision in which a line appeared, this shows the last
|
| 36 |
+
revision in which a line has existed. This requires a range of
|
| 37 |
+
revision like `<start>..<end>` where the path to blame exists in
|
| 38 |
+
_<start>_. `git blame --reverse <start>` is taken as `git blame
|
| 39 |
+
--reverse <start>..HEAD` for convenience.
|
| 40 |
+
|
| 41 |
+
`--first-parent`::
|
| 42 |
+
Follow only the first parent commit upon seeing a merge
|
| 43 |
+
commit. This option can be used to determine when a line
|
| 44 |
+
was introduced to a particular integration branch, rather
|
| 45 |
+
than when it was introduced to the history overall.
|
| 46 |
+
|
| 47 |
+
`-p`::
|
| 48 |
+
`--porcelain`::
|
| 49 |
+
Show in a format designed for machine consumption.
|
| 50 |
+
|
| 51 |
+
`--line-porcelain`::
|
| 52 |
+
Show the porcelain format, but output commit information for
|
| 53 |
+
each line, not just the first time a commit is referenced.
|
| 54 |
+
Implies `--porcelain`.
|
| 55 |
+
|
| 56 |
+
`--incremental`::
|
| 57 |
+
Show the result incrementally in a format designed for
|
| 58 |
+
machine consumption.
|
| 59 |
+
|
| 60 |
+
`--encoding=<encoding>`::
|
| 61 |
+
Specify the encoding used to output author names
|
| 62 |
+
and commit summaries. Setting it to `none` makes blame
|
| 63 |
+
output unconverted data. For more information see the
|
| 64 |
+
discussion about encoding in the linkgit:git-log[1]
|
| 65 |
+
manual page.
|
| 66 |
+
|
| 67 |
+
`--contents <file>`::
|
| 68 |
+
Annotate using the contents from _<file>_, starting from _<rev>_
|
| 69 |
+
if it is specified, and `HEAD` otherwise. You may specify `-` to make
|
| 70 |
+
the command read from the standard input for the file contents.
|
| 71 |
+
|
| 72 |
+
`--date <format>`::
|
| 73 |
+
Specify the format used to output dates. If `--date` is not
|
| 74 |
+
provided, the value of the `blame.date` config variable is
|
| 75 |
+
used. If the `blame.date` config variable is also not set, the
|
| 76 |
+
iso format is used. For supported values, see the discussion
|
| 77 |
+
of the `--date` option at linkgit:git-log[1].
|
| 78 |
+
|
| 79 |
+
`--progress`::
|
| 80 |
+
`--no-progress`::
|
| 81 |
+
Enable progress reporting on the standard error stream even if
|
| 82 |
+
not attached to a terminal. By default, progress status is
|
| 83 |
+
reported only when it is attached. You can't use `--progress`
|
| 84 |
+
together with `--porcelain` or `--incremental`.
|
| 85 |
+
|
| 86 |
+
`-M[<num>]`::
|
| 87 |
+
Detect moved or copied lines within a file. When a commit
|
| 88 |
+
moves or copies a block of lines (e.g. the original file
|
| 89 |
+
has _A_ and then _B_, and the commit changes it to _B_ and then
|
| 90 |
+
_A_), the traditional `blame` algorithm notices only half of
|
| 91 |
+
the movement and typically blames the lines that were moved
|
| 92 |
+
up (i.e. _B_) to the parent and assigns blame to the lines that
|
| 93 |
+
were moved down (i.e. _A_) to the child commit. With this
|
| 94 |
+
option, both groups of lines are blamed on the parent by
|
| 95 |
+
running extra passes of inspection.
|
| 96 |
+
+
|
| 97 |
+
_<num>_ is optional, but it is the lower bound on the number of
|
| 98 |
+
alphanumeric characters that Git must detect as moving/copying
|
| 99 |
+
within a file for it to associate those lines with the parent
|
| 100 |
+
commit. The default value is 20.
|
| 101 |
+
|
| 102 |
+
`-C[<num>]`::
|
| 103 |
+
In addition to `-M`, detect lines moved or copied from other
|
| 104 |
+
files that were modified in the same commit. This is
|
| 105 |
+
useful when you reorganize your program and move code
|
| 106 |
+
around across files. When this option is given twice,
|
| 107 |
+
the command additionally looks for copies from other
|
| 108 |
+
files in the commit that creates the file. When this
|
| 109 |
+
option is given three times, the command additionally
|
| 110 |
+
looks for copies from other files in any commit.
|
| 111 |
+
+
|
| 112 |
+
_<num>_ is optional, but it is the lower bound on the number of
|
| 113 |
+
alphanumeric characters that Git must detect as moving/copying
|
| 114 |
+
between files for it to associate those lines with the parent
|
| 115 |
+
commit. And the default value is 40. If there are more than one
|
| 116 |
+
`-C` options given, the _<num>_ argument of the last `-C` will
|
| 117 |
+
take effect.
|
| 118 |
+
|
| 119 |
+
`--ignore-rev <rev>`::
|
| 120 |
+
Ignore changes made by the revision when assigning blame, as if the
|
| 121 |
+
change never happened. Lines that were changed or added by an ignored
|
| 122 |
+
commit will be blamed on the previous commit that changed that line or
|
| 123 |
+
nearby lines. This option may be specified multiple times to ignore
|
| 124 |
+
more than one revision. If the `blame.markIgnoredLines` config option
|
| 125 |
+
is set, then lines that were changed by an ignored commit and attributed to
|
| 126 |
+
another commit will be marked with a `?` in the blame output. If the
|
| 127 |
+
`blame.markUnblamableLines` config option is set, then those lines touched
|
| 128 |
+
by an ignored commit that we could not attribute to another revision are
|
| 129 |
+
marked with a `*`. In the porcelain modes, we print `ignored` and
|
| 130 |
+
`unblamable` on a newline respectively.
|
| 131 |
+
|
| 132 |
+
`--ignore-revs-file <file>`::
|
| 133 |
+
Ignore revisions listed in _<file>_, which must be in the same format as an
|
| 134 |
+
`fsck.skipList`. This option may be repeated, and these files will be
|
| 135 |
+
processed after any files specified with the `blame.ignoreRevsFile` config
|
| 136 |
+
option. An empty file name, `""`, will clear the list of revs from
|
| 137 |
+
previously processed files.
|
| 138 |
+
|
| 139 |
+
`--color-lines`::
|
| 140 |
+
Color line annotations in the default format differently if they come from
|
| 141 |
+
the same commit as the preceding line. This makes it easier to distinguish
|
| 142 |
+
code blocks introduced by different commits. The color defaults to cyan and
|
| 143 |
+
can be adjusted using the `color.blame.repeatedLines` config option.
|
| 144 |
+
|
| 145 |
+
`--color-by-age`::
|
| 146 |
+
Color line annotations depending on the age of the line in
|
| 147 |
+
the default format. The `color.blame.highlightRecent` config
|
| 148 |
+
option controls what color is used for each range of age.
|
| 149 |
+
|
| 150 |
+
`-h`::
|
| 151 |
+
Show help message.
|
git/mingw64/share/doc/git-doc/cmds-ancillaryinterrogators.adoc
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-annotate[1]::
|
| 2 |
+
Annotate file lines with commit information.
|
| 3 |
+
|
| 4 |
+
linkgit:git-blame[1]::
|
| 5 |
+
Show what revision and author last modified each line of a file.
|
| 6 |
+
|
| 7 |
+
linkgit:git-bugreport[1]::
|
| 8 |
+
Collect information for user to file a bug report.
|
| 9 |
+
|
| 10 |
+
linkgit:git-count-objects[1]::
|
| 11 |
+
Count unpacked number of objects and their disk consumption.
|
| 12 |
+
|
| 13 |
+
linkgit:git-diagnose[1]::
|
| 14 |
+
Generate a zip archive of diagnostic information.
|
| 15 |
+
|
| 16 |
+
linkgit:git-difftool[1]::
|
| 17 |
+
Show changes using common diff tools.
|
| 18 |
+
|
| 19 |
+
linkgit:git-fsck[1]::
|
| 20 |
+
Verifies the connectivity and validity of the objects in the database.
|
| 21 |
+
|
| 22 |
+
linkgit:git-help[1]::
|
| 23 |
+
Display help information about Git.
|
| 24 |
+
|
| 25 |
+
linkgit:git-instaweb[1]::
|
| 26 |
+
Instantly browse your working repository in gitweb.
|
| 27 |
+
|
| 28 |
+
linkgit:git-merge-tree[1]::
|
| 29 |
+
Perform merge without touching index or working tree.
|
| 30 |
+
|
| 31 |
+
linkgit:git-rerere[1]::
|
| 32 |
+
Reuse recorded resolution of conflicted merges.
|
| 33 |
+
|
| 34 |
+
linkgit:git-show-branch[1]::
|
| 35 |
+
Show branches and their commits.
|
| 36 |
+
|
| 37 |
+
linkgit:git-verify-commit[1]::
|
| 38 |
+
Check the GPG signature of commits.
|
| 39 |
+
|
| 40 |
+
linkgit:git-verify-tag[1]::
|
| 41 |
+
Check the GPG signature of tags.
|
| 42 |
+
|
| 43 |
+
linkgit:git-version[1]::
|
| 44 |
+
Display version information about Git.
|
| 45 |
+
|
| 46 |
+
linkgit:git-whatchanged[1]::
|
| 47 |
+
Show logs with differences each commit introduces.
|
| 48 |
+
|
| 49 |
+
linkgit:gitweb[1]::
|
| 50 |
+
Git web interface (web frontend to Git repositories).
|
| 51 |
+
|
git/mingw64/share/doc/git-doc/cmds-ancillarymanipulators.adoc
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-config[1]::
|
| 2 |
+
Get and set repository or global options.
|
| 3 |
+
|
| 4 |
+
linkgit:git-fast-export[1]::
|
| 5 |
+
Git data exporter.
|
| 6 |
+
|
| 7 |
+
linkgit:git-fast-import[1]::
|
| 8 |
+
Backend for fast Git data importers.
|
| 9 |
+
|
| 10 |
+
linkgit:git-filter-branch[1]::
|
| 11 |
+
Rewrite branches.
|
| 12 |
+
|
| 13 |
+
linkgit:git-mergetool[1]::
|
| 14 |
+
Run merge conflict resolution tools to resolve merge conflicts.
|
| 15 |
+
|
| 16 |
+
linkgit:git-pack-refs[1]::
|
| 17 |
+
Pack heads and tags for efficient repository access.
|
| 18 |
+
|
| 19 |
+
linkgit:git-prune[1]::
|
| 20 |
+
Prune all unreachable objects from the object database.
|
| 21 |
+
|
| 22 |
+
linkgit:git-reflog[1]::
|
| 23 |
+
Manage reflog information.
|
| 24 |
+
|
| 25 |
+
linkgit:git-refs[1]::
|
| 26 |
+
Low-level access to refs.
|
| 27 |
+
|
| 28 |
+
linkgit:git-remote[1]::
|
| 29 |
+
Manage set of tracked repositories.
|
| 30 |
+
|
| 31 |
+
linkgit:git-repack[1]::
|
| 32 |
+
Pack unpacked objects in a repository.
|
| 33 |
+
|
| 34 |
+
linkgit:git-replace[1]::
|
| 35 |
+
Create, list, delete refs to replace objects.
|
| 36 |
+
|
git/mingw64/share/doc/git-doc/cmds-developerinterfaces.adoc
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:gitformat-bundle[5]::
|
| 2 |
+
The bundle file format.
|
| 3 |
+
|
| 4 |
+
linkgit:gitformat-chunk[5]::
|
| 5 |
+
Chunk-based file formats.
|
| 6 |
+
|
| 7 |
+
linkgit:gitformat-commit-graph[5]::
|
| 8 |
+
Git commit-graph format.
|
| 9 |
+
|
| 10 |
+
linkgit:gitformat-index[5]::
|
| 11 |
+
Git index format.
|
| 12 |
+
|
| 13 |
+
linkgit:gitformat-pack[5]::
|
| 14 |
+
Git pack format.
|
| 15 |
+
|
| 16 |
+
linkgit:gitformat-signature[5]::
|
| 17 |
+
Git cryptographic signature formats.
|
| 18 |
+
|
| 19 |
+
linkgit:gitprotocol-capabilities[5]::
|
| 20 |
+
Protocol v0 and v1 capabilities.
|
| 21 |
+
|
| 22 |
+
linkgit:gitprotocol-common[5]::
|
| 23 |
+
Things common to various protocols.
|
| 24 |
+
|
| 25 |
+
linkgit:gitprotocol-http[5]::
|
| 26 |
+
Git HTTP-based protocols.
|
| 27 |
+
|
| 28 |
+
linkgit:gitprotocol-pack[5]::
|
| 29 |
+
How packs are transferred over-the-wire.
|
| 30 |
+
|
| 31 |
+
linkgit:gitprotocol-v2[5]::
|
| 32 |
+
Git Wire Protocol, Version 2.
|
| 33 |
+
|
git/mingw64/share/doc/git-doc/cmds-foreignscminterface.adoc
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-archimport[1]::
|
| 2 |
+
Import a GNU Arch repository into Git.
|
| 3 |
+
|
| 4 |
+
linkgit:git-cvsexportcommit[1]::
|
| 5 |
+
Export a single commit to a CVS checkout.
|
| 6 |
+
|
| 7 |
+
linkgit:git-cvsimport[1]::
|
| 8 |
+
Salvage your data out of another SCM people love to hate.
|
| 9 |
+
|
| 10 |
+
linkgit:git-cvsserver[1]::
|
| 11 |
+
A CVS server emulator for Git.
|
| 12 |
+
|
| 13 |
+
linkgit:git-imap-send[1]::
|
| 14 |
+
Send a collection of patches from stdin to an IMAP folder.
|
| 15 |
+
|
| 16 |
+
linkgit:git-p4[1]::
|
| 17 |
+
Import from and submit to Perforce repositories.
|
| 18 |
+
|
| 19 |
+
linkgit:git-quiltimport[1]::
|
| 20 |
+
Applies a quilt patchset onto the current branch.
|
| 21 |
+
|
| 22 |
+
linkgit:git-request-pull[1]::
|
| 23 |
+
Generates a summary of pending changes.
|
| 24 |
+
|
| 25 |
+
linkgit:git-send-email[1]::
|
| 26 |
+
Send a collection of patches as emails.
|
| 27 |
+
|
| 28 |
+
linkgit:git-svn[1]::
|
| 29 |
+
Bidirectional operation between a Subversion repository and Git.
|
| 30 |
+
|
git/mingw64/share/doc/git-doc/cmds-guide.adoc
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:gitcore-tutorial[7]::
|
| 2 |
+
A Git core tutorial for developers.
|
| 3 |
+
|
| 4 |
+
linkgit:gitcredentials[7]::
|
| 5 |
+
Providing usernames and passwords to Git.
|
| 6 |
+
|
| 7 |
+
linkgit:gitcvs-migration[7]::
|
| 8 |
+
Git for CVS users.
|
| 9 |
+
|
| 10 |
+
linkgit:gitdiffcore[7]::
|
| 11 |
+
Tweaking diff output.
|
| 12 |
+
|
| 13 |
+
linkgit:giteveryday[7]::
|
| 14 |
+
A useful minimum set of commands for Everyday Git.
|
| 15 |
+
|
| 16 |
+
linkgit:gitfaq[7]::
|
| 17 |
+
Frequently asked questions about using Git.
|
| 18 |
+
|
| 19 |
+
linkgit:gitglossary[7]::
|
| 20 |
+
A Git Glossary.
|
| 21 |
+
|
| 22 |
+
linkgit:gitnamespaces[7]::
|
| 23 |
+
Git namespaces.
|
| 24 |
+
|
| 25 |
+
linkgit:gitremote-helpers[7]::
|
| 26 |
+
Helper programs to interact with remote repositories.
|
| 27 |
+
|
| 28 |
+
linkgit:gitsubmodules[7]::
|
| 29 |
+
Mounting one repository inside another.
|
| 30 |
+
|
| 31 |
+
linkgit:gittutorial[7]::
|
| 32 |
+
A tutorial introduction to Git.
|
| 33 |
+
|
| 34 |
+
linkgit:gittutorial-2[7]::
|
| 35 |
+
A tutorial introduction to Git: part two.
|
| 36 |
+
|
| 37 |
+
linkgit:gitworkflows[7]::
|
| 38 |
+
An overview of recommended workflows with Git.
|
| 39 |
+
|
git/mingw64/share/doc/git-doc/cmds-mainporcelain.adoc
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-add[1]::
|
| 2 |
+
Add file contents to the index.
|
| 3 |
+
|
| 4 |
+
linkgit:git-am[1]::
|
| 5 |
+
Apply a series of patches from a mailbox.
|
| 6 |
+
|
| 7 |
+
linkgit:git-archive[1]::
|
| 8 |
+
Create an archive of files from a named tree.
|
| 9 |
+
|
| 10 |
+
linkgit:git-backfill[1]::
|
| 11 |
+
Download missing objects in a partial clone.
|
| 12 |
+
|
| 13 |
+
linkgit:git-bisect[1]::
|
| 14 |
+
Use binary search to find the commit that introduced a bug.
|
| 15 |
+
|
| 16 |
+
linkgit:git-branch[1]::
|
| 17 |
+
List, create, or delete branches.
|
| 18 |
+
|
| 19 |
+
linkgit:git-bundle[1]::
|
| 20 |
+
Move objects and refs by archive.
|
| 21 |
+
|
| 22 |
+
linkgit:git-checkout[1]::
|
| 23 |
+
Switch branches or restore working tree files.
|
| 24 |
+
|
| 25 |
+
linkgit:git-cherry-pick[1]::
|
| 26 |
+
Apply the changes introduced by some existing commits.
|
| 27 |
+
|
| 28 |
+
linkgit:git-citool[1]::
|
| 29 |
+
Graphical alternative to git-commit.
|
| 30 |
+
|
| 31 |
+
linkgit:git-clean[1]::
|
| 32 |
+
Remove untracked files from the working tree.
|
| 33 |
+
|
| 34 |
+
linkgit:git-clone[1]::
|
| 35 |
+
Clone a repository into a new directory.
|
| 36 |
+
|
| 37 |
+
linkgit:git-commit[1]::
|
| 38 |
+
Record changes to the repository.
|
| 39 |
+
|
| 40 |
+
linkgit:git-describe[1]::
|
| 41 |
+
Give an object a human readable name based on an available ref.
|
| 42 |
+
|
| 43 |
+
linkgit:git-diff[1]::
|
| 44 |
+
Show changes between commits, commit and working tree, etc.
|
| 45 |
+
|
| 46 |
+
linkgit:git-fetch[1]::
|
| 47 |
+
Download objects and refs from another repository.
|
| 48 |
+
|
| 49 |
+
linkgit:git-format-patch[1]::
|
| 50 |
+
Prepare patches for e-mail submission.
|
| 51 |
+
|
| 52 |
+
linkgit:git-gc[1]::
|
| 53 |
+
Cleanup unnecessary files and optimize the local repository.
|
| 54 |
+
|
| 55 |
+
linkgit:git-grep[1]::
|
| 56 |
+
Print lines matching a pattern.
|
| 57 |
+
|
| 58 |
+
linkgit:git-gui[1]::
|
| 59 |
+
A portable graphical interface to Git.
|
| 60 |
+
|
| 61 |
+
linkgit:git-history[1]::
|
| 62 |
+
EXPERIMENTAL: Rewrite history.
|
| 63 |
+
|
| 64 |
+
linkgit:git-init[1]::
|
| 65 |
+
Create an empty Git repository or reinitialize an existing one.
|
| 66 |
+
|
| 67 |
+
linkgit:git-log[1]::
|
| 68 |
+
Show commit logs.
|
| 69 |
+
|
| 70 |
+
linkgit:git-maintenance[1]::
|
| 71 |
+
Run tasks to optimize Git repository data.
|
| 72 |
+
|
| 73 |
+
linkgit:git-merge[1]::
|
| 74 |
+
Join two or more development histories together.
|
| 75 |
+
|
| 76 |
+
linkgit:git-mv[1]::
|
| 77 |
+
Move or rename a file, a directory, or a symlink.
|
| 78 |
+
|
| 79 |
+
linkgit:git-notes[1]::
|
| 80 |
+
Add or inspect object notes.
|
| 81 |
+
|
| 82 |
+
linkgit:git-pull[1]::
|
| 83 |
+
Fetch from and integrate with another repository or a local branch.
|
| 84 |
+
|
| 85 |
+
linkgit:git-push[1]::
|
| 86 |
+
Update remote refs along with associated objects.
|
| 87 |
+
|
| 88 |
+
linkgit:git-range-diff[1]::
|
| 89 |
+
Compare two commit ranges (e.g. two versions of a branch).
|
| 90 |
+
|
| 91 |
+
linkgit:git-rebase[1]::
|
| 92 |
+
Reapply commits on top of another base tip.
|
| 93 |
+
|
| 94 |
+
linkgit:git-reset[1]::
|
| 95 |
+
Set `HEAD` or the index to a known state.
|
| 96 |
+
|
| 97 |
+
linkgit:git-restore[1]::
|
| 98 |
+
Restore working tree files.
|
| 99 |
+
|
| 100 |
+
linkgit:git-revert[1]::
|
| 101 |
+
Revert some existing commits.
|
| 102 |
+
|
| 103 |
+
linkgit:git-rm[1]::
|
| 104 |
+
Remove files from the working tree and from the index.
|
| 105 |
+
|
| 106 |
+
linkgit:git-shortlog[1]::
|
| 107 |
+
Summarize 'git log' output.
|
| 108 |
+
|
| 109 |
+
linkgit:git-show[1]::
|
| 110 |
+
Show various types of objects.
|
| 111 |
+
|
| 112 |
+
linkgit:git-sparse-checkout[1]::
|
| 113 |
+
Reduce your working tree to a subset of tracked files.
|
| 114 |
+
|
| 115 |
+
linkgit:git-stash[1]::
|
| 116 |
+
Stash the changes in a dirty working directory away.
|
| 117 |
+
|
| 118 |
+
linkgit:git-status[1]::
|
| 119 |
+
Show the working tree status.
|
| 120 |
+
|
| 121 |
+
linkgit:git-submodule[1]::
|
| 122 |
+
Initialize, update or inspect submodules.
|
| 123 |
+
|
| 124 |
+
linkgit:git-survey[1]::
|
| 125 |
+
EXPERIMENTAL: Measure various repository dimensions of scale.
|
| 126 |
+
|
| 127 |
+
linkgit:git-switch[1]::
|
| 128 |
+
Switch branches.
|
| 129 |
+
|
| 130 |
+
linkgit:git-tag[1]::
|
| 131 |
+
Create, list, delete or verify tags.
|
| 132 |
+
|
| 133 |
+
linkgit:git-worktree[1]::
|
| 134 |
+
Manage multiple working trees.
|
| 135 |
+
|
| 136 |
+
linkgit:gitk[1]::
|
| 137 |
+
The Git repository browser.
|
| 138 |
+
|
| 139 |
+
linkgit:scalar[1]::
|
| 140 |
+
A tool for managing large Git repositories.
|
| 141 |
+
|
git/mingw64/share/doc/git-doc/cmds-plumbinginterrogators.adoc
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-cat-file[1]::
|
| 2 |
+
Provide contents or details of repository objects.
|
| 3 |
+
|
| 4 |
+
linkgit:git-cherry[1]::
|
| 5 |
+
Find commits yet to be applied to upstream.
|
| 6 |
+
|
| 7 |
+
linkgit:git-diff-files[1]::
|
| 8 |
+
Compares files in the working tree and the index.
|
| 9 |
+
|
| 10 |
+
linkgit:git-diff-index[1]::
|
| 11 |
+
Compare a tree to the working tree or index.
|
| 12 |
+
|
| 13 |
+
linkgit:git-diff-pairs[1]::
|
| 14 |
+
Compare the content and mode of provided blob pairs.
|
| 15 |
+
|
| 16 |
+
linkgit:git-diff-tree[1]::
|
| 17 |
+
Compares the content and mode of blobs found via two tree objects.
|
| 18 |
+
|
| 19 |
+
linkgit:git-for-each-ref[1]::
|
| 20 |
+
Output information on each ref.
|
| 21 |
+
|
| 22 |
+
linkgit:git-for-each-repo[1]::
|
| 23 |
+
Run a Git command on a list of repositories.
|
| 24 |
+
|
| 25 |
+
linkgit:git-get-tar-commit-id[1]::
|
| 26 |
+
Extract commit ID from an archive created using git-archive.
|
| 27 |
+
|
| 28 |
+
linkgit:git-last-modified[1]::
|
| 29 |
+
EXPERIMENTAL: Show when files were last modified.
|
| 30 |
+
|
| 31 |
+
linkgit:git-ls-files[1]::
|
| 32 |
+
Show information about files in the index and the working tree.
|
| 33 |
+
|
| 34 |
+
linkgit:git-ls-remote[1]::
|
| 35 |
+
List references in a remote repository.
|
| 36 |
+
|
| 37 |
+
linkgit:git-ls-tree[1]::
|
| 38 |
+
List the contents of a tree object.
|
| 39 |
+
|
| 40 |
+
linkgit:git-merge-base[1]::
|
| 41 |
+
Find as good common ancestors as possible for a merge.
|
| 42 |
+
|
| 43 |
+
linkgit:git-name-rev[1]::
|
| 44 |
+
Find symbolic names for given revs.
|
| 45 |
+
|
| 46 |
+
linkgit:git-pack-redundant[1]::
|
| 47 |
+
Find redundant pack files.
|
| 48 |
+
|
| 49 |
+
linkgit:git-repo[1]::
|
| 50 |
+
Retrieve information about the repository.
|
| 51 |
+
|
| 52 |
+
linkgit:git-rev-list[1]::
|
| 53 |
+
Lists commit objects in reverse chronological order.
|
| 54 |
+
|
| 55 |
+
linkgit:git-rev-parse[1]::
|
| 56 |
+
Pick out and massage parameters.
|
| 57 |
+
|
| 58 |
+
linkgit:git-show-index[1]::
|
| 59 |
+
Show packed archive index.
|
| 60 |
+
|
| 61 |
+
linkgit:git-show-ref[1]::
|
| 62 |
+
List references in a local repository.
|
| 63 |
+
|
| 64 |
+
linkgit:git-unpack-file[1]::
|
| 65 |
+
Creates a temporary file with a blob's contents.
|
| 66 |
+
|
| 67 |
+
linkgit:git-var[1]::
|
| 68 |
+
Show a Git logical variable.
|
| 69 |
+
|
| 70 |
+
linkgit:git-verify-pack[1]::
|
| 71 |
+
Validate packed Git archive files.
|
| 72 |
+
|
git/mingw64/share/doc/git-doc/cmds-plumbingmanipulators.adoc
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-apply[1]::
|
| 2 |
+
Apply a patch to files and/or to the index.
|
| 3 |
+
|
| 4 |
+
linkgit:git-checkout-index[1]::
|
| 5 |
+
Copy files from the index to the working tree.
|
| 6 |
+
|
| 7 |
+
linkgit:git-commit-graph[1]::
|
| 8 |
+
Write and verify Git commit-graph files.
|
| 9 |
+
|
| 10 |
+
linkgit:git-commit-tree[1]::
|
| 11 |
+
Create a new commit object.
|
| 12 |
+
|
| 13 |
+
linkgit:git-hash-object[1]::
|
| 14 |
+
Compute object ID and optionally create an object from a file.
|
| 15 |
+
|
| 16 |
+
linkgit:git-index-pack[1]::
|
| 17 |
+
Build pack index file for an existing packed archive.
|
| 18 |
+
|
| 19 |
+
linkgit:git-merge-file[1]::
|
| 20 |
+
Run a three-way file merge.
|
| 21 |
+
|
| 22 |
+
linkgit:git-merge-index[1]::
|
| 23 |
+
Run a merge for files needing merging.
|
| 24 |
+
|
| 25 |
+
linkgit:git-mktag[1]::
|
| 26 |
+
Creates a tag object with extra validation.
|
| 27 |
+
|
| 28 |
+
linkgit:git-mktree[1]::
|
| 29 |
+
Build a tree-object from ls-tree formatted text.
|
| 30 |
+
|
| 31 |
+
linkgit:git-multi-pack-index[1]::
|
| 32 |
+
Write and verify multi-pack-indexes.
|
| 33 |
+
|
| 34 |
+
linkgit:git-pack-objects[1]::
|
| 35 |
+
Create a packed archive of objects.
|
| 36 |
+
|
| 37 |
+
linkgit:git-prune-packed[1]::
|
| 38 |
+
Remove extra objects that are already in pack files.
|
| 39 |
+
|
| 40 |
+
linkgit:git-read-tree[1]::
|
| 41 |
+
Reads tree information into the index.
|
| 42 |
+
|
| 43 |
+
linkgit:git-replay[1]::
|
| 44 |
+
EXPERIMENTAL: Replay commits on a new base, works with bare repos too.
|
| 45 |
+
|
| 46 |
+
linkgit:git-symbolic-ref[1]::
|
| 47 |
+
Read, modify and delete symbolic refs.
|
| 48 |
+
|
| 49 |
+
linkgit:git-unpack-objects[1]::
|
| 50 |
+
Unpack objects from a packed archive.
|
| 51 |
+
|
| 52 |
+
linkgit:git-update-index[1]::
|
| 53 |
+
Register file contents in the working tree to the index.
|
| 54 |
+
|
| 55 |
+
linkgit:git-update-ref[1]::
|
| 56 |
+
Update the object name stored in a ref safely.
|
| 57 |
+
|
| 58 |
+
linkgit:git-write-tree[1]::
|
| 59 |
+
Create a tree object from the current index.
|
| 60 |
+
|
git/mingw64/share/doc/git-doc/cmds-purehelpers.adoc
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-check-attr[1]::
|
| 2 |
+
Display gitattributes information.
|
| 3 |
+
|
| 4 |
+
linkgit:git-check-ignore[1]::
|
| 5 |
+
Debug gitignore / exclude files.
|
| 6 |
+
|
| 7 |
+
linkgit:git-check-mailmap[1]::
|
| 8 |
+
Show canonical names and email addresses of contacts.
|
| 9 |
+
|
| 10 |
+
linkgit:git-check-ref-format[1]::
|
| 11 |
+
Ensures that a reference name is well formed.
|
| 12 |
+
|
| 13 |
+
linkgit:git-column[1]::
|
| 14 |
+
Display data in columns.
|
| 15 |
+
|
| 16 |
+
linkgit:git-credential[1]::
|
| 17 |
+
Retrieve and store user credentials.
|
| 18 |
+
|
| 19 |
+
linkgit:git-credential-cache[1]::
|
| 20 |
+
Helper to temporarily store passwords in memory.
|
| 21 |
+
|
| 22 |
+
linkgit:git-credential-store[1]::
|
| 23 |
+
Helper to store credentials on disk.
|
| 24 |
+
|
| 25 |
+
linkgit:git-fmt-merge-msg[1]::
|
| 26 |
+
Produce a merge commit message.
|
| 27 |
+
|
| 28 |
+
linkgit:git-hook[1]::
|
| 29 |
+
Run git hooks.
|
| 30 |
+
|
| 31 |
+
linkgit:git-interpret-trailers[1]::
|
| 32 |
+
Add or parse structured information in commit messages.
|
| 33 |
+
|
| 34 |
+
linkgit:git-mailinfo[1]::
|
| 35 |
+
Extracts patch and authorship from a single e-mail message.
|
| 36 |
+
|
| 37 |
+
linkgit:git-mailsplit[1]::
|
| 38 |
+
Simple UNIX mbox splitter program.
|
| 39 |
+
|
| 40 |
+
linkgit:git-merge-one-file[1]::
|
| 41 |
+
The standard helper program to use with git-merge-index.
|
| 42 |
+
|
| 43 |
+
linkgit:git-patch-id[1]::
|
| 44 |
+
Compute unique IDs for patches.
|
| 45 |
+
|
| 46 |
+
linkgit:git-sh-i18n[1]::
|
| 47 |
+
Git's i18n setup code for shell scripts.
|
| 48 |
+
|
| 49 |
+
linkgit:git-sh-setup[1]::
|
| 50 |
+
Common Git shell script setup code.
|
| 51 |
+
|
| 52 |
+
linkgit:git-stripspace[1]::
|
| 53 |
+
Remove unnecessary whitespace.
|
| 54 |
+
|
git/mingw64/share/doc/git-doc/cmds-synchelpers.adoc
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-http-fetch[1]::
|
| 2 |
+
Download from a remote Git repository via HTTP.
|
| 3 |
+
|
| 4 |
+
linkgit:git-http-push[1]::
|
| 5 |
+
Push objects over HTTP/DAV to another repository.
|
| 6 |
+
|
| 7 |
+
linkgit:git-receive-pack[1]::
|
| 8 |
+
Receive what is pushed into the repository.
|
| 9 |
+
|
| 10 |
+
linkgit:git-shell[1]::
|
| 11 |
+
Restricted login shell for Git-only SSH access.
|
| 12 |
+
|
| 13 |
+
linkgit:git-upload-archive[1]::
|
| 14 |
+
Send archive back to git-archive.
|
| 15 |
+
|
| 16 |
+
linkgit:git-upload-pack[1]::
|
| 17 |
+
Send objects packed back to git-fetch-pack.
|
| 18 |
+
|
git/mingw64/share/doc/git-doc/cmds-synchingrepositories.adoc
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:git-daemon[1]::
|
| 2 |
+
A really simple server for Git repositories.
|
| 3 |
+
|
| 4 |
+
linkgit:git-fetch-pack[1]::
|
| 5 |
+
Receive missing objects from another repository.
|
| 6 |
+
|
| 7 |
+
linkgit:git-http-backend[1]::
|
| 8 |
+
Server side implementation of Git over HTTP.
|
| 9 |
+
|
| 10 |
+
linkgit:git-send-pack[1]::
|
| 11 |
+
Push objects over Git protocol to another repository.
|
| 12 |
+
|
| 13 |
+
linkgit:git-update-server-info[1]::
|
| 14 |
+
Update auxiliary info file to help dumb servers.
|
| 15 |
+
|
git/mingw64/share/doc/git-doc/cmds-userinterfaces.adoc
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
linkgit:gitattributes[5]::
|
| 2 |
+
Defining attributes per path.
|
| 3 |
+
|
| 4 |
+
linkgit:gitcli[7]::
|
| 5 |
+
Git command-line interface and conventions.
|
| 6 |
+
|
| 7 |
+
linkgit:githooks[5]::
|
| 8 |
+
Hooks used by Git.
|
| 9 |
+
|
| 10 |
+
linkgit:gitignore[5]::
|
| 11 |
+
Specifies intentionally untracked files to ignore.
|
| 12 |
+
|
| 13 |
+
linkgit:gitmailmap[5]::
|
| 14 |
+
Map author/committer names and/or E-Mail addresses.
|
| 15 |
+
|
| 16 |
+
linkgit:gitmodules[5]::
|
| 17 |
+
Defining submodule properties.
|
| 18 |
+
|
| 19 |
+
linkgit:gitrepository-layout[5]::
|
| 20 |
+
Git Repository Layout.
|
| 21 |
+
|
| 22 |
+
linkgit:gitrevisions[7]::
|
| 23 |
+
Specifying revisions and ranges for Git.
|
| 24 |
+
|
git/mingw64/share/doc/git-doc/config.adoc
ADDED
|
@@ -0,0 +1,568 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
CONFIGURATION FILE
|
| 2 |
+
------------------
|
| 3 |
+
|
| 4 |
+
The Git configuration file contains a number of variables that affect
|
| 5 |
+
the Git commands' behavior. The files `.git/config` and optionally
|
| 6 |
+
`config.worktree` (see the "CONFIGURATION FILE" section of
|
| 7 |
+
linkgit:git-worktree[1]) in each repository are used to store the
|
| 8 |
+
configuration for that repository, and `$HOME/.gitconfig` is used to
|
| 9 |
+
store a per-user configuration as fallback values for the `.git/config`
|
| 10 |
+
file. The file `/etc/gitconfig` can be used to store a system-wide
|
| 11 |
+
default configuration.
|
| 12 |
+
|
| 13 |
+
The configuration variables are used by both the Git plumbing
|
| 14 |
+
and the porcelain commands. The variables are divided into sections, wherein
|
| 15 |
+
the fully qualified variable name of the variable itself is the last
|
| 16 |
+
dot-separated segment and the section name is everything before the last
|
| 17 |
+
dot. The variable names are case-insensitive, allow only alphanumeric
|
| 18 |
+
characters and `-`, and must start with an alphabetic character. Some
|
| 19 |
+
variables may appear multiple times; we say then that the variable is
|
| 20 |
+
multivalued.
|
| 21 |
+
|
| 22 |
+
Syntax
|
| 23 |
+
~~~~~~
|
| 24 |
+
|
| 25 |
+
The syntax is fairly flexible and permissive. Whitespace characters,
|
| 26 |
+
which in this context are the space character (SP) and the horizontal
|
| 27 |
+
tabulation (HT), are mostly ignored. The '#' and ';' characters begin
|
| 28 |
+
comments to the end of line. Blank lines are ignored.
|
| 29 |
+
|
| 30 |
+
The file consists of sections and variables. A section begins with
|
| 31 |
+
the name of the section in square brackets and continues until the next
|
| 32 |
+
section begins. Section names are case-insensitive. Only alphanumeric
|
| 33 |
+
characters, `-` and `.` are allowed in section names. Each variable
|
| 34 |
+
must belong to some section, which means that there must be a section
|
| 35 |
+
header before the first setting of a variable.
|
| 36 |
+
|
| 37 |
+
Sections can be further divided into subsections. To begin a subsection
|
| 38 |
+
put its name in double quotes, separated by space from the section name,
|
| 39 |
+
in the section header, like in the example below:
|
| 40 |
+
|
| 41 |
+
--------
|
| 42 |
+
[section "subsection"]
|
| 43 |
+
|
| 44 |
+
--------
|
| 45 |
+
|
| 46 |
+
Subsection names are case sensitive and can contain any characters except
|
| 47 |
+
newline and the null byte. Doublequote `"` and backslash can be included
|
| 48 |
+
by escaping them as `\"` and `\\`, respectively. Backslashes preceding
|
| 49 |
+
other characters are dropped when reading; for example, `\t` is read as
|
| 50 |
+
`t` and `\0` is read as `0`. Section headers cannot span multiple lines.
|
| 51 |
+
Variables may belong directly to a section or to a given subsection. You
|
| 52 |
+
can have `[section]` if you have `[section "subsection"]`, but you don't
|
| 53 |
+
need to.
|
| 54 |
+
|
| 55 |
+
There is also a deprecated `[section.subsection]` syntax. With this
|
| 56 |
+
syntax, the subsection name is converted to lower-case and is also
|
| 57 |
+
compared case sensitively. These subsection names follow the same
|
| 58 |
+
restrictions as section names.
|
| 59 |
+
|
| 60 |
+
All the other lines (and the remainder of the line after the section
|
| 61 |
+
header) are recognized as setting variables, in the form
|
| 62 |
+
'name = value' (or just 'name', which is a short-hand to say that
|
| 63 |
+
the variable is the boolean "true").
|
| 64 |
+
The variable names are case-insensitive, allow only alphanumeric characters
|
| 65 |
+
and `-`, and must start with an alphabetic character.
|
| 66 |
+
|
| 67 |
+
Whitespace characters surrounding `name`, `=` and `value` are discarded.
|
| 68 |
+
Internal whitespace characters within 'value' are retained verbatim.
|
| 69 |
+
Comments starting with either `#` or `;` and extending to the end of line
|
| 70 |
+
are discarded. A line that defines a value can be continued to the next
|
| 71 |
+
line by ending it with a backslash (`\`); the backslash and the end-of-line
|
| 72 |
+
characters are discarded.
|
| 73 |
+
|
| 74 |
+
If `value` needs to contain leading or trailing whitespace characters,
|
| 75 |
+
it must be enclosed in double quotation marks (`"`). Inside double quotation
|
| 76 |
+
marks, double quote (`"`) and backslash (`\`) characters must be escaped:
|
| 77 |
+
use `\"` for `"` and `\\` for `\`.
|
| 78 |
+
|
| 79 |
+
The following escape sequences (beside `\"` and `\\`) are recognized:
|
| 80 |
+
`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
|
| 81 |
+
and `\b` for backspace (BS). Other char escape sequences (including octal
|
| 82 |
+
escape sequences) are invalid.
|
| 83 |
+
|
| 84 |
+
|
| 85 |
+
Includes
|
| 86 |
+
~~~~~~~~
|
| 87 |
+
|
| 88 |
+
The `include` and `includeIf` sections allow you to include config
|
| 89 |
+
directives from another source. These sections behave identically to
|
| 90 |
+
each other with the exception that `includeIf` sections may be ignored
|
| 91 |
+
if their condition does not evaluate to true; see "Conditional includes"
|
| 92 |
+
below.
|
| 93 |
+
|
| 94 |
+
You can include a config file from another by setting the special
|
| 95 |
+
`include.path` (or `includeIf.*.path`) variable to the name of the file
|
| 96 |
+
to be included. The variable takes a pathname as its value, and is
|
| 97 |
+
subject to tilde expansion. These variables can be given multiple times.
|
| 98 |
+
|
| 99 |
+
The contents of the included file are inserted immediately, as if they
|
| 100 |
+
had been found at the location of the include directive. If the value of the
|
| 101 |
+
variable is a relative path, the path is considered to
|
| 102 |
+
be relative to the configuration file in which the include directive
|
| 103 |
+
was found. See below for examples.
|
| 104 |
+
|
| 105 |
+
Conditional includes
|
| 106 |
+
~~~~~~~~~~~~~~~~~~~~
|
| 107 |
+
|
| 108 |
+
You can conditionally include a config file from another by setting an
|
| 109 |
+
`includeIf.<condition>.path` variable to the name of the file to be
|
| 110 |
+
included.
|
| 111 |
+
|
| 112 |
+
The condition starts with a keyword followed by a colon and some data
|
| 113 |
+
whose format and meaning depends on the keyword. Supported keywords
|
| 114 |
+
are:
|
| 115 |
+
|
| 116 |
+
`gitdir`::
|
| 117 |
+
The data that follows the keyword `gitdir` and a colon is used as a glob
|
| 118 |
+
pattern. If the location of the .git directory matches the
|
| 119 |
+
pattern, the include condition is met.
|
| 120 |
+
+
|
| 121 |
+
The .git location may be auto-discovered, or come from `$GIT_DIR`
|
| 122 |
+
environment variable. If the repository is auto-discovered via a .git
|
| 123 |
+
file (e.g. from submodules, or a linked worktree), the .git location
|
| 124 |
+
would be the final location where the .git directory is, not where the
|
| 125 |
+
.git file is.
|
| 126 |
+
+
|
| 127 |
+
The pattern can contain standard globbing wildcards and two additional
|
| 128 |
+
ones, `**/` and `/**`, that can match multiple path components. Please
|
| 129 |
+
refer to linkgit:gitignore[5] for details. For convenience:
|
| 130 |
+
|
| 131 |
+
* If the pattern starts with `~/`, `~` will be substituted with the
|
| 132 |
+
content of the environment variable `HOME`.
|
| 133 |
+
|
| 134 |
+
* If the pattern starts with `./`, it is replaced with the directory
|
| 135 |
+
containing the current config file.
|
| 136 |
+
|
| 137 |
+
* If the pattern does not start with either `~/`, `./` or `/`, `**/`
|
| 138 |
+
will be automatically prepended. For example, the pattern `foo/bar`
|
| 139 |
+
becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
|
| 140 |
+
|
| 141 |
+
* If the pattern ends with `/`, `**` will be automatically added. For
|
| 142 |
+
example, the pattern `foo/` becomes `foo/**`. In other words, it
|
| 143 |
+
matches "foo" and everything inside, recursively.
|
| 144 |
+
|
| 145 |
+
`gitdir/i`::
|
| 146 |
+
This is the same as `gitdir` except that matching is done
|
| 147 |
+
case-insensitively (e.g. on case-insensitive file systems)
|
| 148 |
+
|
| 149 |
+
`onbranch`::
|
| 150 |
+
The data that follows the keyword `onbranch` and a colon is taken to be a
|
| 151 |
+
pattern with standard globbing wildcards and two additional
|
| 152 |
+
ones, `**/` and `/**`, that can match multiple path components.
|
| 153 |
+
If we are in a worktree where the name of the branch that is
|
| 154 |
+
currently checked out matches the pattern, the include condition
|
| 155 |
+
is met.
|
| 156 |
+
+
|
| 157 |
+
If the pattern ends with `/`, `**` will be automatically added. For
|
| 158 |
+
example, the pattern `foo/` becomes `foo/**`. In other words, it matches
|
| 159 |
+
all branches that begin with `foo/`. This is useful if your branches are
|
| 160 |
+
organized hierarchically and you would like to apply a configuration to
|
| 161 |
+
all the branches in that hierarchy.
|
| 162 |
+
|
| 163 |
+
`hasconfig:remote.*.url`::
|
| 164 |
+
The data that follows this keyword and a colon is taken to
|
| 165 |
+
be a pattern with standard globbing wildcards and two
|
| 166 |
+
additional ones, `**/` and `/**`, that can match multiple
|
| 167 |
+
components. The first time this keyword is seen, the rest of
|
| 168 |
+
the config files will be scanned for remote URLs (without
|
| 169 |
+
applying any values). If there exists at least one remote URL
|
| 170 |
+
that matches this pattern, the include condition is met.
|
| 171 |
+
+
|
| 172 |
+
Files included by this option (directly or indirectly) are not allowed
|
| 173 |
+
to contain remote URLs.
|
| 174 |
+
+
|
| 175 |
+
Note that unlike other includeIf conditions, resolving this condition
|
| 176 |
+
relies on information that is not yet known at the point of reading the
|
| 177 |
+
condition. A typical use case is this option being present as a
|
| 178 |
+
system-level or global-level config, and the remote URL being in a
|
| 179 |
+
local-level config; hence the need to scan ahead when resolving this
|
| 180 |
+
condition. In order to avoid the chicken-and-egg problem in which
|
| 181 |
+
potentially-included files can affect whether such files are potentially
|
| 182 |
+
included, Git breaks the cycle by prohibiting these files from affecting
|
| 183 |
+
the resolution of these conditions (thus, prohibiting them from
|
| 184 |
+
declaring remote URLs).
|
| 185 |
+
+
|
| 186 |
+
As for the naming of this keyword, it is for forwards compatibility with
|
| 187 |
+
a naming scheme that supports more variable-based include conditions,
|
| 188 |
+
but currently Git only supports the exact keyword described above.
|
| 189 |
+
|
| 190 |
+
A few more notes on matching via `gitdir` and `gitdir/i`:
|
| 191 |
+
|
| 192 |
+
* Symlinks in `$GIT_DIR` are not resolved before matching.
|
| 193 |
+
|
| 194 |
+
* Both the symlink & realpath versions of paths will be matched
|
| 195 |
+
outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
|
| 196 |
+
/mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
|
| 197 |
+
will match.
|
| 198 |
+
+
|
| 199 |
+
This was not the case in the initial release of this feature in
|
| 200 |
+
v2.13.0, which only matched the realpath version. Configuration that
|
| 201 |
+
wants to be compatible with the initial release of this feature needs
|
| 202 |
+
to either specify only the realpath version, or both versions.
|
| 203 |
+
|
| 204 |
+
* Note that "../" is not special and will match literally, which is
|
| 205 |
+
unlikely what you want.
|
| 206 |
+
|
| 207 |
+
Example
|
| 208 |
+
~~~~~~~
|
| 209 |
+
|
| 210 |
+
----
|
| 211 |
+
# Core variables
|
| 212 |
+
[core]
|
| 213 |
+
; Don't trust file modes
|
| 214 |
+
filemode = false
|
| 215 |
+
|
| 216 |
+
# Our diff algorithm
|
| 217 |
+
[diff]
|
| 218 |
+
external = /usr/local/bin/diff-wrapper
|
| 219 |
+
renames = true
|
| 220 |
+
|
| 221 |
+
[branch "devel"]
|
| 222 |
+
remote = origin
|
| 223 |
+
merge = refs/heads/devel
|
| 224 |
+
|
| 225 |
+
# Proxy settings
|
| 226 |
+
[core]
|
| 227 |
+
gitProxy="ssh" for "kernel.org"
|
| 228 |
+
gitProxy=default-proxy ; for the rest
|
| 229 |
+
|
| 230 |
+
[include]
|
| 231 |
+
path = /path/to/foo.inc ; include by absolute path
|
| 232 |
+
path = foo.inc ; find "foo.inc" relative to the current file
|
| 233 |
+
path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
|
| 234 |
+
|
| 235 |
+
; include if $GIT_DIR is /path/to/foo/.git
|
| 236 |
+
[includeIf "gitdir:/path/to/foo/.git"]
|
| 237 |
+
path = /path/to/foo.inc
|
| 238 |
+
|
| 239 |
+
; include for all repositories inside /path/to/group
|
| 240 |
+
[includeIf "gitdir:/path/to/group/"]
|
| 241 |
+
path = /path/to/foo.inc
|
| 242 |
+
|
| 243 |
+
; include for all repositories inside $HOME/to/group
|
| 244 |
+
[includeIf "gitdir:~/to/group/"]
|
| 245 |
+
path = /path/to/foo.inc
|
| 246 |
+
|
| 247 |
+
; relative paths are always relative to the including
|
| 248 |
+
; file (if the condition is true); their location is not
|
| 249 |
+
; affected by the condition
|
| 250 |
+
[includeIf "gitdir:/path/to/group/"]
|
| 251 |
+
path = foo.inc
|
| 252 |
+
|
| 253 |
+
; include only if we are in a worktree where foo-branch is
|
| 254 |
+
; currently checked out
|
| 255 |
+
[includeIf "onbranch:foo-branch"]
|
| 256 |
+
path = foo.inc
|
| 257 |
+
|
| 258 |
+
; include only if a remote with the given URL exists (note
|
| 259 |
+
; that such a URL may be provided later in a file or in a
|
| 260 |
+
; file read after this file is read, as seen in this example)
|
| 261 |
+
[includeIf "hasconfig:remote.*.url:https://example.com/**"]
|
| 262 |
+
path = foo.inc
|
| 263 |
+
[remote "origin"]
|
| 264 |
+
url = https://example.com/git
|
| 265 |
+
----
|
| 266 |
+
|
| 267 |
+
Values
|
| 268 |
+
~~~~~~
|
| 269 |
+
|
| 270 |
+
Values of many variables are treated as a simple string, but there
|
| 271 |
+
are variables that take values of specific types and there are rules
|
| 272 |
+
as to how to spell them.
|
| 273 |
+
|
| 274 |
+
boolean::
|
| 275 |
+
|
| 276 |
+
When a variable is said to take a boolean value, many
|
| 277 |
+
synonyms are accepted for 'true' and 'false'; these are all
|
| 278 |
+
case-insensitive.
|
| 279 |
+
|
| 280 |
+
true;; Boolean true literals are `yes`, `on`, `true`,
|
| 281 |
+
and `1`. Also, a variable defined without `= <value>`
|
| 282 |
+
is taken as true.
|
| 283 |
+
|
| 284 |
+
false;; Boolean false literals are `no`, `off`, `false`,
|
| 285 |
+
`0` and the empty string.
|
| 286 |
+
+
|
| 287 |
+
When converting a value to its canonical form using the `--type=bool` type
|
| 288 |
+
specifier, 'git config' will ensure that the output is "true" or
|
| 289 |
+
"false" (spelled in lowercase).
|
| 290 |
+
|
| 291 |
+
integer::
|
| 292 |
+
The value for many variables that specify various sizes can
|
| 293 |
+
be suffixed with `k`, `M`,... to mean "scale the number by
|
| 294 |
+
1024", "by 1024x1024", etc.
|
| 295 |
+
|
| 296 |
+
color::
|
| 297 |
+
The value for a variable that takes a color is a list of
|
| 298 |
+
colors (at most two, one for foreground and one for background)
|
| 299 |
+
and attributes (as many as you want), separated by spaces.
|
| 300 |
+
+
|
| 301 |
+
The basic colors accepted are `normal`, `black`, `red`, `green`,
|
| 302 |
+
`yellow`, `blue`, `magenta`, `cyan`, `white` and `default`. The first
|
| 303 |
+
color given is the foreground; the second is the background. All the
|
| 304 |
+
basic colors except `normal` and `default` have a bright variant that can
|
| 305 |
+
be specified by prefixing the color with `bright`, like `brightred`.
|
| 306 |
+
+
|
| 307 |
+
The color `normal` makes no change to the color. It is the same as an
|
| 308 |
+
empty string, but can be used as the foreground color when specifying a
|
| 309 |
+
background color alone (for example, "normal red").
|
| 310 |
+
+
|
| 311 |
+
The color `default` explicitly resets the color to the terminal default,
|
| 312 |
+
for example to specify a cleared background. Although it varies between
|
| 313 |
+
terminals, this is usually not the same as setting to "white black".
|
| 314 |
+
+
|
| 315 |
+
Colors may also be given as numbers between 0 and 255; these use ANSI
|
| 316 |
+
256-color mode (but note that not all terminals may support this). If
|
| 317 |
+
your terminal supports it, you may also specify 24-bit RGB values as
|
| 318 |
+
hex, like `#ff0ab3`, or 12-bit RGB values like `#f1b`, which is
|
| 319 |
+
equivalent to the 24-bit color `#ff11bb`.
|
| 320 |
+
+
|
| 321 |
+
The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
|
| 322 |
+
`italic`, and `strike` (for crossed-out or "strikethrough" letters).
|
| 323 |
+
The position of any attributes with respect to the colors
|
| 324 |
+
(before, after, or in between), doesn't matter. Specific attributes may
|
| 325 |
+
be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
|
| 326 |
+
`no-ul`, etc).
|
| 327 |
+
+
|
| 328 |
+
The pseudo-attribute `reset` resets all colors and attributes before
|
| 329 |
+
applying the specified coloring. For example, `reset green` will result
|
| 330 |
+
in a green foreground and default background without any active
|
| 331 |
+
attributes.
|
| 332 |
+
+
|
| 333 |
+
An empty color string produces no color effect at all. This can be used
|
| 334 |
+
to avoid coloring specific elements without disabling color entirely.
|
| 335 |
+
+
|
| 336 |
+
For git's pre-defined color slots, the attributes are meant to be reset
|
| 337 |
+
at the beginning of each item in the colored output. So setting
|
| 338 |
+
`color.decorate.branch` to `black` will paint that branch name in a
|
| 339 |
+
plain `black`, even if the previous thing on the same output line (e.g.
|
| 340 |
+
opening parenthesis before the list of branch names in `log --decorate`
|
| 341 |
+
output) is set to be painted with `bold` or some other attribute.
|
| 342 |
+
However, custom log formats may do more complicated and layered
|
| 343 |
+
coloring, and the negated forms may be useful there.
|
| 344 |
+
|
| 345 |
+
pathname::
|
| 346 |
+
A variable that takes a pathname value can be given a
|
| 347 |
+
string that begins with "`~/`" or "`~user/`", and the usual
|
| 348 |
+
tilde expansion happens to such a string: `~/`
|
| 349 |
+
is expanded to the value of `$HOME`, and `~user/` to the
|
| 350 |
+
specified user's home directory.
|
| 351 |
+
+
|
| 352 |
+
If a path starts with `%(prefix)/`, the remainder is interpreted as a
|
| 353 |
+
path relative to Git's "runtime prefix", i.e. relative to the location
|
| 354 |
+
where Git itself was installed. For example, `%(prefix)/bin/` refers to
|
| 355 |
+
the directory in which the Git executable itself lives. If Git was
|
| 356 |
+
compiled without runtime prefix support, the compiled-in prefix will be
|
| 357 |
+
substituted instead. In the unlikely event that a literal path needs to
|
| 358 |
+
be specified that should _not_ be expanded, it needs to be prefixed by
|
| 359 |
+
`./`, like so: `./%(prefix)/bin`.
|
| 360 |
+
+
|
| 361 |
+
If prefixed with `:(optional)`, the configuration variable is treated
|
| 362 |
+
as if it does not exist, if the named path does not exist.
|
| 363 |
+
|
| 364 |
+
Variables
|
| 365 |
+
~~~~~~~~~
|
| 366 |
+
|
| 367 |
+
Note that this list is non-comprehensive and not necessarily complete.
|
| 368 |
+
For command-specific variables, you will find a more detailed description
|
| 369 |
+
in the appropriate manual page.
|
| 370 |
+
|
| 371 |
+
Other git-related tools may and do use their own variables. When
|
| 372 |
+
inventing new variables for use in your own tool, make sure their
|
| 373 |
+
names do not conflict with those that are used by Git itself and
|
| 374 |
+
other popular tools, and describe them in your documentation.
|
| 375 |
+
|
| 376 |
+
include::config/add.adoc[]
|
| 377 |
+
|
| 378 |
+
include::config/advice.adoc[]
|
| 379 |
+
|
| 380 |
+
include::config/alias.adoc[]
|
| 381 |
+
|
| 382 |
+
include::config/am.adoc[]
|
| 383 |
+
|
| 384 |
+
include::config/apply.adoc[]
|
| 385 |
+
|
| 386 |
+
include::config/attr.adoc[]
|
| 387 |
+
|
| 388 |
+
include::config/bitmap-pseudo-merge.adoc[]
|
| 389 |
+
|
| 390 |
+
include::config/blame.adoc[]
|
| 391 |
+
|
| 392 |
+
include::config/branch.adoc[]
|
| 393 |
+
|
| 394 |
+
include::config/browser.adoc[]
|
| 395 |
+
|
| 396 |
+
include::config/bundle.adoc[]
|
| 397 |
+
|
| 398 |
+
include::config/checkout.adoc[]
|
| 399 |
+
|
| 400 |
+
include::config/clean.adoc[]
|
| 401 |
+
|
| 402 |
+
include::config/clone.adoc[]
|
| 403 |
+
|
| 404 |
+
include::config/color.adoc[]
|
| 405 |
+
|
| 406 |
+
include::config/column.adoc[]
|
| 407 |
+
|
| 408 |
+
include::config/commit.adoc[]
|
| 409 |
+
|
| 410 |
+
include::config/commitgraph.adoc[]
|
| 411 |
+
|
| 412 |
+
include::config/completion.adoc[]
|
| 413 |
+
|
| 414 |
+
include::config/core.adoc[]
|
| 415 |
+
|
| 416 |
+
include::config/credential.adoc[]
|
| 417 |
+
|
| 418 |
+
include::config/diff.adoc[]
|
| 419 |
+
|
| 420 |
+
include::config/difftool.adoc[]
|
| 421 |
+
|
| 422 |
+
include::config/extensions.adoc[]
|
| 423 |
+
|
| 424 |
+
include::config/fastimport.adoc[]
|
| 425 |
+
|
| 426 |
+
include::config/feature.adoc[]
|
| 427 |
+
|
| 428 |
+
include::config/fetch.adoc[]
|
| 429 |
+
|
| 430 |
+
include::config/filter.adoc[]
|
| 431 |
+
|
| 432 |
+
include::config/format.adoc[]
|
| 433 |
+
|
| 434 |
+
include::config/fsck.adoc[]
|
| 435 |
+
|
| 436 |
+
include::config/fsmonitor--daemon.adoc[]
|
| 437 |
+
|
| 438 |
+
include::config/gc.adoc[]
|
| 439 |
+
|
| 440 |
+
include::config/gitcvs.adoc[]
|
| 441 |
+
|
| 442 |
+
include::config/gitweb.adoc[]
|
| 443 |
+
|
| 444 |
+
include::config/gpg.adoc[]
|
| 445 |
+
|
| 446 |
+
include::config/grep.adoc[]
|
| 447 |
+
|
| 448 |
+
include::config/gui.adoc[]
|
| 449 |
+
|
| 450 |
+
include::config/guitool.adoc[]
|
| 451 |
+
|
| 452 |
+
include::config/help.adoc[]
|
| 453 |
+
|
| 454 |
+
include::config/http.adoc[]
|
| 455 |
+
|
| 456 |
+
include::config/i18n.adoc[]
|
| 457 |
+
|
| 458 |
+
include::config/imap.adoc[]
|
| 459 |
+
|
| 460 |
+
include::config/includeif.adoc[]
|
| 461 |
+
|
| 462 |
+
include::config/index.adoc[]
|
| 463 |
+
|
| 464 |
+
include::config/init.adoc[]
|
| 465 |
+
|
| 466 |
+
include::config/instaweb.adoc[]
|
| 467 |
+
|
| 468 |
+
include::config/interactive.adoc[]
|
| 469 |
+
|
| 470 |
+
include::config/log.adoc[]
|
| 471 |
+
|
| 472 |
+
include::config/lsrefs.adoc[]
|
| 473 |
+
|
| 474 |
+
include::config/mailinfo.adoc[]
|
| 475 |
+
|
| 476 |
+
include::config/mailmap.adoc[]
|
| 477 |
+
|
| 478 |
+
include::config/maintenance.adoc[]
|
| 479 |
+
|
| 480 |
+
include::config/man.adoc[]
|
| 481 |
+
|
| 482 |
+
include::config/merge.adoc[]
|
| 483 |
+
|
| 484 |
+
include::config/mergetool.adoc[]
|
| 485 |
+
|
| 486 |
+
include::config/notes.adoc[]
|
| 487 |
+
|
| 488 |
+
include::config/pack.adoc[]
|
| 489 |
+
|
| 490 |
+
include::config/pager.adoc[]
|
| 491 |
+
|
| 492 |
+
include::config/pretty.adoc[]
|
| 493 |
+
|
| 494 |
+
include::config/promisor.adoc[]
|
| 495 |
+
|
| 496 |
+
include::config/protocol.adoc[]
|
| 497 |
+
|
| 498 |
+
include::config/pull.adoc[]
|
| 499 |
+
|
| 500 |
+
include::config/push.adoc[]
|
| 501 |
+
|
| 502 |
+
include::config/rebase.adoc[]
|
| 503 |
+
|
| 504 |
+
include::config/receive.adoc[]
|
| 505 |
+
|
| 506 |
+
include::config/reftable.adoc[]
|
| 507 |
+
|
| 508 |
+
include::config/remote.adoc[]
|
| 509 |
+
|
| 510 |
+
include::config/remotes.adoc[]
|
| 511 |
+
|
| 512 |
+
include::config/repack.adoc[]
|
| 513 |
+
|
| 514 |
+
include::config/rerere.adoc[]
|
| 515 |
+
|
| 516 |
+
include::config/revert.adoc[]
|
| 517 |
+
|
| 518 |
+
include::config/safe.adoc[]
|
| 519 |
+
|
| 520 |
+
include::config/sendemail.adoc[]
|
| 521 |
+
|
| 522 |
+
include::config/sendpack.adoc[]
|
| 523 |
+
|
| 524 |
+
include::config/sequencer.adoc[]
|
| 525 |
+
|
| 526 |
+
include::config/showbranch.adoc[]
|
| 527 |
+
|
| 528 |
+
include::config/sideband.adoc[]
|
| 529 |
+
|
| 530 |
+
include::config/sparse.adoc[]
|
| 531 |
+
|
| 532 |
+
include::config/splitindex.adoc[]
|
| 533 |
+
|
| 534 |
+
include::config/ssh.adoc[]
|
| 535 |
+
|
| 536 |
+
include::config/stash.adoc[]
|
| 537 |
+
|
| 538 |
+
include::config/status.adoc[]
|
| 539 |
+
|
| 540 |
+
include::config/submodule.adoc[]
|
| 541 |
+
|
| 542 |
+
include::config/survey.adoc[]
|
| 543 |
+
|
| 544 |
+
include::config/tag.adoc[]
|
| 545 |
+
|
| 546 |
+
include::config/tar.adoc[]
|
| 547 |
+
|
| 548 |
+
include::config/trace2.adoc[]
|
| 549 |
+
|
| 550 |
+
include::config/trailer.adoc[]
|
| 551 |
+
|
| 552 |
+
include::config/transfer.adoc[]
|
| 553 |
+
|
| 554 |
+
include::config/uploadarchive.adoc[]
|
| 555 |
+
|
| 556 |
+
include::config/uploadpack.adoc[]
|
| 557 |
+
|
| 558 |
+
include::config/url.adoc[]
|
| 559 |
+
|
| 560 |
+
include::config/user.adoc[]
|
| 561 |
+
|
| 562 |
+
include::config/versionsort.adoc[]
|
| 563 |
+
|
| 564 |
+
include::config/web.adoc[]
|
| 565 |
+
|
| 566 |
+
include::config/windows.adoc[]
|
| 567 |
+
|
| 568 |
+
include::config/worktree.adoc[]
|
git/mingw64/share/doc/git-doc/date-formats.adoc
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
DATE FORMATS
|
| 2 |
+
------------
|
| 3 |
+
|
| 4 |
+
The `GIT_AUTHOR_DATE` and `GIT_COMMITTER_DATE` environment variables
|
| 5 |
+
support the following date formats:
|
| 6 |
+
|
| 7 |
+
Git internal format::
|
| 8 |
+
It is `<unix-timestamp> <time-zone-offset>`, where
|
| 9 |
+
`<unix-timestamp>` is the number of seconds since the UNIX epoch.
|
| 10 |
+
`<time-zone-offset>` is a positive or negative offset from UTC.
|
| 11 |
+
For example CET (which is 1 hour ahead of UTC) is `+0100`.
|
| 12 |
+
|
| 13 |
+
RFC 2822::
|
| 14 |
+
The standard date format as described by RFC 2822, for example
|
| 15 |
+
`Thu, 07 Apr 2005 22:13:13 +0200`.
|
| 16 |
+
|
| 17 |
+
ISO 8601::
|
| 18 |
+
Time and date specified by the ISO 8601 standard, for example
|
| 19 |
+
`2005-04-07T22:13:13`. The parser accepts a space instead of the
|
| 20 |
+
`T` character as well. Fractional parts of a second will be ignored,
|
| 21 |
+
for example `2005-04-07T22:13:13.019` will be treated as
|
| 22 |
+
`2005-04-07T22:13:13`.
|
| 23 |
+
+
|
| 24 |
+
NOTE: In addition, the date part is accepted in the following formats:
|
| 25 |
+
`YYYY.MM.DD`, `MM/DD/YYYY` and `DD.MM.YYYY`.
|
| 26 |
+
|
| 27 |
+
ifdef::git-commit[]
|
| 28 |
+
In addition to recognizing all date formats above, the `--date` option
|
| 29 |
+
will also try to make sense of other, more human-centric date formats,
|
| 30 |
+
such as relative dates like "yesterday" or "last Friday at noon".
|
| 31 |
+
endif::git-commit[]
|
git/mingw64/share/doc/git-doc/diff-algorithm-option.adoc
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
`--diff-algorithm=(patience|minimal|histogram|myers)`::
|
| 2 |
+
Choose a diff algorithm. The variants are as follows:
|
| 3 |
+
+
|
| 4 |
+
--
|
| 5 |
+
`default`;;
|
| 6 |
+
`myers`;;
|
| 7 |
+
The basic greedy diff algorithm. Currently, this is the default.
|
| 8 |
+
`minimal`;;
|
| 9 |
+
Spend extra time to make sure the smallest possible diff is
|
| 10 |
+
produced.
|
| 11 |
+
`patience`;;
|
| 12 |
+
Use "patience diff" algorithm when generating patches.
|
| 13 |
+
`histogram`;;
|
| 14 |
+
This algorithm extends the patience algorithm to "support
|
| 15 |
+
low-occurrence common elements".
|
| 16 |
+
--
|
| 17 |
+
+
|
| 18 |
+
For instance, if you configured the `diff.algorithm` variable to a
|
| 19 |
+
non-default value and want to use the default one, then you
|
| 20 |
+
have to use `--diff-algorithm=default` option.
|
git/mingw64/share/doc/git-doc/diff-context-options.adoc
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
`-U<n>`::
|
| 2 |
+
`--unified=<n>`::
|
| 3 |
+
Generate diffs with _<n>_ lines of context. The number of context
|
| 4 |
+
lines defaults to `diff.context` or 3 if the configuration variable
|
| 5 |
+
is unset. (`-U` without `<n>` is silently accepted as a synonym for
|
| 6 |
+
`-p` due to a historical accident).
|
| 7 |
+
|
| 8 |
+
`--inter-hunk-context=<n>`::
|
| 9 |
+
Show the context between diff hunks, up to the specified _<number>_
|
| 10 |
+
of lines, thereby fusing hunks that are close to each other.
|
| 11 |
+
Defaults to `diff.interHunkContext` or 0 if the config option
|
| 12 |
+
is unset.
|
git/mingw64/share/doc/git-doc/diff-format.adoc
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Raw output format
|
| 2 |
+
-----------------
|
| 3 |
+
|
| 4 |
+
The raw output format from `git-diff-index`, `git-diff-tree`,
|
| 5 |
+
`git-diff-files` and `git diff --raw` are very similar.
|
| 6 |
+
|
| 7 |
+
These commands all compare two sets of things; what is
|
| 8 |
+
compared differs:
|
| 9 |
+
|
| 10 |
+
`git-diff-index <tree-ish>`::
|
| 11 |
+
compares the _<tree-ish>_ and the files on the filesystem.
|
| 12 |
+
|
| 13 |
+
`git-diff-index --cached <tree-ish>`::
|
| 14 |
+
compares the _<tree-ish>_ and the index.
|
| 15 |
+
|
| 16 |
+
`git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]`::
|
| 17 |
+
compares the trees named by the two arguments.
|
| 18 |
+
|
| 19 |
+
`git-diff-files [<pattern>...]`::
|
| 20 |
+
compares the index and the files on the filesystem.
|
| 21 |
+
|
| 22 |
+
The `git-diff-tree` command begins its output by printing the hash of
|
| 23 |
+
what is being compared. After that, all the commands print one output
|
| 24 |
+
line per changed file.
|
| 25 |
+
|
| 26 |
+
An output line is formatted this way:
|
| 27 |
+
|
| 28 |
+
------------------------------------------------
|
| 29 |
+
in-place edit :100644 100644 bcd1234 0123456 M file0
|
| 30 |
+
copy-edit :100644 100644 abcd123 1234567 C68 file1 file2
|
| 31 |
+
rename-edit :100644 100644 abcd123 1234567 R86 file1 file3
|
| 32 |
+
create :000000 100644 0000000 1234567 A file4
|
| 33 |
+
delete :100644 000000 1234567 0000000 D file5
|
| 34 |
+
unmerged :000000 000000 0000000 0000000 U file6
|
| 35 |
+
------------------------------------------------
|
| 36 |
+
|
| 37 |
+
That is, from the left to the right:
|
| 38 |
+
|
| 39 |
+
. a colon.
|
| 40 |
+
. mode for "src"; 000000 if creation or unmerged.
|
| 41 |
+
. a space.
|
| 42 |
+
. mode for "dst"; 000000 if deletion or unmerged.
|
| 43 |
+
. a space.
|
| 44 |
+
. sha1 for "src"; 0\{40\} if creation or unmerged.
|
| 45 |
+
. a space.
|
| 46 |
+
. sha1 for "dst"; 0\{40\} if deletion, unmerged or "work tree out of sync with the index".
|
| 47 |
+
. a space.
|
| 48 |
+
. status, followed by optional "score" number.
|
| 49 |
+
. a tab or a NUL when `-z` option is used.
|
| 50 |
+
. path for "src"
|
| 51 |
+
. a tab or a NUL when `-z` option is used; only exists for C or R.
|
| 52 |
+
. path for "dst"; only exists for C or R.
|
| 53 |
+
. an LF or a NUL when `-z` option is used, to terminate the record.
|
| 54 |
+
|
| 55 |
+
Possible status letters are:
|
| 56 |
+
|
| 57 |
+
- `A`: addition of a file
|
| 58 |
+
- `C`: copy of a file into a new one
|
| 59 |
+
- `D`: deletion of a file
|
| 60 |
+
- `M`: modification of the contents or mode of a file
|
| 61 |
+
- `R`: renaming of a file
|
| 62 |
+
- `T`: change in the type of the file (regular file, symbolic link or submodule)
|
| 63 |
+
- `U`: file is unmerged (you must complete the merge before it can
|
| 64 |
+
be committed)
|
| 65 |
+
- `X`: "unknown" change type (most probably a bug, please report it)
|
| 66 |
+
|
| 67 |
+
Status letters `C` and `R` are always followed by a score (denoting the
|
| 68 |
+
percentage of similarity between the source and target of the move or
|
| 69 |
+
copy). Status letter `M` may be followed by a score (denoting the
|
| 70 |
+
percentage of dissimilarity) for file rewrites.
|
| 71 |
+
|
| 72 |
+
The sha1 for "dst" is shown as all 0's if a file on the filesystem
|
| 73 |
+
is out of sync with the index.
|
| 74 |
+
|
| 75 |
+
Example:
|
| 76 |
+
|
| 77 |
+
------------------------------------------------
|
| 78 |
+
:100644 100644 5be4a4a 0000000 M file.c
|
| 79 |
+
------------------------------------------------
|
| 80 |
+
|
| 81 |
+
Without the `-z` option, pathnames with "unusual" characters are
|
| 82 |
+
quoted as explained for the configuration variable `core.quotePath`
|
| 83 |
+
(see linkgit:git-config[1]). Using `-z` the filename is output
|
| 84 |
+
verbatim and the line is terminated by a NUL byte.
|
| 85 |
+
|
| 86 |
+
diff format for merges
|
| 87 |
+
----------------------
|
| 88 |
+
|
| 89 |
+
`git-diff-tree`, `git-diff-files` and `git-diff --raw`
|
| 90 |
+
can take `-c` or `--cc` option
|
| 91 |
+
to generate diff output also for merge commits. The output differs
|
| 92 |
+
from the format described above in the following way:
|
| 93 |
+
|
| 94 |
+
. there is a colon for each parent
|
| 95 |
+
. there are more "src" modes and "src" sha1
|
| 96 |
+
. status is concatenated status characters for each parent
|
| 97 |
+
. no optional "score" number
|
| 98 |
+
. tab-separated pathname(s) of the file
|
| 99 |
+
|
| 100 |
+
For `-c` and `--cc`, only the destination or final path is shown even
|
| 101 |
+
if the file was renamed on any side of history. With
|
| 102 |
+
`--combined-all-paths`, the name of the path in each parent is shown
|
| 103 |
+
followed by the name of the path in the merge commit.
|
| 104 |
+
|
| 105 |
+
Examples for `-c` and `--cc` without `--combined-all-paths`:
|
| 106 |
+
|
| 107 |
+
------------------------------------------------
|
| 108 |
+
::100644 100644 100644 fabadb8 cc95eb0 4866510 MM desc.c
|
| 109 |
+
::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM bar.sh
|
| 110 |
+
::100644 100644 100644 e07d6c5 9042e82 ee91881 RR phooey.c
|
| 111 |
+
------------------------------------------------
|
| 112 |
+
|
| 113 |
+
Examples when `--combined-all-paths` added to either `-c` or `--cc`:
|
| 114 |
+
|
| 115 |
+
------------------------------------------------
|
| 116 |
+
::100644 100644 100644 fabadb8 cc95eb0 4866510 MM desc.c desc.c desc.c
|
| 117 |
+
::100755 100755 100755 52b7a2d 6d1ac04 d2ac7d7 RM foo.sh bar.sh bar.sh
|
| 118 |
+
::100644 100644 100644 e07d6c5 9042e82 ee91881 RR fooey.c fuey.c phooey.c
|
| 119 |
+
------------------------------------------------
|
| 120 |
+
|
| 121 |
+
Note that 'combined diff' lists only files which were modified from
|
| 122 |
+
all parents.
|
| 123 |
+
|
| 124 |
+
|
| 125 |
+
include::diff-generate-patch.adoc[]
|
| 126 |
+
|
| 127 |
+
|
| 128 |
+
other diff formats
|
| 129 |
+
------------------
|
| 130 |
+
|
| 131 |
+
The `--summary` option describes newly added, deleted, renamed and
|
| 132 |
+
copied files. The `--stat` option adds `diffstat`(1) graph to the
|
| 133 |
+
output. These options can be combined with other options, such as
|
| 134 |
+
`-p`, and are meant for human consumption.
|
| 135 |
+
|
| 136 |
+
When showing a change that involves a rename or a copy, `--stat` output
|
| 137 |
+
formats the pathnames compactly by combining common prefix and suffix of
|
| 138 |
+
the pathnames. For example, a change that moves `arch/i386/Makefile` to
|
| 139 |
+
`arch/x86/Makefile` while modifying 4 lines will be shown like this:
|
| 140 |
+
|
| 141 |
+
------------------------------------
|
| 142 |
+
arch/{i386 => x86}/Makefile | 4 +--
|
| 143 |
+
------------------------------------
|
| 144 |
+
|
| 145 |
+
The `--numstat` option gives the diffstat(1) information but is designed
|
| 146 |
+
for easier machine consumption. An entry in `--numstat` output looks
|
| 147 |
+
like this:
|
| 148 |
+
|
| 149 |
+
----------------------------------------
|
| 150 |
+
1 2 README
|
| 151 |
+
3 1 arch/{i386 => x86}/Makefile
|
| 152 |
+
----------------------------------------
|
| 153 |
+
|
| 154 |
+
That is, from left to right:
|
| 155 |
+
|
| 156 |
+
. the number of added lines;
|
| 157 |
+
. a tab;
|
| 158 |
+
. the number of deleted lines;
|
| 159 |
+
. a tab;
|
| 160 |
+
. pathname (possibly with rename/copy information);
|
| 161 |
+
. a newline.
|
| 162 |
+
|
| 163 |
+
When `-z` output option is in effect, the output is formatted this way:
|
| 164 |
+
|
| 165 |
+
----------------------------------------
|
| 166 |
+
1 2 README NUL
|
| 167 |
+
3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL
|
| 168 |
+
----------------------------------------
|
| 169 |
+
|
| 170 |
+
That is:
|
| 171 |
+
|
| 172 |
+
. the number of added lines;
|
| 173 |
+
. a tab;
|
| 174 |
+
. the number of deleted lines;
|
| 175 |
+
. a tab;
|
| 176 |
+
. a NUL (only exists if renamed/copied);
|
| 177 |
+
. pathname in preimage;
|
| 178 |
+
. a NUL (only exists if renamed/copied);
|
| 179 |
+
. pathname in postimage (only exists if renamed/copied);
|
| 180 |
+
. a NUL.
|
| 181 |
+
|
| 182 |
+
The extra `NUL` before the preimage path in renamed case is to allow
|
| 183 |
+
scripts that read the output to tell if the current record being read is
|
| 184 |
+
a single-path record or a rename/copy record without reading ahead.
|
| 185 |
+
After reading added and deleted lines, reading up to `NUL` would yield
|
| 186 |
+
the pathname, but if that is `NUL`, the record will show two paths.
|
git/mingw64/share/doc/git-doc/diff-generate-patch.adoc
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[[generate_patch_text_with_p]]
|
| 2 |
+
Generating patch text with -p
|
| 3 |
+
-----------------------------
|
| 4 |
+
|
| 5 |
+
Running
|
| 6 |
+
linkgit:git-diff[1],
|
| 7 |
+
linkgit:git-log[1],
|
| 8 |
+
linkgit:git-show[1],
|
| 9 |
+
linkgit:git-diff-index[1],
|
| 10 |
+
linkgit:git-diff-tree[1], or
|
| 11 |
+
linkgit:git-diff-files[1]
|
| 12 |
+
with the `-p` option produces patch text.
|
| 13 |
+
You can customize the creation of patch text via the
|
| 14 |
+
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables
|
| 15 |
+
(see linkgit:git[1]), and the `diff` attribute (see linkgit:gitattributes[5]).
|
| 16 |
+
|
| 17 |
+
What the `-p` option produces is slightly different from the traditional
|
| 18 |
+
diff format:
|
| 19 |
+
|
| 20 |
+
1. It is preceded by a "git diff" header that looks like this:
|
| 21 |
+
|
| 22 |
+
diff --git a/file1 b/file2
|
| 23 |
+
+
|
| 24 |
+
The `a/` and `b/` filenames are the same unless rename/copy is
|
| 25 |
+
involved. Especially, even for a creation or a deletion,
|
| 26 |
+
`/dev/null` is _not_ used in place of the `a/` or `b/` filenames.
|
| 27 |
+
+
|
| 28 |
+
When a rename/copy is involved, `file1` and `file2` show the
|
| 29 |
+
name of the source file of the rename/copy and the name of
|
| 30 |
+
the file that the rename/copy produces, respectively.
|
| 31 |
+
|
| 32 |
+
2. It is followed by one or more extended header lines:
|
| 33 |
+
+
|
| 34 |
+
[synopsis]
|
| 35 |
+
old mode <mode>
|
| 36 |
+
new mode <mode>
|
| 37 |
+
deleted file mode <mode>
|
| 38 |
+
new file mode <mode>
|
| 39 |
+
copy from <path>
|
| 40 |
+
copy to <path>
|
| 41 |
+
rename from <path>
|
| 42 |
+
rename to <path>
|
| 43 |
+
similarity index <number>
|
| 44 |
+
dissimilarity index <number>
|
| 45 |
+
index <hash>..<hash> <mode>
|
| 46 |
+
+
|
| 47 |
+
File modes _<mode>_ are printed as 6-digit octal numbers including the file type
|
| 48 |
+
and file permission bits.
|
| 49 |
+
+
|
| 50 |
+
Path names in extended headers do not include the `a/` and `b/` prefixes.
|
| 51 |
+
+
|
| 52 |
+
The similarity index is the percentage of unchanged lines, and
|
| 53 |
+
the dissimilarity index is the percentage of changed lines. It
|
| 54 |
+
is a rounded down integer, followed by a percent sign. The
|
| 55 |
+
similarity index value of 100% is thus reserved for two equal
|
| 56 |
+
files, while 100% dissimilarity means that no line from the old
|
| 57 |
+
file made it into the new one.
|
| 58 |
+
+
|
| 59 |
+
The index line includes the blob object names before and after the change.
|
| 60 |
+
The _<mode>_ is included if the file mode does not change; otherwise,
|
| 61 |
+
separate lines indicate the old and the new mode.
|
| 62 |
+
|
| 63 |
+
3. Pathnames with "unusual" characters are quoted as explained for
|
| 64 |
+
the configuration variable `core.quotePath` (see
|
| 65 |
+
linkgit:git-config[1]).
|
| 66 |
+
|
| 67 |
+
4. All the `file1` files in the output refer to files before the
|
| 68 |
+
commit, and all the `file2` files refer to files after the commit.
|
| 69 |
+
It is incorrect to apply each change to each file sequentially. For
|
| 70 |
+
example, this patch will swap a and b:
|
| 71 |
+
|
| 72 |
+
diff --git a/a b/b
|
| 73 |
+
rename from a
|
| 74 |
+
rename to b
|
| 75 |
+
diff --git a/b b/a
|
| 76 |
+
rename from b
|
| 77 |
+
rename to a
|
| 78 |
+
|
| 79 |
+
5. Hunk headers mention the name of the function to which the hunk
|
| 80 |
+
applies. See "Defining a custom hunk-header" in
|
| 81 |
+
linkgit:gitattributes[5] for details of how to tailor this to
|
| 82 |
+
specific languages.
|
| 83 |
+
|
| 84 |
+
|
| 85 |
+
Combined diff format
|
| 86 |
+
--------------------
|
| 87 |
+
|
| 88 |
+
Any diff-generating command can take the `-c` or `--cc` option to
|
| 89 |
+
produce a 'combined diff' when showing a merge. This is the default
|
| 90 |
+
format when showing merges with linkgit:git-diff[1] or
|
| 91 |
+
linkgit:git-show[1]. Note also that you can give suitable
|
| 92 |
+
`--diff-merges` option to any of these commands to force generation of
|
| 93 |
+
diffs in a specific format.
|
| 94 |
+
|
| 95 |
+
A "combined diff" format looks like this:
|
| 96 |
+
|
| 97 |
+
------------
|
| 98 |
+
diff --combined describe.c
|
| 99 |
+
index fabadb8,cc95eb0..4866510
|
| 100 |
+
--- a/describe.c
|
| 101 |
+
+++ b/describe.c
|
| 102 |
+
@@@ -98,20 -98,12 +98,20 @@@
|
| 103 |
+
return (a_date > b_date) ? -1 : (a_date == b_date) ? 0 : 1;
|
| 104 |
+
}
|
| 105 |
+
|
| 106 |
+
- static void describe(char *arg)
|
| 107 |
+
-static void describe(struct commit *cmit, int last_one)
|
| 108 |
+
++static void describe(char *arg, int last_one)
|
| 109 |
+
{
|
| 110 |
+
+ unsigned char sha1[20];
|
| 111 |
+
+ struct commit *cmit;
|
| 112 |
+
struct commit_list *list;
|
| 113 |
+
static int initialized = 0;
|
| 114 |
+
struct commit_name *n;
|
| 115 |
+
|
| 116 |
+
+ if (get_sha1(arg, sha1) < 0)
|
| 117 |
+
+ usage(describe_usage);
|
| 118 |
+
+ cmit = lookup_commit_reference(sha1);
|
| 119 |
+
+ if (!cmit)
|
| 120 |
+
+ usage(describe_usage);
|
| 121 |
+
+
|
| 122 |
+
if (!initialized) {
|
| 123 |
+
initialized = 1;
|
| 124 |
+
for_each_ref(get_name);
|
| 125 |
+
------------
|
| 126 |
+
|
| 127 |
+
1. It is preceded by a "git diff" header, that looks like
|
| 128 |
+
this (when the `-c` option is used):
|
| 129 |
+
|
| 130 |
+
diff --combined file
|
| 131 |
+
+
|
| 132 |
+
or like this (when the `--cc` option is used):
|
| 133 |
+
|
| 134 |
+
diff --cc file
|
| 135 |
+
|
| 136 |
+
2. It is followed by one or more extended header lines
|
| 137 |
+
(this example shows a merge with two parents):
|
| 138 |
+
+
|
| 139 |
+
[synopsis]
|
| 140 |
+
index <hash>,<hash>..<hash>
|
| 141 |
+
mode <mode>,<mode>..<mode>
|
| 142 |
+
new file mode <mode>
|
| 143 |
+
deleted file mode <mode>,<mode>
|
| 144 |
+
+
|
| 145 |
+
The `mode <mode>,<mode>..<mode>` line appears only if at least one of
|
| 146 |
+
the <mode> is different from the rest. Extended headers with
|
| 147 |
+
information about detected content movement (renames and
|
| 148 |
+
copying detection) are designed to work with the diff of two
|
| 149 |
+
_<tree-ish>_ and are not used by combined diff format.
|
| 150 |
+
|
| 151 |
+
3. It is followed by a two-line from-file/to-file header:
|
| 152 |
+
|
| 153 |
+
--- a/file
|
| 154 |
+
+++ b/file
|
| 155 |
+
+
|
| 156 |
+
Similar to the two-line header for the traditional 'unified' diff
|
| 157 |
+
format, `/dev/null` is used to signal created or deleted
|
| 158 |
+
files.
|
| 159 |
+
+
|
| 160 |
+
However, if the --combined-all-paths option is provided, instead of a
|
| 161 |
+
two-line from-file/to-file, you get an N+1 line from-file/to-file header,
|
| 162 |
+
where N is the number of parents in the merge commit:
|
| 163 |
+
|
| 164 |
+
--- a/file
|
| 165 |
+
--- a/file
|
| 166 |
+
--- a/file
|
| 167 |
+
+++ b/file
|
| 168 |
+
+
|
| 169 |
+
This extended format can be useful if rename or copy detection is
|
| 170 |
+
active, to allow you to see the original name of the file in different
|
| 171 |
+
parents.
|
| 172 |
+
|
| 173 |
+
4. Chunk header format is modified to prevent people from
|
| 174 |
+
accidentally feeding it to `patch -p1`. Combined diff format
|
| 175 |
+
was created for review of merge commit changes, and was not
|
| 176 |
+
meant to be applied. The change is similar to the change in the
|
| 177 |
+
extended 'index' header:
|
| 178 |
+
|
| 179 |
+
@@@ <from-file-range> <from-file-range> <to-file-range> @@@
|
| 180 |
+
+
|
| 181 |
+
There are (number of parents + 1) `@` characters in the chunk
|
| 182 |
+
header for combined diff format.
|
| 183 |
+
|
| 184 |
+
Unlike the traditional 'unified' diff format, which shows two
|
| 185 |
+
files A and B with a single column that has `-` (minus --
|
| 186 |
+
appears in A but removed in B), `+` (plus -- missing in A but
|
| 187 |
+
added to B), or `" "` (space -- unchanged) prefix, this format
|
| 188 |
+
compares two or more files file1, file2,... with one file X, and
|
| 189 |
+
shows how X differs from each of fileN. One column for each of
|
| 190 |
+
fileN is prepended to the output line to note how X's line is
|
| 191 |
+
different from it.
|
| 192 |
+
|
| 193 |
+
A `-` character in the column N means that the line appears in
|
| 194 |
+
fileN but it does not appear in the result. A `+` character
|
| 195 |
+
in the column N means that the line appears in the result,
|
| 196 |
+
and fileN does not have that line (in other words, the line was
|
| 197 |
+
added, from the point of view of that parent).
|
| 198 |
+
|
| 199 |
+
In the above example output, the function signature was changed
|
| 200 |
+
from both files (hence two `-` removals from both file1 and
|
| 201 |
+
file2, plus `++` to mean one line that was added does not appear
|
| 202 |
+
in either file1 or file2). Also, eight other lines are the same
|
| 203 |
+
from file1 but do not appear in file2 (hence prefixed with `+`).
|
| 204 |
+
|
| 205 |
+
When shown by `git diff-tree -c`, it compares the parents of a
|
| 206 |
+
merge commit with the merge result (i.e. file1..fileN are the
|
| 207 |
+
parents). When shown by `git diff-files -c`, it compares the
|
| 208 |
+
two unresolved merge parents with the working tree file
|
| 209 |
+
(i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka
|
| 210 |
+
"their version").
|
git/mingw64/share/doc/git-doc/diff-options.adoc
ADDED
|
@@ -0,0 +1,917 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
// Please don't remove this comment as asciidoc behaves badly when
|
| 2 |
+
// the first non-empty line is ifdef/ifndef. The symptom is that
|
| 3 |
+
// without this comment the <git-diff-core> attribute conditionally
|
| 4 |
+
// defined below ends up being defined unconditionally.
|
| 5 |
+
// Last checked with asciidoc 7.0.2.
|
| 6 |
+
|
| 7 |
+
ifndef::git-format-patch[]
|
| 8 |
+
ifndef::git-diff[]
|
| 9 |
+
ifndef::git-log[]
|
| 10 |
+
:git-diff-core: 1
|
| 11 |
+
endif::git-log[]
|
| 12 |
+
endif::git-diff[]
|
| 13 |
+
endif::git-format-patch[]
|
| 14 |
+
|
| 15 |
+
ifdef::git-format-patch[]
|
| 16 |
+
-p::
|
| 17 |
+
--no-stat::
|
| 18 |
+
Generate plain patches without any diffstats.
|
| 19 |
+
endif::git-format-patch[]
|
| 20 |
+
|
| 21 |
+
ifndef::git-format-patch[]
|
| 22 |
+
`-p`::
|
| 23 |
+
`-u`::
|
| 24 |
+
`--patch`::
|
| 25 |
+
Generate patch (see <<generate_patch_text_with_p>>).
|
| 26 |
+
ifdef::git-diff[]
|
| 27 |
+
This is the default.
|
| 28 |
+
endif::git-diff[]
|
| 29 |
+
|
| 30 |
+
`-s`::
|
| 31 |
+
`--no-patch`::
|
| 32 |
+
Suppress all output from the diff machinery. Useful for
|
| 33 |
+
commands like `git show` that show the patch by default to
|
| 34 |
+
squelch their output, or to cancel the effect of options like
|
| 35 |
+
`--patch`, `--stat` earlier on the command line in an alias.
|
| 36 |
+
|
| 37 |
+
endif::git-format-patch[]
|
| 38 |
+
|
| 39 |
+
ifdef::git-log[]
|
| 40 |
+
`-m`::
|
| 41 |
+
Show diffs for merge commits in the default format. This is
|
| 42 |
+
similar to `--diff-merges=on`, except `-m` will
|
| 43 |
+
produce no output unless `-p` is given as well.
|
| 44 |
+
|
| 45 |
+
`-c`::
|
| 46 |
+
Produce combined diff output for merge commits.
|
| 47 |
+
Shortcut for `--diff-merges=combined -p`.
|
| 48 |
+
|
| 49 |
+
`--cc`::
|
| 50 |
+
Produce dense combined diff output for merge commits.
|
| 51 |
+
Shortcut for `--diff-merges=dense-combined -p`.
|
| 52 |
+
|
| 53 |
+
`--dd`::
|
| 54 |
+
Produce diff with respect to first parent for both merge and
|
| 55 |
+
regular commits.
|
| 56 |
+
Shortcut for `--diff-merges=first-parent -p`.
|
| 57 |
+
|
| 58 |
+
`--remerge-diff`::
|
| 59 |
+
Produce remerge-diff output for merge commits.
|
| 60 |
+
Shortcut for `--diff-merges=remerge -p`.
|
| 61 |
+
|
| 62 |
+
`--no-diff-merges`::
|
| 63 |
+
Synonym for `--diff-merges=off`.
|
| 64 |
+
|
| 65 |
+
`--diff-merges=<format>`::
|
| 66 |
+
Specify diff format to be used for merge commits. Default is
|
| 67 |
+
{diff-merges-default} unless `--first-parent` is in use, in
|
| 68 |
+
which case `first-parent` is the default.
|
| 69 |
+
+
|
| 70 |
+
The following formats are supported:
|
| 71 |
+
+
|
| 72 |
+
--
|
| 73 |
+
`off`::
|
| 74 |
+
`none`::
|
| 75 |
+
Disable output of diffs for merge commits. Useful to override
|
| 76 |
+
implied value.
|
| 77 |
+
|
| 78 |
+
`on`::
|
| 79 |
+
`m`::
|
| 80 |
+
Make diff output for merge commits to be shown in the default
|
| 81 |
+
format. The default format can be changed using
|
| 82 |
+
`log.diffMerges` configuration variable, whose default value
|
| 83 |
+
is `separate`.
|
| 84 |
+
|
| 85 |
+
`first-parent`::
|
| 86 |
+
`1`::
|
| 87 |
+
Show full diff with respect to first parent. This is the same
|
| 88 |
+
format as `--patch` produces for non-merge commits.
|
| 89 |
+
|
| 90 |
+
`separate`::
|
| 91 |
+
Show full diff with respect to each of parents.
|
| 92 |
+
Separate log entry and diff is generated for each parent.
|
| 93 |
+
|
| 94 |
+
`combined`::
|
| 95 |
+
`c`::
|
| 96 |
+
Show differences from each of the parents to the merge
|
| 97 |
+
result simultaneously instead of showing pairwise diff between
|
| 98 |
+
a parent and the result one at a time. Furthermore, it lists
|
| 99 |
+
only files which were modified from all parents.
|
| 100 |
+
|
| 101 |
+
`dense-combined`::
|
| 102 |
+
`cc`::
|
| 103 |
+
Further compress output produced by `--diff-merges=combined`
|
| 104 |
+
by omitting uninteresting hunks whose contents in the parents
|
| 105 |
+
have only two variants and the merge result picks one of them
|
| 106 |
+
without modification.
|
| 107 |
+
|
| 108 |
+
`remerge`::
|
| 109 |
+
`r`:: Remerge two-parent merge commits to create a temporary tree
|
| 110 |
+
object--potentially containing files with conflict markers
|
| 111 |
+
and such. A diff is then shown between that temporary tree
|
| 112 |
+
and the actual merge commit.
|
| 113 |
+
--
|
| 114 |
+
+
|
| 115 |
+
The output emitted when this option is used is subject to change, and
|
| 116 |
+
so is its interaction with other options (unless explicitly
|
| 117 |
+
documented).
|
| 118 |
+
|
| 119 |
+
|
| 120 |
+
`--combined-all-paths`::
|
| 121 |
+
Cause combined diffs (used for merge commits) to
|
| 122 |
+
list the name of the file from all parents. It thus only has
|
| 123 |
+
effect when `--diff-merges=[dense-]combined` is in use, and
|
| 124 |
+
is likely only useful if filename changes are detected (i.e.
|
| 125 |
+
when either rename or copy detection have been requested).
|
| 126 |
+
endif::git-log[]
|
| 127 |
+
|
| 128 |
+
`-U<n>`::
|
| 129 |
+
`--unified=<n>`::
|
| 130 |
+
Generate diffs with _<n>_ lines of context. The number of context
|
| 131 |
+
lines defaults to `diff.context` or 3 if the configuration variable
|
| 132 |
+
is unset. (`-U` without `<n>` is silently accepted as a synonym for
|
| 133 |
+
`-p` due to a historical accident).
|
| 134 |
+
ifndef::git-format-patch[]
|
| 135 |
+
Implies `--patch`.
|
| 136 |
+
endif::git-format-patch[]
|
| 137 |
+
|
| 138 |
+
`--output=<file>`::
|
| 139 |
+
Output to a specific file instead of stdout.
|
| 140 |
+
|
| 141 |
+
`--output-indicator-new=<char>`::
|
| 142 |
+
`--output-indicator-old=<char>`::
|
| 143 |
+
`--output-indicator-context=<char>`::
|
| 144 |
+
Specify the character used to indicate new, old or context
|
| 145 |
+
lines in the generated patch. Normally they are `+`, `-` and
|
| 146 |
+
' ' respectively.
|
| 147 |
+
|
| 148 |
+
ifndef::git-format-patch[]
|
| 149 |
+
`--raw`::
|
| 150 |
+
ifndef::git-log[]
|
| 151 |
+
Generate the diff in raw format.
|
| 152 |
+
ifdef::git-diff-core[]
|
| 153 |
+
This is the default.
|
| 154 |
+
endif::git-diff-core[]
|
| 155 |
+
endif::git-log[]
|
| 156 |
+
ifdef::git-log[]
|
| 157 |
+
For each commit, show a summary of changes using the raw diff
|
| 158 |
+
format. See the "RAW OUTPUT FORMAT" section of
|
| 159 |
+
linkgit:git-diff[1]. This is different from showing the log
|
| 160 |
+
itself in raw format, which you can achieve with
|
| 161 |
+
`--format=raw`.
|
| 162 |
+
endif::git-log[]
|
| 163 |
+
endif::git-format-patch[]
|
| 164 |
+
|
| 165 |
+
ifndef::git-format-patch[]
|
| 166 |
+
`--patch-with-raw`::
|
| 167 |
+
Synonym for `-p --raw`.
|
| 168 |
+
endif::git-format-patch[]
|
| 169 |
+
|
| 170 |
+
ifdef::git-log[]
|
| 171 |
+
`-t`::
|
| 172 |
+
Show the tree objects in the diff output.
|
| 173 |
+
endif::git-log[]
|
| 174 |
+
|
| 175 |
+
`--indent-heuristic`::
|
| 176 |
+
Enable the heuristic that shifts diff hunk boundaries to make patches
|
| 177 |
+
easier to read. This is the default.
|
| 178 |
+
|
| 179 |
+
`--no-indent-heuristic`::
|
| 180 |
+
Disable the indent heuristic.
|
| 181 |
+
|
| 182 |
+
`--minimal`::
|
| 183 |
+
Spend extra time to make sure the smallest possible
|
| 184 |
+
diff is produced.
|
| 185 |
+
|
| 186 |
+
`--patience`::
|
| 187 |
+
Generate a diff using the "patience diff" algorithm.
|
| 188 |
+
|
| 189 |
+
`--histogram`::
|
| 190 |
+
Generate a diff using the "histogram diff" algorithm.
|
| 191 |
+
|
| 192 |
+
`--anchored=<text>`::
|
| 193 |
+
Generate a diff using the "anchored diff" algorithm.
|
| 194 |
+
+
|
| 195 |
+
This option may be specified more than once.
|
| 196 |
+
+
|
| 197 |
+
If a line exists in both the source and destination, exists only once,
|
| 198 |
+
and starts with _<text>_, this algorithm attempts to prevent it from
|
| 199 |
+
appearing as a deletion or addition in the output. It uses the "patience
|
| 200 |
+
diff" algorithm internally.
|
| 201 |
+
|
| 202 |
+
include::diff-algorithm-option.adoc[]
|
| 203 |
+
|
| 204 |
+
`--stat[=<width>[,<name-width>[,<count>]]]`::
|
| 205 |
+
Generate a diffstat. By default, as much space as necessary
|
| 206 |
+
will be used for the filename part, and the rest for the graph
|
| 207 |
+
part. Maximum width defaults to terminal width, or 80 columns
|
| 208 |
+
if not connected to a terminal, and can be overridden by
|
| 209 |
+
_<width>_. The width of the filename part can be limited by
|
| 210 |
+
giving another width _<name-width>_ after a comma or by setting
|
| 211 |
+
`diff.statNameWidth=<name-width>`. The width of the graph part can be
|
| 212 |
+
limited by using `--stat-graph-width=<graph-width>` or by setting
|
| 213 |
+
`diff.statGraphWidth=<graph-width>`. Using `--stat` or
|
| 214 |
+
`--stat-graph-width` affects all commands generating a stat graph,
|
| 215 |
+
while setting `diff.statNameWidth` or `diff.statGraphWidth`
|
| 216 |
+
does not affect `git format-patch`.
|
| 217 |
+
By giving a third parameter _<count>_, you can limit the output to
|
| 218 |
+
the first _<count>_ lines, followed by `...` if there are more.
|
| 219 |
+
+
|
| 220 |
+
These parameters can also be set individually with `--stat-width=<width>`,
|
| 221 |
+
`--stat-name-width=<name-width>` and `--stat-count=<count>`.
|
| 222 |
+
|
| 223 |
+
`--compact-summary`::
|
| 224 |
+
Output a condensed summary of extended header information such
|
| 225 |
+
as file creations or deletions ("new" or "gone", optionally `+l`
|
| 226 |
+
if it's a symlink) and mode changes (`+x` or `-x` for adding
|
| 227 |
+
or removing executable bit respectively) in diffstat. The
|
| 228 |
+
information is put between the filename part and the graph
|
| 229 |
+
part. Implies `--stat`.
|
| 230 |
+
|
| 231 |
+
`--numstat`::
|
| 232 |
+
Similar to `--stat`, but shows number of added and
|
| 233 |
+
deleted lines in decimal notation and pathname without
|
| 234 |
+
abbreviation, to make it more machine friendly. For
|
| 235 |
+
binary files, outputs two `-` instead of saying
|
| 236 |
+
`0 0`.
|
| 237 |
+
|
| 238 |
+
`--shortstat`::
|
| 239 |
+
Output only the last line of the `--stat` format containing total
|
| 240 |
+
number of modified files, as well as number of added and deleted
|
| 241 |
+
lines.
|
| 242 |
+
|
| 243 |
+
`-X [<param>,...]`::
|
| 244 |
+
`--dirstat[=<param>,...]`::
|
| 245 |
+
Output the distribution of relative amount of changes for each
|
| 246 |
+
sub-directory. The behavior of `--dirstat` can be customized by
|
| 247 |
+
passing it a comma separated list of parameters.
|
| 248 |
+
The defaults are controlled by the `diff.dirstat` configuration
|
| 249 |
+
variable (see linkgit:git-config[1]).
|
| 250 |
+
The following parameters are available:
|
| 251 |
+
+
|
| 252 |
+
--
|
| 253 |
+
`changes`;;
|
| 254 |
+
Compute the dirstat numbers by counting the lines that have been
|
| 255 |
+
removed from the source, or added to the destination. This ignores
|
| 256 |
+
the amount of pure code movements within a file. In other words,
|
| 257 |
+
rearranging lines in a file is not counted as much as other changes.
|
| 258 |
+
This is the default behavior when no parameter is given.
|
| 259 |
+
`lines`;;
|
| 260 |
+
Compute the dirstat numbers by doing the regular line-based diff
|
| 261 |
+
analysis, and summing the removed/added line counts. (For binary
|
| 262 |
+
files, count 64-byte chunks instead, since binary files have no
|
| 263 |
+
natural concept of lines). This is a more expensive `--dirstat`
|
| 264 |
+
behavior than the `changes` behavior, but it does count rearranged
|
| 265 |
+
lines within a file as much as other changes. The resulting output
|
| 266 |
+
is consistent with what you get from the other `--*stat` options.
|
| 267 |
+
`files`;;
|
| 268 |
+
Compute the dirstat numbers by counting the number of files changed.
|
| 269 |
+
Each changed file counts equally in the dirstat analysis. This is
|
| 270 |
+
the computationally cheapest `--dirstat` behavior, since it does
|
| 271 |
+
not have to look at the file contents at all.
|
| 272 |
+
`cumulative`;;
|
| 273 |
+
Count changes in a child directory for the parent directory as well.
|
| 274 |
+
Note that when using `cumulative`, the sum of the percentages
|
| 275 |
+
reported may exceed 100%. The default (non-cumulative) behavior can
|
| 276 |
+
be specified with the `noncumulative` parameter.
|
| 277 |
+
_<limit>_;;
|
| 278 |
+
An integer parameter specifies a cut-off percent (3% by default).
|
| 279 |
+
Directories contributing less than this percentage of the changes
|
| 280 |
+
are not shown in the output.
|
| 281 |
+
--
|
| 282 |
+
+
|
| 283 |
+
Example: The following will count changed files, while ignoring
|
| 284 |
+
directories with less than 10% of the total amount of changed files,
|
| 285 |
+
and accumulating child directory counts in the parent directories:
|
| 286 |
+
`--dirstat=files,10,cumulative`.
|
| 287 |
+
|
| 288 |
+
`--cumulative`::
|
| 289 |
+
Synonym for `--dirstat=cumulative`.
|
| 290 |
+
|
| 291 |
+
`--dirstat-by-file[=<param>,...]`::
|
| 292 |
+
Synonym for `--dirstat=files,<param>,...`.
|
| 293 |
+
|
| 294 |
+
`--summary`::
|
| 295 |
+
Output a condensed summary of extended header information
|
| 296 |
+
such as creations, renames and mode changes.
|
| 297 |
+
|
| 298 |
+
ifndef::git-format-patch[]
|
| 299 |
+
`--patch-with-stat`::
|
| 300 |
+
Synonym for `-p --stat`.
|
| 301 |
+
endif::git-format-patch[]
|
| 302 |
+
|
| 303 |
+
ifndef::git-format-patch[]
|
| 304 |
+
|
| 305 |
+
`-z`::
|
| 306 |
+
ifdef::git-log[]
|
| 307 |
+
Separate the commits with __NUL__s instead of newlines.
|
| 308 |
+
+
|
| 309 |
+
Also, when `--raw` or `--numstat` has been given, do not munge
|
| 310 |
+
pathnames and use __NUL__s as output field terminators.
|
| 311 |
+
endif::git-log[]
|
| 312 |
+
ifndef::git-log[]
|
| 313 |
+
When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
|
| 314 |
+
given, do not munge pathnames and use NULs as output field terminators.
|
| 315 |
+
endif::git-log[]
|
| 316 |
+
+
|
| 317 |
+
Without this option, pathnames with "unusual" characters are quoted as
|
| 318 |
+
explained for the configuration variable `core.quotePath` (see
|
| 319 |
+
linkgit:git-config[1]).
|
| 320 |
+
|
| 321 |
+
`--name-only`::
|
| 322 |
+
Show only the name of each changed file in the post-image tree.
|
| 323 |
+
The file names are often encoded in UTF-8.
|
| 324 |
+
For more information see the discussion about encoding in the linkgit:git-log[1]
|
| 325 |
+
manual page.
|
| 326 |
+
|
| 327 |
+
`--name-status`::
|
| 328 |
+
Show only the name(s) and status of each changed file. See the description
|
| 329 |
+
of the `--diff-filter` option on what the status letters mean.
|
| 330 |
+
Just like `--name-only` the file names are often encoded in UTF-8.
|
| 331 |
+
|
| 332 |
+
`--submodule[=<format>]`::
|
| 333 |
+
Specify how differences in submodules are shown. When specifying
|
| 334 |
+
`--submodule=short` the `short` format is used. This format just
|
| 335 |
+
shows the names of the commits at the beginning and end of the range.
|
| 336 |
+
When `--submodule` or `--submodule=log` is specified, the `log`
|
| 337 |
+
format is used. This format lists the commits in the range like
|
| 338 |
+
linkgit:git-submodule[1] `summary` does. When `--submodule=diff`
|
| 339 |
+
is specified, the `diff` format is used. This format shows an
|
| 340 |
+
inline diff of the changes in the submodule contents between the
|
| 341 |
+
commit range. Defaults to `diff.submodule` or the `short` format
|
| 342 |
+
if the config option is unset.
|
| 343 |
+
|
| 344 |
+
`--color[=<when>]`::
|
| 345 |
+
Show colored diff.
|
| 346 |
+
`--color` (i.e. without `=<when>`) is the same as `--color=always`.
|
| 347 |
+
_<when>_ can be one of `always`, `never`, or `auto`.
|
| 348 |
+
ifdef::git-diff[]
|
| 349 |
+
It can be changed by the `color.ui` and `color.diff`
|
| 350 |
+
configuration settings.
|
| 351 |
+
endif::git-diff[]
|
| 352 |
+
|
| 353 |
+
`--no-color`::
|
| 354 |
+
Turn off colored diff.
|
| 355 |
+
ifdef::git-diff[]
|
| 356 |
+
This can be used to override configuration settings.
|
| 357 |
+
endif::git-diff[]
|
| 358 |
+
It is the same as `--color=never`.
|
| 359 |
+
|
| 360 |
+
`--color-moved[=<mode>]`::
|
| 361 |
+
Moved lines of code are colored differently.
|
| 362 |
+
ifdef::git-diff[]
|
| 363 |
+
It can be changed by the `diff.colorMoved` configuration setting.
|
| 364 |
+
endif::git-diff[]
|
| 365 |
+
The _<mode>_ defaults to `no` if the option is not given
|
| 366 |
+
and to `zebra` if the option with no mode is given.
|
| 367 |
+
The mode must be one of:
|
| 368 |
+
+
|
| 369 |
+
--
|
| 370 |
+
`no`::
|
| 371 |
+
Moved lines are not highlighted.
|
| 372 |
+
`default`::
|
| 373 |
+
Is a synonym for `zebra`. This may change to a more sensible mode
|
| 374 |
+
in the future.
|
| 375 |
+
`plain`::
|
| 376 |
+
Any line that is added in one location and was removed
|
| 377 |
+
in another location will be colored with `color.diff.newMoved`.
|
| 378 |
+
Similarly `color.diff.oldMoved` will be used for removed lines
|
| 379 |
+
that are added somewhere else in the diff. This mode picks up any
|
| 380 |
+
moved line, but it is not very useful in a review to determine
|
| 381 |
+
if a block of code was moved without permutation.
|
| 382 |
+
`blocks`::
|
| 383 |
+
Blocks of moved text of at least 20 alphanumeric characters
|
| 384 |
+
are detected greedily. The detected blocks are
|
| 385 |
+
painted using either the `color.diff.(old|new)Moved` color.
|
| 386 |
+
Adjacent blocks cannot be told apart.
|
| 387 |
+
`zebra`::
|
| 388 |
+
Blocks of moved text are detected as in `blocks` mode. The blocks
|
| 389 |
+
are painted using either the `color.diff.(old|new)Moved` color or
|
| 390 |
+
`color.diff.(old|new)MovedAlternative`. The change between
|
| 391 |
+
the two colors indicates that a new block was detected.
|
| 392 |
+
`dimmed-zebra`::
|
| 393 |
+
Similar to `zebra`, but additional dimming of uninteresting parts
|
| 394 |
+
of moved code is performed. The bordering lines of two adjacent
|
| 395 |
+
blocks are considered interesting, the rest is uninteresting.
|
| 396 |
+
`dimmed_zebra` is a deprecated synonym.
|
| 397 |
+
--
|
| 398 |
+
|
| 399 |
+
`--no-color-moved`::
|
| 400 |
+
Turn off move detection. This can be used to override configuration
|
| 401 |
+
settings. It is the same as `--color-moved=no`.
|
| 402 |
+
|
| 403 |
+
`--color-moved-ws=<mode>,...`::
|
| 404 |
+
This configures how whitespace is ignored when performing the
|
| 405 |
+
move detection for `--color-moved`.
|
| 406 |
+
ifdef::git-diff[]
|
| 407 |
+
It can be set by the `diff.colorMovedWS` configuration setting.
|
| 408 |
+
endif::git-diff[]
|
| 409 |
+
These modes can be given as a comma separated list:
|
| 410 |
+
+
|
| 411 |
+
--
|
| 412 |
+
`no`::
|
| 413 |
+
Do not ignore whitespace when performing move detection.
|
| 414 |
+
`ignore-space-at-eol`::
|
| 415 |
+
Ignore changes in whitespace at EOL.
|
| 416 |
+
`ignore-space-change`::
|
| 417 |
+
Ignore changes in amount of whitespace. This ignores whitespace
|
| 418 |
+
at line end, and considers all other sequences of one or
|
| 419 |
+
more whitespace characters to be equivalent.
|
| 420 |
+
`ignore-all-space`::
|
| 421 |
+
Ignore whitespace when comparing lines. This ignores differences
|
| 422 |
+
even if one line has whitespace where the other line has none.
|
| 423 |
+
`allow-indentation-change`::
|
| 424 |
+
Initially ignore any whitespace in the move detection, then
|
| 425 |
+
group the moved code blocks only into a block if the change in
|
| 426 |
+
whitespace is the same per line. This is incompatible with the
|
| 427 |
+
other modes.
|
| 428 |
+
--
|
| 429 |
+
|
| 430 |
+
`--no-color-moved-ws`::
|
| 431 |
+
Do not ignore whitespace when performing move detection. This can be
|
| 432 |
+
used to override configuration settings. It is the same as
|
| 433 |
+
`--color-moved-ws=no`.
|
| 434 |
+
|
| 435 |
+
`--word-diff[=<mode>]`::
|
| 436 |
+
By default, words are delimited by whitespace; see
|
| 437 |
+
`--word-diff-regex` below. The _<mode>_ defaults to `plain`, and
|
| 438 |
+
must be one of:
|
| 439 |
+
+
|
| 440 |
+
--
|
| 441 |
+
`color`::
|
| 442 |
+
Highlight changed words using only colors. Implies `--color`.
|
| 443 |
+
`plain`::
|
| 444 |
+
Show words as ++[-removed-]++ and ++{+added+}++. Makes no
|
| 445 |
+
attempts to escape the delimiters if they appear in the input,
|
| 446 |
+
so the output may be ambiguous.
|
| 447 |
+
`porcelain`::
|
| 448 |
+
Use a special line-based format intended for script
|
| 449 |
+
consumption. Added/removed/unchanged runs are printed in the
|
| 450 |
+
usual unified diff format, starting with a `+`/`-`/` `
|
| 451 |
+
character at the beginning of the line and extending to the
|
| 452 |
+
end of the line. Newlines in the input are represented by a
|
| 453 |
+
tilde `~` on a line of its own.
|
| 454 |
+
`none`::
|
| 455 |
+
Disable word diff again.
|
| 456 |
+
--
|
| 457 |
+
+
|
| 458 |
+
Note that despite the name of the first mode, color is used to
|
| 459 |
+
highlight the changed parts in all modes if enabled.
|
| 460 |
+
|
| 461 |
+
`--word-diff-regex=<regex>`::
|
| 462 |
+
Use _<regex>_ to decide what a word is, instead of considering
|
| 463 |
+
runs of non-whitespace to be a word. Also implies
|
| 464 |
+
`--word-diff` unless it was already enabled.
|
| 465 |
+
+
|
| 466 |
+
Every non-overlapping match of the
|
| 467 |
+
_<regex>_ is considered a word. Anything between these matches is
|
| 468 |
+
considered whitespace and ignored(!) for the purposes of finding
|
| 469 |
+
differences. You may want to append `|[^[:space:]]` to your regular
|
| 470 |
+
expression to make sure that it matches all non-whitespace characters.
|
| 471 |
+
A match that contains a newline is silently truncated(!) at the
|
| 472 |
+
newline.
|
| 473 |
+
+
|
| 474 |
+
For example, `--word-diff-regex=.` will treat each character as a word
|
| 475 |
+
and, correspondingly, show differences character by character.
|
| 476 |
+
+
|
| 477 |
+
The regex can also be set via a diff driver or configuration option, see
|
| 478 |
+
linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly
|
| 479 |
+
overrides any diff driver or configuration setting. Diff drivers
|
| 480 |
+
override configuration settings.
|
| 481 |
+
|
| 482 |
+
`--color-words[=<regex>]`::
|
| 483 |
+
Equivalent to `--word-diff=color` plus (if a regex was
|
| 484 |
+
specified) `--word-diff-regex=<regex>`.
|
| 485 |
+
endif::git-format-patch[]
|
| 486 |
+
|
| 487 |
+
`--no-renames`::
|
| 488 |
+
Turn off rename detection, even when the configuration
|
| 489 |
+
file gives the default to do so.
|
| 490 |
+
|
| 491 |
+
`--rename-empty`::
|
| 492 |
+
`--no-rename-empty`::
|
| 493 |
+
Whether to use empty blobs as rename source.
|
| 494 |
+
|
| 495 |
+
ifndef::git-format-patch[]
|
| 496 |
+
`--check`::
|
| 497 |
+
Warn if changes introduce conflict markers or whitespace errors.
|
| 498 |
+
What are considered whitespace errors is controlled by `core.whitespace`
|
| 499 |
+
configuration. By default, trailing whitespaces (including
|
| 500 |
+
lines that consist solely of whitespaces) and a space character
|
| 501 |
+
that is immediately followed by a tab character inside the
|
| 502 |
+
initial indent of the line are considered whitespace errors.
|
| 503 |
+
Exits with non-zero status if problems are found. Not compatible
|
| 504 |
+
with `--exit-code`.
|
| 505 |
+
|
| 506 |
+
`--ws-error-highlight=<kind>`::
|
| 507 |
+
Highlight whitespace errors in the `context`, `old` or `new`
|
| 508 |
+
lines of the diff. Multiple values are separated by comma,
|
| 509 |
+
`none` resets previous values, `default` reset the list to
|
| 510 |
+
`new` and `all` is a shorthand for `old,new,context`. When
|
| 511 |
+
this option is not given, and the configuration variable
|
| 512 |
+
`diff.wsErrorHighlight` is not set, only whitespace errors in
|
| 513 |
+
`new` lines are highlighted. The whitespace errors are colored
|
| 514 |
+
with `color.diff.whitespace`.
|
| 515 |
+
|
| 516 |
+
endif::git-format-patch[]
|
| 517 |
+
|
| 518 |
+
`--full-index`::
|
| 519 |
+
Instead of the first handful of characters, show the full
|
| 520 |
+
pre- and post-image blob object names on the "index"
|
| 521 |
+
line when generating patch format output.
|
| 522 |
+
|
| 523 |
+
`--binary`::
|
| 524 |
+
In addition to `--full-index`, output a binary diff that
|
| 525 |
+
can be applied with `git-apply`.
|
| 526 |
+
ifndef::git-format-patch[]
|
| 527 |
+
Implies `--patch`.
|
| 528 |
+
endif::git-format-patch[]
|
| 529 |
+
|
| 530 |
+
`--abbrev[=<n>]`::
|
| 531 |
+
Instead of showing the full 40-byte hexadecimal object
|
| 532 |
+
name in diff-raw format output and diff-tree header
|
| 533 |
+
lines, show the shortest prefix that is at least _<n>_
|
| 534 |
+
hexdigits long that uniquely refers the object.
|
| 535 |
+
In diff-patch output format, `--full-index` takes higher
|
| 536 |
+
precedence, i.e. if `--full-index` is specified, full blob
|
| 537 |
+
names will be shown regardless of `--abbrev`.
|
| 538 |
+
Non default number of digits can be specified with `--abbrev=<n>`.
|
| 539 |
+
|
| 540 |
+
`-B[<n>][/<m>]`::
|
| 541 |
+
`--break-rewrites[=[<n>][/<m>]]`::
|
| 542 |
+
Break complete rewrite changes into pairs of delete and
|
| 543 |
+
create. This serves two purposes:
|
| 544 |
+
+
|
| 545 |
+
It affects the way a change that amounts to a total rewrite of a file
|
| 546 |
+
not as a series of deletion and insertion mixed together with a very
|
| 547 |
+
few lines that happen to match textually as the context, but as a
|
| 548 |
+
single deletion of everything old followed by a single insertion of
|
| 549 |
+
everything new, and the number _<m>_ controls this aspect of the `-B`
|
| 550 |
+
option (defaults to 60%). `-B/70%` specifies that less than 30% of the
|
| 551 |
+
original should remain in the result for Git to consider it a total
|
| 552 |
+
rewrite (i.e. otherwise the resulting patch will be a series of
|
| 553 |
+
deletion and insertion mixed together with context lines).
|
| 554 |
+
+
|
| 555 |
+
When used with `-M`, a totally-rewritten file is also considered as the
|
| 556 |
+
source of a rename (usually `-M` only considers a file that disappeared
|
| 557 |
+
as the source of a rename), and the number _<n>_ controls this aspect of
|
| 558 |
+
the `-B` option (defaults to 50%). `-B20%` specifies that a change with
|
| 559 |
+
addition and deletion compared to 20% or more of the file's size are
|
| 560 |
+
eligible for being picked up as a possible source of a rename to
|
| 561 |
+
another file.
|
| 562 |
+
|
| 563 |
+
`-M[<n>]`::
|
| 564 |
+
`--find-renames[=<n>]`::
|
| 565 |
+
ifndef::git-log[]
|
| 566 |
+
Detect renames.
|
| 567 |
+
endif::git-log[]
|
| 568 |
+
ifdef::git-log[]
|
| 569 |
+
If generating diffs, detect and report renames for each commit.
|
| 570 |
+
For following files across renames while traversing history, see
|
| 571 |
+
`--follow`.
|
| 572 |
+
endif::git-log[]
|
| 573 |
+
If _<n>_ is specified, it is a threshold on the similarity
|
| 574 |
+
index (i.e. amount of addition/deletions compared to the
|
| 575 |
+
file's size). For example, `-M90%` means Git should consider a
|
| 576 |
+
delete/add pair to be a rename if more than 90% of the file
|
| 577 |
+
hasn't changed. Without a `%` sign, the number is to be read as
|
| 578 |
+
a fraction, with a decimal point before it. I.e., `-M5` becomes
|
| 579 |
+
0.5, and is thus the same as `-M50%`. Similarly, `-M05` is
|
| 580 |
+
the same as `-M5%`. To limit detection to exact renames, use
|
| 581 |
+
`-M100%`. The default similarity index is 50%.
|
| 582 |
+
|
| 583 |
+
`-C[<n>]`::
|
| 584 |
+
`--find-copies[=<n>]`::
|
| 585 |
+
Detect copies as well as renames. See also `--find-copies-harder`.
|
| 586 |
+
If _<n>_ is specified, it has the same meaning as for `-M<n>`.
|
| 587 |
+
|
| 588 |
+
`--find-copies-harder`::
|
| 589 |
+
For performance reasons, by default, `-C` option finds copies only
|
| 590 |
+
if the original file of the copy was modified in the same
|
| 591 |
+
changeset. This flag makes the command
|
| 592 |
+
inspect unmodified files as candidates for the source of
|
| 593 |
+
copy. This is a very expensive operation for large
|
| 594 |
+
projects, so use it with caution. Giving more than one
|
| 595 |
+
`-C` option has the same effect.
|
| 596 |
+
|
| 597 |
+
`-D`::
|
| 598 |
+
`--irreversible-delete`::
|
| 599 |
+
Omit the preimage for deletes, i.e. print only the header but not
|
| 600 |
+
the diff between the preimage and `/dev/null`. The resulting patch
|
| 601 |
+
is not meant to be applied with `patch` or `git apply`; this is
|
| 602 |
+
solely for people who want to just concentrate on reviewing the
|
| 603 |
+
text after the change. In addition, the output obviously lacks
|
| 604 |
+
enough information to apply such a patch in reverse, even manually,
|
| 605 |
+
hence the name of the option.
|
| 606 |
+
+
|
| 607 |
+
When used together with `-B`, omit also the preimage in the deletion part
|
| 608 |
+
of a delete/create pair.
|
| 609 |
+
|
| 610 |
+
`-l<num>`::
|
| 611 |
+
The `-M` and `-C` options involve some preliminary steps that
|
| 612 |
+
can detect subsets of renames/copies cheaply, followed by an
|
| 613 |
+
exhaustive fallback portion that compares all remaining
|
| 614 |
+
unpaired destinations to all relevant sources. (For renames,
|
| 615 |
+
only remaining unpaired sources are relevant; for copies, all
|
| 616 |
+
original sources are relevant.) For N sources and
|
| 617 |
+
destinations, this exhaustive check is O(N^2). This option
|
| 618 |
+
prevents the exhaustive portion of rename/copy detection from
|
| 619 |
+
running if the number of source/destination files involved
|
| 620 |
+
exceeds the specified number. Defaults to `diff.renameLimit`.
|
| 621 |
+
Note that a value of 0 is treated as unlimited.
|
| 622 |
+
|
| 623 |
+
ifndef::git-format-patch[]
|
| 624 |
+
`--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]`::
|
| 625 |
+
Select only files that are Added (`A`), Copied (`C`),
|
| 626 |
+
Deleted (`D`), Modified (`M`), Renamed (`R`), have their
|
| 627 |
+
type (i.e. regular file, symlink, submodule, ...) changed (`T`),
|
| 628 |
+
are Unmerged (`U`), are
|
| 629 |
+
Unknown (`X`), or have had their pairing Broken (`B`).
|
| 630 |
+
Any combination of the filter characters (including none) can be used.
|
| 631 |
+
When `*` (All-or-none) is added to the combination, all
|
| 632 |
+
paths are selected if there is any file that matches
|
| 633 |
+
other criteria in the comparison; if there is no file
|
| 634 |
+
that matches other criteria, nothing is selected.
|
| 635 |
+
+
|
| 636 |
+
Also, these upper-case letters can be downcased to exclude. E.g.
|
| 637 |
+
`--diff-filter=ad` excludes added and deleted paths.
|
| 638 |
+
+
|
| 639 |
+
Note that not all diffs can feature all types. For instance, copied and
|
| 640 |
+
renamed entries cannot appear if detection for those types is disabled.
|
| 641 |
+
|
| 642 |
+
`-S<string>`::
|
| 643 |
+
Look for differences that change the number of occurrences of
|
| 644 |
+
the specified _<string>_ (i.e. addition/deletion) in a file.
|
| 645 |
+
Intended for the scripter's use.
|
| 646 |
+
+
|
| 647 |
+
It is useful when you're looking for an exact block of code (like a
|
| 648 |
+
struct), and want to know the history of that block since it first
|
| 649 |
+
came into being: use the feature iteratively to feed the interesting
|
| 650 |
+
block in the preimage back into `-S`, and keep going until you get the
|
| 651 |
+
very first version of the block.
|
| 652 |
+
+
|
| 653 |
+
Binary files are searched as well.
|
| 654 |
+
|
| 655 |
+
`-G<regex>`::
|
| 656 |
+
Look for differences whose patch text contains added/removed
|
| 657 |
+
lines that match _<regex>_.
|
| 658 |
+
+
|
| 659 |
+
To illustrate the difference between `-S<regex>` `--pickaxe-regex` and
|
| 660 |
+
`-G<regex>`, consider a commit with the following diff in the same
|
| 661 |
+
file:
|
| 662 |
+
+
|
| 663 |
+
----
|
| 664 |
+
+ return frotz(nitfol, two->ptr, 1, 0);
|
| 665 |
+
...
|
| 666 |
+
- hit = frotz(nitfol, mf2.ptr, 1, 0);
|
| 667 |
+
----
|
| 668 |
+
+
|
| 669 |
+
While `git log -G"frotz\(nitfol"` will show this commit, `git log
|
| 670 |
+
-S"frotz\(nitfol" --pickaxe-regex` will not (because the number of
|
| 671 |
+
occurrences of that string did not change).
|
| 672 |
+
+
|
| 673 |
+
Unless `--text` is supplied patches of binary files without a textconv
|
| 674 |
+
filter will be ignored.
|
| 675 |
+
+
|
| 676 |
+
See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more
|
| 677 |
+
information.
|
| 678 |
+
|
| 679 |
+
`--find-object=<object-id>`::
|
| 680 |
+
Look for differences that change the number of occurrences of
|
| 681 |
+
the specified object. Similar to `-S`, just the argument is different
|
| 682 |
+
in that it doesn't search for a specific string but for a specific
|
| 683 |
+
object id.
|
| 684 |
+
+
|
| 685 |
+
The object can be a blob or a submodule commit. It implies the `-t` option in
|
| 686 |
+
`git-log` to also find trees.
|
| 687 |
+
|
| 688 |
+
`--pickaxe-all`::
|
| 689 |
+
When `-S` or `-G` finds a change, show all the changes in that
|
| 690 |
+
changeset, not just the files that contain the change
|
| 691 |
+
in _<string>_.
|
| 692 |
+
|
| 693 |
+
`--pickaxe-regex`::
|
| 694 |
+
Treat the _<string>_ given to `-S` as an extended POSIX regular
|
| 695 |
+
expression to match.
|
| 696 |
+
|
| 697 |
+
endif::git-format-patch[]
|
| 698 |
+
|
| 699 |
+
`-O<orderfile>`::
|
| 700 |
+
Control the order in which files appear in the output.
|
| 701 |
+
This overrides the `diff.orderFile` configuration variable
|
| 702 |
+
(see linkgit:git-config[1]). To cancel `diff.orderFile`,
|
| 703 |
+
use `-O/dev/null`.
|
| 704 |
+
+
|
| 705 |
+
The output order is determined by the order of glob patterns in
|
| 706 |
+
_<orderfile>_.
|
| 707 |
+
All files with pathnames that match the first pattern are output
|
| 708 |
+
first, all files with pathnames that match the second pattern (but not
|
| 709 |
+
the first) are output next, and so on.
|
| 710 |
+
All files with pathnames that do not match any pattern are output
|
| 711 |
+
last, as if there was an implicit match-all pattern at the end of the
|
| 712 |
+
file.
|
| 713 |
+
If multiple pathnames have the same rank (they match the same pattern
|
| 714 |
+
but no earlier patterns), their output order relative to each other is
|
| 715 |
+
the normal order.
|
| 716 |
+
+
|
| 717 |
+
_<orderfile>_ is parsed as follows:
|
| 718 |
+
+
|
| 719 |
+
--
|
| 720 |
+
- Blank lines are ignored, so they can be used as separators for
|
| 721 |
+
readability.
|
| 722 |
+
|
| 723 |
+
- Lines starting with a hash ("`#`") are ignored, so they can be used
|
| 724 |
+
for comments. Add a backslash ("`\`") to the beginning of the
|
| 725 |
+
pattern if it starts with a hash.
|
| 726 |
+
|
| 727 |
+
- Each other line contains a single pattern.
|
| 728 |
+
--
|
| 729 |
+
+
|
| 730 |
+
Patterns have the same syntax and semantics as patterns used for
|
| 731 |
+
`fnmatch`(3) without the `FNM_PATHNAME` flag, except a pathname also
|
| 732 |
+
matches a pattern if removing any number of the final pathname
|
| 733 |
+
components matches the pattern. For example, the pattern "`foo*bar`"
|
| 734 |
+
matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
|
| 735 |
+
|
| 736 |
+
`--skip-to=<file>`::
|
| 737 |
+
`--rotate-to=<file>`::
|
| 738 |
+
Discard the files before the named _<file>_ from the output
|
| 739 |
+
(i.e. 'skip to'), or move them to the end of the output
|
| 740 |
+
(i.e. 'rotate to'). These options were invented primarily for the use
|
| 741 |
+
of the `git difftool` command, and may not be very useful
|
| 742 |
+
otherwise.
|
| 743 |
+
|
| 744 |
+
ifndef::git-format-patch[]
|
| 745 |
+
`-R`::
|
| 746 |
+
Swap two inputs; that is, show differences from index or
|
| 747 |
+
on-disk file to tree contents.
|
| 748 |
+
endif::git-format-patch[]
|
| 749 |
+
|
| 750 |
+
`--relative[=<path>]`::
|
| 751 |
+
`--no-relative`::
|
| 752 |
+
When run from a subdirectory of the project, it can be
|
| 753 |
+
told to exclude changes outside the directory and show
|
| 754 |
+
pathnames relative to it with this option. When you are
|
| 755 |
+
not in a subdirectory (e.g. in a bare repository), you
|
| 756 |
+
can name which subdirectory to make the output relative
|
| 757 |
+
to by giving a _<path>_ as an argument.
|
| 758 |
+
`--no-relative` can be used to countermand both `diff.relative` config
|
| 759 |
+
option and previous `--relative`.
|
| 760 |
+
|
| 761 |
+
`-a`::
|
| 762 |
+
`--text`::
|
| 763 |
+
Treat all files as text.
|
| 764 |
+
|
| 765 |
+
`--ignore-cr-at-eol`::
|
| 766 |
+
Ignore carriage-return at the end of line when doing a comparison.
|
| 767 |
+
|
| 768 |
+
`--ignore-space-at-eol`::
|
| 769 |
+
Ignore changes in whitespace at EOL.
|
| 770 |
+
|
| 771 |
+
`-b`::
|
| 772 |
+
`--ignore-space-change`::
|
| 773 |
+
Ignore changes in amount of whitespace. This ignores whitespace
|
| 774 |
+
at line end, and considers all other sequences of one or
|
| 775 |
+
more whitespace characters to be equivalent.
|
| 776 |
+
|
| 777 |
+
`-w`::
|
| 778 |
+
`--ignore-all-space`::
|
| 779 |
+
Ignore whitespace when comparing lines. This ignores
|
| 780 |
+
differences even if one line has whitespace where the other
|
| 781 |
+
line has none.
|
| 782 |
+
|
| 783 |
+
`--ignore-blank-lines`::
|
| 784 |
+
Ignore changes whose lines are all blank.
|
| 785 |
+
|
| 786 |
+
|
| 787 |
+
`-I<regex>`::
|
| 788 |
+
`--ignore-matching-lines=<regex>`::
|
| 789 |
+
Ignore changes whose all lines match _<regex>_. This option may
|
| 790 |
+
be specified more than once.
|
| 791 |
+
|
| 792 |
+
`--inter-hunk-context=<number>`::
|
| 793 |
+
Show the context between diff hunks, up to the specified _<number>_
|
| 794 |
+
of lines, thereby fusing hunks that are close to each other.
|
| 795 |
+
Defaults to `diff.interHunkContext` or 0 if the config option
|
| 796 |
+
is unset.
|
| 797 |
+
|
| 798 |
+
`-W`::
|
| 799 |
+
`--function-context`::
|
| 800 |
+
Show whole function as context lines for each change.
|
| 801 |
+
The function names are determined in the same way as
|
| 802 |
+
`git diff` works out patch hunk headers (see "Defining a
|
| 803 |
+
custom hunk-header" in linkgit:gitattributes[5]).
|
| 804 |
+
|
| 805 |
+
ifndef::git-format-patch[]
|
| 806 |
+
ifndef::git-log[]
|
| 807 |
+
`--exit-code`::
|
| 808 |
+
Make the program exit with codes similar to `diff`(1).
|
| 809 |
+
That is, it exits with 1 if there were differences and
|
| 810 |
+
0 means no differences.
|
| 811 |
+
|
| 812 |
+
`--quiet`::
|
| 813 |
+
Disable all output of the program. Implies `--exit-code`.
|
| 814 |
+
Disables execution of external diff helpers whose exit code
|
| 815 |
+
is not trusted, i.e. their respective configuration option
|
| 816 |
+
`diff.trustExitCode` or ++diff.++__<driver>__++.trustExitCode++ or
|
| 817 |
+
environment variable `GIT_EXTERNAL_DIFF_TRUST_EXIT_CODE` is
|
| 818 |
+
false.
|
| 819 |
+
endif::git-log[]
|
| 820 |
+
endif::git-format-patch[]
|
| 821 |
+
|
| 822 |
+
`--ext-diff`::
|
| 823 |
+
Allow an external diff helper to be executed. If you set an
|
| 824 |
+
external diff driver with linkgit:gitattributes[5], you need
|
| 825 |
+
to use this option with linkgit:git-log[1] and friends.
|
| 826 |
+
|
| 827 |
+
`--no-ext-diff`::
|
| 828 |
+
Disallow external diff drivers.
|
| 829 |
+
|
| 830 |
+
`--textconv`::
|
| 831 |
+
`--no-textconv`::
|
| 832 |
+
Allow (or disallow) external text conversion filters to be run
|
| 833 |
+
when comparing binary files. See linkgit:gitattributes[5] for
|
| 834 |
+
details. Because textconv filters are typically a one-way
|
| 835 |
+
conversion, the resulting diff is suitable for human
|
| 836 |
+
consumption, but cannot be applied. For this reason, textconv
|
| 837 |
+
filters are enabled by default only for linkgit:git-diff[1] and
|
| 838 |
+
linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
|
| 839 |
+
diff plumbing commands.
|
| 840 |
+
|
| 841 |
+
|
| 842 |
+
`--ignore-submodules[=(none|untracked|dirty|all)]`::
|
| 843 |
+
Ignore changes to submodules in the diff generation. `all` is the default.
|
| 844 |
+
Using `none` will consider the submodule modified when it either contains
|
| 845 |
+
untracked or modified files or its `HEAD` differs from the commit recorded
|
| 846 |
+
in the superproject and can be used to override any settings of the
|
| 847 |
+
`ignore` option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
|
| 848 |
+
`untracked` is used submodules are not considered dirty when they only
|
| 849 |
+
contain untracked content (but they are still scanned for modified
|
| 850 |
+
content). Using `dirty` ignores all changes to the work tree of submodules,
|
| 851 |
+
only changes to the commits stored in the superproject are shown (this was
|
| 852 |
+
the behavior until 1.7.0). Using `all` hides all changes to submodules.
|
| 853 |
+
|
| 854 |
+
`--src-prefix=<prefix>`::
|
| 855 |
+
Show the given source _<prefix>_ instead of "a/".
|
| 856 |
+
|
| 857 |
+
`--dst-prefix=<prefix>`::
|
| 858 |
+
Show the given destination _<prefix>_ instead of "b/".
|
| 859 |
+
|
| 860 |
+
`--no-prefix`::
|
| 861 |
+
Do not show any source or destination prefix.
|
| 862 |
+
|
| 863 |
+
`--default-prefix`::
|
| 864 |
+
ifdef::git-format-patch[]
|
| 865 |
+
Use the default source and destination prefixes ("a/" and "b/").
|
| 866 |
+
This overrides configuration variables such as `format.noprefix`,
|
| 867 |
+
`diff.srcPrefix`, `diff.dstPrefix`, and `diff.mnemonicPrefix`
|
| 868 |
+
(see linkgit:git-config[1]).
|
| 869 |
+
endif::git-format-patch[]
|
| 870 |
+
ifndef::git-format-patch[]
|
| 871 |
+
Use the default source and destination prefixes ("a/" and "b/").
|
| 872 |
+
This overrides configuration variables such as `diff.noprefix`,
|
| 873 |
+
`diff.srcPrefix`, `diff.dstPrefix`, and `diff.mnemonicPrefix`
|
| 874 |
+
(see linkgit:git-config[1]).
|
| 875 |
+
endif::git-format-patch[]
|
| 876 |
+
|
| 877 |
+
`--line-prefix=<prefix>`::
|
| 878 |
+
Prepend an additional _<prefix>_ to every line of output.
|
| 879 |
+
|
| 880 |
+
`--ita-invisible-in-index`::
|
| 881 |
+
By default entries added by `git add -N` appear as an existing
|
| 882 |
+
empty file in `git diff` and a new file in `git diff --cached`.
|
| 883 |
+
This option makes the entry appear as a new file in `git diff`
|
| 884 |
+
and non-existent in `git diff --cached`. This option could be
|
| 885 |
+
reverted with `--ita-visible-in-index`. Both options are
|
| 886 |
+
experimental and could be removed in future.
|
| 887 |
+
|
| 888 |
+
--max-depth=<depth>::
|
| 889 |
+
For each pathspec given on command line, descend at most `<depth>`
|
| 890 |
+
levels of directories. A value of `-1` means no limit.
|
| 891 |
+
Cannot be combined with wildcards in the pathspec.
|
| 892 |
+
Given a tree containing `foo/bar/baz`, the following list shows the
|
| 893 |
+
matches generated by each set of options:
|
| 894 |
+
+
|
| 895 |
+
--
|
| 896 |
+
- `--max-depth=0 -- foo`: `foo`
|
| 897 |
+
|
| 898 |
+
- `--max-depth=1 -- foo`: `foo/bar`
|
| 899 |
+
|
| 900 |
+
- `--max-depth=1 -- foo/bar`: `foo/bar/baz`
|
| 901 |
+
|
| 902 |
+
- `--max-depth=1 -- foo foo/bar`: `foo/bar/baz`
|
| 903 |
+
|
| 904 |
+
- `--max-depth=2 -- foo`: `foo/bar/baz`
|
| 905 |
+
--
|
| 906 |
+
+
|
| 907 |
+
If no pathspec is given, the depth is measured as if all
|
| 908 |
+
top-level entries were specified. Note that this is different
|
| 909 |
+
than measuring from the root, in that `--max-depth=0` would
|
| 910 |
+
still return `foo`. This allows you to still limit depth while
|
| 911 |
+
asking for a subset of the top-level entries.
|
| 912 |
+
+
|
| 913 |
+
Note that this option is only supported for diffs between tree objects,
|
| 914 |
+
not against the index or working tree.
|
| 915 |
+
|
| 916 |
+
For more detailed explanation on these common options, see also
|
| 917 |
+
linkgit:gitdiffcore[7].
|
git/mingw64/share/doc/git-doc/docbook-xsl.css
ADDED
|
@@ -0,0 +1,296 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
/*
|
| 2 |
+
CSS stylesheet for XHTML produced by DocBook XSL stylesheets.
|
| 3 |
+
Tested with XSL stylesheets 1.61.2, 1.67.2
|
| 4 |
+
*/
|
| 5 |
+
|
| 6 |
+
span.strong {
|
| 7 |
+
font-weight: bold;
|
| 8 |
+
}
|
| 9 |
+
|
| 10 |
+
body blockquote {
|
| 11 |
+
margin-top: .75em;
|
| 12 |
+
line-height: 1.5;
|
| 13 |
+
margin-bottom: .75em;
|
| 14 |
+
}
|
| 15 |
+
|
| 16 |
+
html body {
|
| 17 |
+
margin: 1em 5% 1em 5%;
|
| 18 |
+
line-height: 1.2;
|
| 19 |
+
font-family: sans-serif;
|
| 20 |
+
}
|
| 21 |
+
|
| 22 |
+
body div {
|
| 23 |
+
margin: 0;
|
| 24 |
+
}
|
| 25 |
+
|
| 26 |
+
h1, h2, h3, h4, h5, h6,
|
| 27 |
+
div.toc p b,
|
| 28 |
+
div.list-of-figures p b,
|
| 29 |
+
div.list-of-tables p b,
|
| 30 |
+
div.abstract p.title
|
| 31 |
+
{
|
| 32 |
+
color: #527bbd;
|
| 33 |
+
font-family: tahoma, verdana, sans-serif;
|
| 34 |
+
}
|
| 35 |
+
|
| 36 |
+
div.toc p:first-child,
|
| 37 |
+
div.list-of-figures p:first-child,
|
| 38 |
+
div.list-of-tables p:first-child,
|
| 39 |
+
div.example p.title
|
| 40 |
+
{
|
| 41 |
+
margin-bottom: 0.2em;
|
| 42 |
+
}
|
| 43 |
+
|
| 44 |
+
body h1 {
|
| 45 |
+
margin: .0em 0 0 -4%;
|
| 46 |
+
line-height: 1.3;
|
| 47 |
+
border-bottom: 2px solid silver;
|
| 48 |
+
}
|
| 49 |
+
|
| 50 |
+
body h2 {
|
| 51 |
+
margin: 0.5em 0 0 -4%;
|
| 52 |
+
line-height: 1.3;
|
| 53 |
+
border-bottom: 2px solid silver;
|
| 54 |
+
}
|
| 55 |
+
|
| 56 |
+
body h3 {
|
| 57 |
+
margin: .8em 0 0 -3%;
|
| 58 |
+
line-height: 1.3;
|
| 59 |
+
}
|
| 60 |
+
|
| 61 |
+
body h4 {
|
| 62 |
+
margin: .8em 0 0 -3%;
|
| 63 |
+
line-height: 1.3;
|
| 64 |
+
}
|
| 65 |
+
|
| 66 |
+
body h5 {
|
| 67 |
+
margin: .8em 0 0 -2%;
|
| 68 |
+
line-height: 1.3;
|
| 69 |
+
}
|
| 70 |
+
|
| 71 |
+
body h6 {
|
| 72 |
+
margin: .8em 0 0 -1%;
|
| 73 |
+
line-height: 1.3;
|
| 74 |
+
}
|
| 75 |
+
|
| 76 |
+
body hr {
|
| 77 |
+
border: none; /* Broken on IE6 */
|
| 78 |
+
}
|
| 79 |
+
div.footnotes hr {
|
| 80 |
+
border: 1px solid silver;
|
| 81 |
+
}
|
| 82 |
+
|
| 83 |
+
div.navheader th, div.navheader td, div.navfooter td {
|
| 84 |
+
font-family: sans-serif;
|
| 85 |
+
font-size: 0.9em;
|
| 86 |
+
font-weight: bold;
|
| 87 |
+
color: #527bbd;
|
| 88 |
+
}
|
| 89 |
+
div.navheader img, div.navfooter img {
|
| 90 |
+
border-style: none;
|
| 91 |
+
}
|
| 92 |
+
div.navheader a, div.navfooter a {
|
| 93 |
+
font-weight: normal;
|
| 94 |
+
}
|
| 95 |
+
div.navfooter hr {
|
| 96 |
+
border: 1px solid silver;
|
| 97 |
+
}
|
| 98 |
+
|
| 99 |
+
body td {
|
| 100 |
+
line-height: 1.2
|
| 101 |
+
}
|
| 102 |
+
|
| 103 |
+
body th {
|
| 104 |
+
line-height: 1.2;
|
| 105 |
+
}
|
| 106 |
+
|
| 107 |
+
ol {
|
| 108 |
+
line-height: 1.2;
|
| 109 |
+
}
|
| 110 |
+
|
| 111 |
+
ul, body dir, body menu {
|
| 112 |
+
line-height: 1.2;
|
| 113 |
+
}
|
| 114 |
+
|
| 115 |
+
html {
|
| 116 |
+
margin: 0;
|
| 117 |
+
padding: 0;
|
| 118 |
+
}
|
| 119 |
+
|
| 120 |
+
body h1, body h2, body h3, body h4, body h5, body h6 {
|
| 121 |
+
margin-left: 0
|
| 122 |
+
}
|
| 123 |
+
|
| 124 |
+
body pre {
|
| 125 |
+
margin: 0.5em 10% 0.5em 1em;
|
| 126 |
+
line-height: 1.0;
|
| 127 |
+
color: navy;
|
| 128 |
+
}
|
| 129 |
+
|
| 130 |
+
tt.literal, code.literal {
|
| 131 |
+
color: navy;
|
| 132 |
+
font-family: sans-serif;
|
| 133 |
+
}
|
| 134 |
+
|
| 135 |
+
code.literal:before { content: "'"; }
|
| 136 |
+
code.literal:after { content: "'"; }
|
| 137 |
+
|
| 138 |
+
em {
|
| 139 |
+
font-style: italic;
|
| 140 |
+
color: #064;
|
| 141 |
+
}
|
| 142 |
+
|
| 143 |
+
div.literallayout p {
|
| 144 |
+
padding: 0em;
|
| 145 |
+
margin: 0em;
|
| 146 |
+
}
|
| 147 |
+
|
| 148 |
+
div.literallayout {
|
| 149 |
+
font-family: monospace;
|
| 150 |
+
margin: 0em;
|
| 151 |
+
color: navy;
|
| 152 |
+
border: 1px solid silver;
|
| 153 |
+
background: #f4f4f4;
|
| 154 |
+
padding: 0.5em;
|
| 155 |
+
}
|
| 156 |
+
|
| 157 |
+
.programlisting, .screen {
|
| 158 |
+
border: 1px solid silver;
|
| 159 |
+
background: #f4f4f4;
|
| 160 |
+
margin: 0.5em 10% 0.5em 0;
|
| 161 |
+
padding: 0.5em 1em;
|
| 162 |
+
}
|
| 163 |
+
|
| 164 |
+
div.sidebar {
|
| 165 |
+
background: #ffffee;
|
| 166 |
+
margin: 1.0em 10% 0.5em 0;
|
| 167 |
+
padding: 0.5em 1em;
|
| 168 |
+
border: 1px solid silver;
|
| 169 |
+
}
|
| 170 |
+
div.sidebar * { padding: 0; }
|
| 171 |
+
div.sidebar div { margin: 0; }
|
| 172 |
+
div.sidebar p.title {
|
| 173 |
+
font-family: sans-serif;
|
| 174 |
+
margin-top: 0.5em;
|
| 175 |
+
margin-bottom: 0.2em;
|
| 176 |
+
}
|
| 177 |
+
|
| 178 |
+
div.bibliomixed {
|
| 179 |
+
margin: 0.5em 5% 0.5em 1em;
|
| 180 |
+
}
|
| 181 |
+
|
| 182 |
+
div.glossary dt {
|
| 183 |
+
font-weight: bold;
|
| 184 |
+
}
|
| 185 |
+
div.glossary dd p {
|
| 186 |
+
margin-top: 0.2em;
|
| 187 |
+
}
|
| 188 |
+
|
| 189 |
+
dl {
|
| 190 |
+
margin: .8em 0;
|
| 191 |
+
line-height: 1.2;
|
| 192 |
+
}
|
| 193 |
+
|
| 194 |
+
dt {
|
| 195 |
+
margin-top: 0.5em;
|
| 196 |
+
}
|
| 197 |
+
|
| 198 |
+
dt span.term {
|
| 199 |
+
font-style: normal;
|
| 200 |
+
color: navy;
|
| 201 |
+
}
|
| 202 |
+
|
| 203 |
+
div.variablelist dd p {
|
| 204 |
+
margin-top: 0;
|
| 205 |
+
}
|
| 206 |
+
|
| 207 |
+
div.itemizedlist li, div.orderedlist li {
|
| 208 |
+
margin-left: -0.8em;
|
| 209 |
+
margin-top: 0.5em;
|
| 210 |
+
}
|
| 211 |
+
|
| 212 |
+
ul, ol {
|
| 213 |
+
list-style-position: outside;
|
| 214 |
+
}
|
| 215 |
+
|
| 216 |
+
div.sidebar ul, div.sidebar ol {
|
| 217 |
+
margin-left: 2.8em;
|
| 218 |
+
}
|
| 219 |
+
|
| 220 |
+
div.itemizedlist p.title,
|
| 221 |
+
div.orderedlist p.title,
|
| 222 |
+
div.variablelist p.title
|
| 223 |
+
{
|
| 224 |
+
margin-bottom: -0.8em;
|
| 225 |
+
}
|
| 226 |
+
|
| 227 |
+
div.revhistory table {
|
| 228 |
+
border-collapse: collapse;
|
| 229 |
+
border: none;
|
| 230 |
+
}
|
| 231 |
+
div.revhistory th {
|
| 232 |
+
border: none;
|
| 233 |
+
color: #527bbd;
|
| 234 |
+
font-family: tahoma, verdana, sans-serif;
|
| 235 |
+
}
|
| 236 |
+
div.revhistory td {
|
| 237 |
+
border: 1px solid silver;
|
| 238 |
+
}
|
| 239 |
+
|
| 240 |
+
/* Keep TOC and index lines close together. */
|
| 241 |
+
div.toc dl, div.toc dt,
|
| 242 |
+
div.list-of-figures dl, div.list-of-figures dt,
|
| 243 |
+
div.list-of-tables dl, div.list-of-tables dt,
|
| 244 |
+
div.indexdiv dl, div.indexdiv dt
|
| 245 |
+
{
|
| 246 |
+
line-height: normal;
|
| 247 |
+
margin-top: 0;
|
| 248 |
+
margin-bottom: 0;
|
| 249 |
+
}
|
| 250 |
+
|
| 251 |
+
/*
|
| 252 |
+
Table styling does not work because of overriding attributes in
|
| 253 |
+
generated HTML.
|
| 254 |
+
*/
|
| 255 |
+
div.table table,
|
| 256 |
+
div.informaltable table
|
| 257 |
+
{
|
| 258 |
+
margin-left: 0;
|
| 259 |
+
margin-right: 5%;
|
| 260 |
+
margin-bottom: 0.8em;
|
| 261 |
+
}
|
| 262 |
+
div.informaltable table
|
| 263 |
+
{
|
| 264 |
+
margin-top: 0.4em
|
| 265 |
+
}
|
| 266 |
+
div.table thead,
|
| 267 |
+
div.table tfoot,
|
| 268 |
+
div.table tbody,
|
| 269 |
+
div.informaltable thead,
|
| 270 |
+
div.informaltable tfoot,
|
| 271 |
+
div.informaltable tbody
|
| 272 |
+
{
|
| 273 |
+
/* No effect in IE6. */
|
| 274 |
+
border-top: 2px solid #527bbd;
|
| 275 |
+
border-bottom: 2px solid #527bbd;
|
| 276 |
+
}
|
| 277 |
+
div.table thead, div.table tfoot,
|
| 278 |
+
div.informaltable thead, div.informaltable tfoot
|
| 279 |
+
{
|
| 280 |
+
font-weight: bold;
|
| 281 |
+
}
|
| 282 |
+
|
| 283 |
+
div.mediaobject img {
|
| 284 |
+
border: 1px solid silver;
|
| 285 |
+
margin-bottom: 0.8em;
|
| 286 |
+
}
|
| 287 |
+
div.figure p.title,
|
| 288 |
+
div.table p.title
|
| 289 |
+
{
|
| 290 |
+
margin-top: 1em;
|
| 291 |
+
margin-bottom: 0.4em;
|
| 292 |
+
}
|
| 293 |
+
|
| 294 |
+
@media print {
|
| 295 |
+
div.navheader, div.navfooter { display: none; }
|
| 296 |
+
}
|
git/mingw64/share/doc/git-doc/docinfo.html
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<style>
|
| 2 |
+
pre>code {
|
| 3 |
+
display: inline;
|
| 4 |
+
}
|
| 5 |
+
</style>
|
git/mingw64/share/doc/git-doc/everyday.html
ADDED
|
@@ -0,0 +1,464 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>Everyday Git With 20 Commands Or So</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="article">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>Everyday Git With 20 Commands Or So</h1>
|
| 445 |
+
</div>
|
| 446 |
+
<div id="content">
|
| 447 |
+
<div class="paragraph">
|
| 448 |
+
<p>This document has been moved to <a href="giteveryday.html">giteveryday(7)</a>.</p>
|
| 449 |
+
</div>
|
| 450 |
+
<div class="paragraph">
|
| 451 |
+
<p>Please let the owners of the referring site know so that they can update the
|
| 452 |
+
link you clicked to get here.</p>
|
| 453 |
+
</div>
|
| 454 |
+
<div class="paragraph">
|
| 455 |
+
<p>Thanks.</p>
|
| 456 |
+
</div>
|
| 457 |
+
</div>
|
| 458 |
+
<div id="footer">
|
| 459 |
+
<div id="footer-text">
|
| 460 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 461 |
+
</div>
|
| 462 |
+
</div>
|
| 463 |
+
</body>
|
| 464 |
+
</html>
|
git/mingw64/share/doc/git-doc/fetch-options.adoc
ADDED
|
@@ -0,0 +1,358 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
`--all`::
|
| 2 |
+
`--no-all`::
|
| 3 |
+
Fetch all remotes, except for the ones that has the
|
| 4 |
+
`remote.<name>.skipFetchAll` configuration variable set.
|
| 5 |
+
This overrides the configuration variable `fetch.all`.
|
| 6 |
+
|
| 7 |
+
`-a`::
|
| 8 |
+
`--append`::
|
| 9 |
+
Append ref names and object names of fetched refs to the
|
| 10 |
+
existing contents of `.git/FETCH_HEAD`. Without this
|
| 11 |
+
option old data in `.git/FETCH_HEAD` will be overwritten.
|
| 12 |
+
|
| 13 |
+
`--atomic`::
|
| 14 |
+
Use an atomic transaction to update local refs. Either all refs are
|
| 15 |
+
updated, or on error, no refs are updated.
|
| 16 |
+
|
| 17 |
+
`--depth=<depth>`::
|
| 18 |
+
Limit fetching to the specified number of commits from the tip of
|
| 19 |
+
each remote branch history. If fetching to a 'shallow' repository
|
| 20 |
+
created by `git clone` with `--depth=<depth>` option (see
|
| 21 |
+
linkgit:git-clone[1]), deepen or shorten the history to the specified
|
| 22 |
+
number of commits. Tags for the deepened commits are not fetched.
|
| 23 |
+
|
| 24 |
+
`--deepen=<depth>`::
|
| 25 |
+
Similar to `--depth`, except it specifies the number of commits
|
| 26 |
+
from the current shallow boundary instead of from the tip of
|
| 27 |
+
each remote branch history.
|
| 28 |
+
|
| 29 |
+
`--shallow-since=<date>`::
|
| 30 |
+
Deepen or shorten the history of a shallow repository to
|
| 31 |
+
include all reachable commits after _<date>_.
|
| 32 |
+
|
| 33 |
+
`--shallow-exclude=<ref>`::
|
| 34 |
+
Deepen or shorten the history of a shallow repository to
|
| 35 |
+
exclude commits reachable from a specified remote branch or tag.
|
| 36 |
+
This option can be specified multiple times.
|
| 37 |
+
|
| 38 |
+
`--unshallow`::
|
| 39 |
+
If the source repository is complete, convert a shallow
|
| 40 |
+
repository to a complete one, removing all the limitations
|
| 41 |
+
imposed by shallow repositories.
|
| 42 |
+
+
|
| 43 |
+
If the source repository is shallow, fetch as much as possible so that
|
| 44 |
+
the current repository has the same history as the source repository.
|
| 45 |
+
|
| 46 |
+
`--update-shallow`::
|
| 47 |
+
By default when fetching from a shallow repository,
|
| 48 |
+
`git fetch` refuses refs that require updating
|
| 49 |
+
`.git/shallow`. This option updates `.git/shallow` and accepts such
|
| 50 |
+
refs.
|
| 51 |
+
|
| 52 |
+
`--negotiation-tip=(<commit>|<glob>)`::
|
| 53 |
+
By default, Git will report, to the server, commits reachable
|
| 54 |
+
from all local refs to find common commits in an attempt to
|
| 55 |
+
reduce the size of the to-be-received packfile. If specified,
|
| 56 |
+
Git will only report commits reachable from the given tips.
|
| 57 |
+
This is useful to speed up fetches when the user knows which
|
| 58 |
+
local ref is likely to have commits in common with the
|
| 59 |
+
upstream ref being fetched.
|
| 60 |
+
+
|
| 61 |
+
This option may be specified more than once; if so, Git will report
|
| 62 |
+
commits reachable from any of the given commits.
|
| 63 |
+
+
|
| 64 |
+
The argument to this option may be a glob on ref names, a ref, or the (possibly
|
| 65 |
+
abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying
|
| 66 |
+
this option multiple times, one for each matching ref name.
|
| 67 |
+
+
|
| 68 |
+
See also the `fetch.negotiationAlgorithm` and `push.negotiate`
|
| 69 |
+
configuration variables documented in linkgit:git-config[1], and the
|
| 70 |
+
`--negotiate-only` option below.
|
| 71 |
+
|
| 72 |
+
`--negotiate-only`::
|
| 73 |
+
Do not fetch anything from the server, and instead print the
|
| 74 |
+
ancestors of the provided `--negotiation-tip=` arguments,
|
| 75 |
+
which we have in common with the server.
|
| 76 |
+
+
|
| 77 |
+
This is incompatible with `--recurse-submodules=(yes|on-demand)`.
|
| 78 |
+
Internally this is used to implement the `push.negotiate` option, see
|
| 79 |
+
linkgit:git-config[1].
|
| 80 |
+
|
| 81 |
+
`--dry-run`::
|
| 82 |
+
Show what would be done, without making any changes.
|
| 83 |
+
|
| 84 |
+
`--porcelain`::
|
| 85 |
+
Print the output to standard output in an easy-to-parse format for
|
| 86 |
+
scripts. See section OUTPUT in linkgit:git-fetch[1] for details.
|
| 87 |
+
+
|
| 88 |
+
This is incompatible with `--recurse-submodules=(yes|on-demand)` and takes
|
| 89 |
+
precedence over the `fetch.output` config option.
|
| 90 |
+
|
| 91 |
+
`--filter=<filter-spec>`::
|
| 92 |
+
Use the partial clone feature and request that the server sends
|
| 93 |
+
a subset of reachable objects according to a given object filter.
|
| 94 |
+
When using `--filter`, the supplied _<filter-spec>_ is used for
|
| 95 |
+
the partial fetch.
|
| 96 |
+
+
|
| 97 |
+
If `--filter=auto` is used, the filter specification is determined
|
| 98 |
+
automatically by combining the filter specifications advertised by
|
| 99 |
+
the server for the promisor remotes that the client accepts (see
|
| 100 |
+
linkgit:gitprotocol-v2[5] and the `promisor.acceptFromServer`
|
| 101 |
+
configuration option in linkgit:git-config[1]).
|
| 102 |
+
+
|
| 103 |
+
For details on all other available filter specifications, see the
|
| 104 |
+
`--filter=<filter-spec>` option in linkgit:git-rev-list[1].
|
| 105 |
+
+
|
| 106 |
+
For example, `--filter=blob:none` will filter out all blobs (file
|
| 107 |
+
contents) until needed by Git. Also, `--filter=blob:limit=<size>` will
|
| 108 |
+
filter out all blobs of size at least _<size>_.
|
| 109 |
+
|
| 110 |
+
ifndef::git-pull[]
|
| 111 |
+
`--write-fetch-head`::
|
| 112 |
+
`--no-write-fetch-head`::
|
| 113 |
+
Write the list of remote refs fetched in the `FETCH_HEAD`
|
| 114 |
+
file directly under `$GIT_DIR`. This is the default.
|
| 115 |
+
Passing `--no-write-fetch-head` from the command line tells
|
| 116 |
+
Git not to write the file. Under `--dry-run` option, the
|
| 117 |
+
file is never written.
|
| 118 |
+
endif::git-pull[]
|
| 119 |
+
|
| 120 |
+
`-f`::
|
| 121 |
+
`--force`::
|
| 122 |
+
ifdef::git-pull[]
|
| 123 |
+
When `git fetch` is used with `<src>:<dst>` refspec, it may
|
| 124 |
+
refuse to update the local branch as discussed
|
| 125 |
+
in the _<refspec>_ part of the linkgit:git-fetch[1]
|
| 126 |
+
documentation.
|
| 127 |
+
endif::git-pull[]
|
| 128 |
+
ifndef::git-pull[]
|
| 129 |
+
When `git fetch` is used with `<src>:<dst>` refspec, it may
|
| 130 |
+
refuse to update the local branch as discussed in the _<refspec>_ part below.
|
| 131 |
+
endif::git-pull[]
|
| 132 |
+
This option overrides that check.
|
| 133 |
+
|
| 134 |
+
`-k`::
|
| 135 |
+
`--keep`::
|
| 136 |
+
Keep downloaded pack.
|
| 137 |
+
|
| 138 |
+
ifndef::git-pull[]
|
| 139 |
+
`--multiple`::
|
| 140 |
+
Allow several _<repository>_ and _<group>_ arguments to be
|
| 141 |
+
specified. No __<refspec>__s may be specified.
|
| 142 |
+
|
| 143 |
+
`--auto-maintenance`::
|
| 144 |
+
`--no-auto-maintenance`::
|
| 145 |
+
`--auto-gc`::
|
| 146 |
+
`--no-auto-gc`::
|
| 147 |
+
Run `git maintenance run --auto` at the end to perform automatic
|
| 148 |
+
repository maintenance if needed.
|
| 149 |
+
This is enabled by default.
|
| 150 |
+
|
| 151 |
+
`--write-commit-graph`::
|
| 152 |
+
`--no-write-commit-graph`::
|
| 153 |
+
Write a commit-graph after fetching. This overrides the config
|
| 154 |
+
setting `fetch.writeCommitGraph`.
|
| 155 |
+
endif::git-pull[]
|
| 156 |
+
|
| 157 |
+
`--prefetch`::
|
| 158 |
+
Modify the configured refspec to place all refs into the
|
| 159 |
+
`refs/prefetch/` namespace. See the `prefetch` task in
|
| 160 |
+
linkgit:git-maintenance[1].
|
| 161 |
+
|
| 162 |
+
`-p`::
|
| 163 |
+
`--prune`::
|
| 164 |
+
Before fetching, remove any remote-tracking references that no
|
| 165 |
+
longer exist on the remote. Tags are not subject to pruning
|
| 166 |
+
if they are fetched only because of the default tag
|
| 167 |
+
auto-following or due to a `--tags` option. However, if tags
|
| 168 |
+
are fetched due to an explicit refspec (either on the command
|
| 169 |
+
line or in the remote configuration, for example if the remote
|
| 170 |
+
was cloned with the `--mirror` option), then they are also
|
| 171 |
+
subject to pruning. Supplying `--prune-tags` is a shorthand for
|
| 172 |
+
providing the tag refspec.
|
| 173 |
+
ifndef::git-pull[]
|
| 174 |
+
+
|
| 175 |
+
See the PRUNING section below for more details.
|
| 176 |
+
|
| 177 |
+
`-P`::
|
| 178 |
+
`--prune-tags`::
|
| 179 |
+
Before fetching, remove any local tags that no longer exist on
|
| 180 |
+
the remote if `--prune` is enabled. This option should be used
|
| 181 |
+
more carefully, unlike `--prune` it will remove any local
|
| 182 |
+
references (local tags) that have been created. This option is
|
| 183 |
+
a shorthand for providing the explicit tag refspec along with
|
| 184 |
+
`--prune`, see the discussion about that in its documentation.
|
| 185 |
+
+
|
| 186 |
+
See the PRUNING section below for more details.
|
| 187 |
+
|
| 188 |
+
endif::git-pull[]
|
| 189 |
+
|
| 190 |
+
ifndef::git-pull[]
|
| 191 |
+
`-n`::
|
| 192 |
+
endif::git-pull[]
|
| 193 |
+
`--no-tags`::
|
| 194 |
+
By default, tags that point at objects that are downloaded
|
| 195 |
+
from the remote repository are fetched and stored locally.
|
| 196 |
+
This option disables this automatic tag following. The default
|
| 197 |
+
behavior for a remote may be specified with the `remote.<name>.tagOpt`
|
| 198 |
+
setting. See linkgit:git-config[1].
|
| 199 |
+
|
| 200 |
+
ifndef::git-pull[]
|
| 201 |
+
`--refetch`::
|
| 202 |
+
Instead of negotiating with the server to avoid transferring commits and
|
| 203 |
+
associated objects that are already present locally, this option fetches
|
| 204 |
+
all objects as a fresh clone would. Use this to reapply a partial clone
|
| 205 |
+
filter from configuration or using `--filter=` when the filter
|
| 206 |
+
definition has changed. Automatic post-fetch maintenance will perform
|
| 207 |
+
object database pack consolidation to remove any duplicate objects.
|
| 208 |
+
endif::git-pull[]
|
| 209 |
+
|
| 210 |
+
`--refmap=<refspec>`::
|
| 211 |
+
When fetching refs listed on the command line, use the
|
| 212 |
+
specified refspec (can be given more than once) to map the
|
| 213 |
+
refs to remote-tracking branches, instead of the values of
|
| 214 |
+
`remote.<name>.fetch` configuration variables for the remote
|
| 215 |
+
repository. Providing an empty _<refspec>_ to the
|
| 216 |
+
`--refmap` option causes Git to ignore the configured
|
| 217 |
+
refspecs and rely entirely on the refspecs supplied as
|
| 218 |
+
command-line arguments. See section on "Configured Remote-tracking
|
| 219 |
+
Branches" for details.
|
| 220 |
+
|
| 221 |
+
`-t`::
|
| 222 |
+
`--tags`::
|
| 223 |
+
Fetch all tags from the remote (i.e., fetch remote tags
|
| 224 |
+
`refs/tags/*` into local tags with the same name), in addition
|
| 225 |
+
to whatever else would otherwise be fetched. Using this
|
| 226 |
+
option alone does not subject tags to pruning, even if `--prune`
|
| 227 |
+
is used (though tags may be pruned anyway if they are also the
|
| 228 |
+
destination of an explicit refspec; see `--prune`).
|
| 229 |
+
|
| 230 |
+
ifndef::git-pull[]
|
| 231 |
+
`--recurse-submodules[=(yes|on-demand|no)]`::
|
| 232 |
+
Control if and under what conditions new commits of
|
| 233 |
+
submodules should be fetched too. When recursing through submodules,
|
| 234 |
+
`git fetch` always attempts to fetch "changed" submodules, that is, a
|
| 235 |
+
submodule that has commits that are referenced by a newly fetched
|
| 236 |
+
superproject commit but are missing in the local submodule clone. A
|
| 237 |
+
changed submodule can be fetched as long as it is present locally e.g.
|
| 238 |
+
in `$GIT_DIR/modules/` (see linkgit:gitsubmodules[7]); if the upstream
|
| 239 |
+
adds a new submodule, that submodule cannot be fetched until it is
|
| 240 |
+
cloned e.g. by `git submodule update`.
|
| 241 |
+
+
|
| 242 |
+
When set to `on-demand`, only changed submodules are fetched. When set
|
| 243 |
+
to `yes`, all populated submodules are fetched and submodules that are
|
| 244 |
+
both unpopulated and changed are fetched. When set to `no`, submodules
|
| 245 |
+
are never fetched.
|
| 246 |
+
+
|
| 247 |
+
When unspecified, this uses the value of `fetch.recurseSubmodules` if it
|
| 248 |
+
is set (see linkgit:git-config[1]), defaulting to `on-demand` if unset.
|
| 249 |
+
When this option is used without any value, it defaults to `yes`.
|
| 250 |
+
endif::git-pull[]
|
| 251 |
+
|
| 252 |
+
`-j <n>`::
|
| 253 |
+
`--jobs=<n>`::
|
| 254 |
+
Parallelize all forms of fetching up to _<n>_ jobs at a time.
|
| 255 |
+
+
|
| 256 |
+
A value of 0 will use some reasonable default.
|
| 257 |
+
+
|
| 258 |
+
If the `--multiple` option was specified, the different remotes will be fetched
|
| 259 |
+
in parallel. If multiple submodules are fetched, they will be fetched in
|
| 260 |
+
parallel. To control them independently, use the config settings
|
| 261 |
+
`fetch.parallel` and `submodule.fetchJobs` (see linkgit:git-config[1]).
|
| 262 |
+
+
|
| 263 |
+
Typically, parallel recursive and multi-remote fetches will be faster. By
|
| 264 |
+
default fetches are performed sequentially, not in parallel.
|
| 265 |
+
|
| 266 |
+
ifndef::git-pull[]
|
| 267 |
+
`--no-recurse-submodules`::
|
| 268 |
+
Disable recursive fetching of submodules (this has the same effect as
|
| 269 |
+
using the `--recurse-submodules=no` option).
|
| 270 |
+
endif::git-pull[]
|
| 271 |
+
|
| 272 |
+
`--set-upstream`::
|
| 273 |
+
If the remote is fetched successfully, add upstream
|
| 274 |
+
(tracking) reference, used by argument-less
|
| 275 |
+
linkgit:git-pull[1] and other commands. For more information,
|
| 276 |
+
see `branch.<name>.merge` and `branch.<name>.remote` in
|
| 277 |
+
linkgit:git-config[1].
|
| 278 |
+
|
| 279 |
+
ifndef::git-pull[]
|
| 280 |
+
`--submodule-prefix=<path>`::
|
| 281 |
+
Prepend _<path>_ to paths printed in informative messages
|
| 282 |
+
such as "Fetching submodule foo". This option is used
|
| 283 |
+
internally when recursing over submodules.
|
| 284 |
+
|
| 285 |
+
`--recurse-submodules-default=(yes|on-demand)`::
|
| 286 |
+
This option is used internally to temporarily provide a
|
| 287 |
+
non-negative default value for the `--recurse-submodules`
|
| 288 |
+
option. All other methods of configuring fetch's submodule
|
| 289 |
+
recursion (such as settings in linkgit:gitmodules[5] and
|
| 290 |
+
linkgit:git-config[1]) override this option, as does
|
| 291 |
+
specifying `--[no-]recurse-submodules` directly.
|
| 292 |
+
|
| 293 |
+
`-u`::
|
| 294 |
+
`--update-head-ok`::
|
| 295 |
+
By default `git fetch` refuses to update the head which
|
| 296 |
+
corresponds to the current branch. This flag disables the
|
| 297 |
+
check. This is purely for the internal use for `git pull`
|
| 298 |
+
to communicate with `git fetch`, and unless you are
|
| 299 |
+
implementing your own Porcelain you are not supposed to
|
| 300 |
+
use it.
|
| 301 |
+
endif::git-pull[]
|
| 302 |
+
|
| 303 |
+
`--upload-pack <upload-pack>`::
|
| 304 |
+
When given, and the repository to fetch from is handled
|
| 305 |
+
by `git fetch-pack`, `--exec=<upload-pack>` is passed to
|
| 306 |
+
the command to specify non-default path for the command
|
| 307 |
+
run on the other end.
|
| 308 |
+
|
| 309 |
+
ifndef::git-pull[]
|
| 310 |
+
`-q`::
|
| 311 |
+
`--quiet`::
|
| 312 |
+
Pass `--quiet` to `git-fetch-pack` and silence any other internally
|
| 313 |
+
used git commands. Progress is not reported to the standard error
|
| 314 |
+
stream.
|
| 315 |
+
|
| 316 |
+
`-v`::
|
| 317 |
+
`--verbose`::
|
| 318 |
+
Be verbose.
|
| 319 |
+
endif::git-pull[]
|
| 320 |
+
|
| 321 |
+
`--progress`::
|
| 322 |
+
Progress status is reported on the standard error stream
|
| 323 |
+
by default when it is attached to a terminal, unless `-q`
|
| 324 |
+
is specified. This flag forces progress status even if the
|
| 325 |
+
standard error stream is not directed to a terminal.
|
| 326 |
+
|
| 327 |
+
`-o <option>`::
|
| 328 |
+
`--server-option=<option>`::
|
| 329 |
+
Transmit the given string to the server when communicating using
|
| 330 |
+
protocol version 2. The given string must not contain a _NUL_ or _LF_
|
| 331 |
+
character. The server's handling of server options, including
|
| 332 |
+
unknown ones, is server-specific.
|
| 333 |
+
When multiple `--server-option=<option>` are given, they are all
|
| 334 |
+
sent to the other side in the order listed on the command line.
|
| 335 |
+
When no `--server-option=<option>` is given from the command line,
|
| 336 |
+
the values of configuration variable `remote.<name>.serverOption`
|
| 337 |
+
are used instead.
|
| 338 |
+
|
| 339 |
+
`--show-forced-updates`::
|
| 340 |
+
By default, git checks if a branch is force-updated during
|
| 341 |
+
fetch. This can be disabled through `fetch.showForcedUpdates`, but
|
| 342 |
+
the `--show-forced-updates` option guarantees this check occurs.
|
| 343 |
+
See linkgit:git-config[1].
|
| 344 |
+
|
| 345 |
+
`--no-show-forced-updates`::
|
| 346 |
+
By default, git checks if a branch is force-updated during
|
| 347 |
+
fetch. Pass `--no-show-forced-updates` or set `fetch.showForcedUpdates`
|
| 348 |
+
to false to skip this check for performance reasons. If used during
|
| 349 |
+
`git-pull` the `--ff-only` option will still check for forced updates
|
| 350 |
+
before attempting a fast-forward update. See linkgit:git-config[1].
|
| 351 |
+
|
| 352 |
+
`-4`::
|
| 353 |
+
`--ipv4`::
|
| 354 |
+
Use IPv4 addresses only, ignoring IPv6 addresses.
|
| 355 |
+
|
| 356 |
+
`-6`::
|
| 357 |
+
`--ipv6`::
|
| 358 |
+
Use IPv6 addresses only, ignoring IPv4 addresses.
|
git/mingw64/share/doc/git-doc/for-each-ref-options.adoc
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
`<pattern>...`::
|
| 2 |
+
If one or more _<pattern>_ parameters are given, only refs are shown that
|
| 3 |
+
match against at least one pattern, either using `fnmatch`(3) or
|
| 4 |
+
literally, in the latter case matching completely or from the
|
| 5 |
+
beginning up to a slash.
|
| 6 |
+
|
| 7 |
+
`--stdin`::
|
| 8 |
+
The list of patterns is read from standard input instead of from
|
| 9 |
+
the argument list.
|
| 10 |
+
|
| 11 |
+
`--count=<count>`::
|
| 12 |
+
Stop after showing _<count>_ refs.
|
| 13 |
+
|
| 14 |
+
`--sort=<key>`::
|
| 15 |
+
Sort on the field name _<key>_. Prefix `-` to sort in
|
| 16 |
+
descending order of the value. When unspecified,
|
| 17 |
+
`refname` is used. You may use the `--sort=<key>` option
|
| 18 |
+
multiple times, in which case the last key becomes the primary
|
| 19 |
+
key.
|
| 20 |
+
|
| 21 |
+
`--format[=<format>]`::
|
| 22 |
+
A string that interpolates `%(fieldname)` from a ref being shown and
|
| 23 |
+
the object it points at. In addition, the string literal `%%`
|
| 24 |
+
renders as `%` and `%xx` - where `xx` are hex digits - renders as
|
| 25 |
+
the character with hex code `xx`. For example, `%00` interpolates to
|
| 26 |
+
`\0` (_NUL_), `%09` to `\t` (_TAB_), and `%0a` to `\n` (_LF_).
|
| 27 |
+
|
| 28 |
+
When unspecified, _<format>_ defaults to `%(objectname) SPC %(objecttype)
|
| 29 |
+
TAB %(refname)`.
|
| 30 |
+
|
| 31 |
+
`--color[=<when>]`::
|
| 32 |
+
Respect any colors specified in the `--format` option. The
|
| 33 |
+
_<when>_ field must be one of `always`, `never`, or `auto` (if
|
| 34 |
+
_<when>_ is absent, behave as if `always` was given).
|
| 35 |
+
|
| 36 |
+
`--shell`::
|
| 37 |
+
`--perl`::
|
| 38 |
+
`--python`::
|
| 39 |
+
`--tcl`::
|
| 40 |
+
If given, strings that substitute `%(fieldname)`
|
| 41 |
+
placeholders are quoted as string literals suitable for
|
| 42 |
+
the specified host language. This is meant to produce
|
| 43 |
+
a scriptlet that can directly be "eval"ed.
|
| 44 |
+
|
| 45 |
+
`--points-at=<object>`::
|
| 46 |
+
Only list refs which points at the given object.
|
| 47 |
+
|
| 48 |
+
`--merged[=<object>]`::
|
| 49 |
+
Only list refs whose tips are reachable from the
|
| 50 |
+
specified commit (`HEAD` if not specified).
|
| 51 |
+
|
| 52 |
+
`--no-merged[=<object>]`::
|
| 53 |
+
Only list refs whose tips are not reachable from _<object>_(`HEAD` if not
|
| 54 |
+
specified).
|
| 55 |
+
|
| 56 |
+
`--contains[=<object>]`::
|
| 57 |
+
Only list refs which contain _<object>_(`HEAD` if not specified).
|
| 58 |
+
|
| 59 |
+
`--no-contains[=<object>]`::
|
| 60 |
+
Only list refs which don't contain _<object>_ (`HEAD`
|
| 61 |
+
if not specified).
|
| 62 |
+
|
| 63 |
+
`--ignore-case`::
|
| 64 |
+
Sorting and filtering refs are case insensitive.
|
| 65 |
+
|
| 66 |
+
`--omit-empty`::
|
| 67 |
+
Do not print a newline after formatted refs where the format expands
|
| 68 |
+
to the empty string.
|
| 69 |
+
|
| 70 |
+
`--exclude=<excluded-pattern>`::
|
| 71 |
+
If one or more `--exclude` options are given, only refs which do not
|
| 72 |
+
match any _<excluded-pattern>_ parameters are shown. Matching is done
|
| 73 |
+
using the same rules as _<pattern>_ above.
|
| 74 |
+
|
| 75 |
+
`--include-root-refs`::
|
| 76 |
+
List root refs (`HEAD` and pseudorefs) apart from regular refs.
|
| 77 |
+
|
| 78 |
+
`--start-after=<marker>`::
|
| 79 |
+
Allows paginating the output by skipping references up to and including the
|
| 80 |
+
specified marker. When paging, it should be noted that references may be
|
| 81 |
+
deleted, modified or added between invocations. Output will only yield those
|
| 82 |
+
references which follow the marker lexicographically. Output begins from the
|
| 83 |
+
first reference that would come after the marker alphabetically. Cannot be
|
| 84 |
+
used with `--sort=<key>` or `--stdin` options, or the _<pattern>_ argument(s)
|
| 85 |
+
to limit the refs.
|
git/mingw64/share/doc/git-doc/format-patch-caveats.adoc
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
The output from linkgit:git-format-patch[1] can lead to a different
|
| 2 |
+
commit message when applied with linkgit:git-am[1]. The patch that is
|
| 3 |
+
applied may also be different from the one that was generated, or patch
|
| 4 |
+
application may fail outright.
|
| 5 |
+
ifdef::git-am[]
|
| 6 |
+
See the <<discussion,DISCUSSION>> section above for the syntactic rules.
|
| 7 |
+
endif::git-am[]
|
| 8 |
+
|
| 9 |
+
ifndef::git-am[]
|
| 10 |
+
include::format-patch-end-of-commit-message.adoc[]
|
| 11 |
+
endif::git-am[]
|
| 12 |
+
|
| 13 |
+
Note that this is especially problematic for unindented diffs that occur
|
| 14 |
+
in the commit message; the diff in the commit message might get applied
|
| 15 |
+
along with the patch section, or the patch application machinery might
|
| 16 |
+
trip up because the patch target doesn't apply. This could for example
|
| 17 |
+
be caused by a diff in a Markdown code block.
|
| 18 |
+
|
| 19 |
+
The solution for this is to indent the diff or other text that could
|
| 20 |
+
cause problems.
|
| 21 |
+
|
| 22 |
+
This loss of fidelity might be simple to notice if you are applying
|
| 23 |
+
patches directly from a mailbox. However, changes originating from Git
|
| 24 |
+
could be applied in bulk, in which case this would be much harder to
|
| 25 |
+
notice. This could for example be a Linux distribution which uses patch
|
| 26 |
+
files to apply changes on top of the commits from the upstream
|
| 27 |
+
repositories. This goes to show that this behavior does not only impact
|
| 28 |
+
email workflows.
|
| 29 |
+
|
| 30 |
+
Given these limitations, one might be tempted to use a general-purpose
|
| 31 |
+
utility like patch(1) instead. However, patch(1) will not only look for
|
| 32 |
+
unindented diffs (like linkgit:git-am[1]) but will try to apply indented
|
| 33 |
+
diffs as well.
|
git/mingw64/share/doc/git-doc/format-patch-end-of-commit-message.adoc
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Any line that is of the form:
|
| 2 |
+
|
| 3 |
+
* three-dashes and end-of-line, or
|
| 4 |
+
* a line that begins with "diff -", or
|
| 5 |
+
* a line that begins with "Index: "
|
| 6 |
+
|
| 7 |
+
is taken as the beginning of a patch, and the commit log message
|
| 8 |
+
is terminated before the first occurrence of such a line.
|
git/mingw64/share/doc/git-doc/fsck-msgids.adoc
ADDED
|
@@ -0,0 +1,253 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
`badDate`::
|
| 2 |
+
(ERROR) Invalid date format in an author/committer line.
|
| 3 |
+
|
| 4 |
+
`badDateOverflow`::
|
| 5 |
+
(ERROR) Invalid date value in an author/committer line.
|
| 6 |
+
|
| 7 |
+
`badEmail`::
|
| 8 |
+
(ERROR) Invalid email format in an author/committer line.
|
| 9 |
+
|
| 10 |
+
`badFilemode`::
|
| 11 |
+
(INFO) A tree contains a bad filemode entry.
|
| 12 |
+
|
| 13 |
+
`badGpgsig`::
|
| 14 |
+
(ERROR) A tag contains a bad (truncated) signature (e.g., `gpgsig`) header.
|
| 15 |
+
|
| 16 |
+
`badHeadTarget`::
|
| 17 |
+
(ERROR) The `HEAD` ref is a symref that does not refer to a branch.
|
| 18 |
+
|
| 19 |
+
`badHeaderContinuation`::
|
| 20 |
+
(ERROR) A continuation header (such as for `gpgsig`) is unexpectedly truncated.
|
| 21 |
+
|
| 22 |
+
`badName`::
|
| 23 |
+
(ERROR) An author/committer name is empty.
|
| 24 |
+
|
| 25 |
+
`badObjectSha1`::
|
| 26 |
+
(ERROR) An object has a bad sha1.
|
| 27 |
+
|
| 28 |
+
`badPackedRefEntry`::
|
| 29 |
+
(ERROR) The "packed-refs" file contains an invalid entry.
|
| 30 |
+
|
| 31 |
+
`badPackedRefHeader`::
|
| 32 |
+
(ERROR) The "packed-refs" file contains an invalid
|
| 33 |
+
header.
|
| 34 |
+
|
| 35 |
+
`badParentSha1`::
|
| 36 |
+
(ERROR) A commit object has a bad parent sha1.
|
| 37 |
+
|
| 38 |
+
`badRefContent`::
|
| 39 |
+
(ERROR) A ref has bad content.
|
| 40 |
+
|
| 41 |
+
`badRefFiletype`::
|
| 42 |
+
(ERROR) A ref has a bad file type.
|
| 43 |
+
|
| 44 |
+
`badRefName`::
|
| 45 |
+
(ERROR) A ref has an invalid format.
|
| 46 |
+
|
| 47 |
+
`badRefOid`::
|
| 48 |
+
(ERROR) A ref points to an invalid object ID.
|
| 49 |
+
|
| 50 |
+
`badReferentName`::
|
| 51 |
+
(ERROR) The referent name of a symref is invalid.
|
| 52 |
+
|
| 53 |
+
`badReftableTableName`::
|
| 54 |
+
(WARN) A reftable table has an invalid name.
|
| 55 |
+
|
| 56 |
+
`badTagName`::
|
| 57 |
+
(INFO) A tag has an invalid format.
|
| 58 |
+
|
| 59 |
+
`badTimezone`::
|
| 60 |
+
(ERROR) Found an invalid time zone in an author/committer line.
|
| 61 |
+
|
| 62 |
+
`badTree`::
|
| 63 |
+
(ERROR) A tree cannot be parsed.
|
| 64 |
+
|
| 65 |
+
`badTreeSha1`::
|
| 66 |
+
(ERROR) A tree has an invalid format.
|
| 67 |
+
|
| 68 |
+
`badType`::
|
| 69 |
+
(ERROR) Found an invalid object type.
|
| 70 |
+
|
| 71 |
+
`duplicateEntries`::
|
| 72 |
+
(ERROR) A tree contains duplicate file entries.
|
| 73 |
+
|
| 74 |
+
`emptyName`::
|
| 75 |
+
(WARN) A path contains an empty name.
|
| 76 |
+
|
| 77 |
+
`emptyPackedRefsFile`::
|
| 78 |
+
(INFO) "packed-refs" file is empty. Report to the
|
| 79 |
+
git@vger.kernel.org mailing list if you see this error. As only
|
| 80 |
+
very early versions of Git would create such an empty
|
| 81 |
+
"packed_refs" file, we might tighten this rule in the future.
|
| 82 |
+
|
| 83 |
+
`extraHeaderEntry`::
|
| 84 |
+
(IGNORE) Extra headers found after `tagger`.
|
| 85 |
+
|
| 86 |
+
`fullPathname`::
|
| 87 |
+
(WARN) A path contains the full path starting with "/".
|
| 88 |
+
|
| 89 |
+
`gitattributesBlob`::
|
| 90 |
+
(ERROR) A non-blob found at `.gitattributes`.
|
| 91 |
+
|
| 92 |
+
`gitattributesLarge`::
|
| 93 |
+
(ERROR) The `.gitattributes` blob is too large.
|
| 94 |
+
|
| 95 |
+
`gitattributesLineLength`::
|
| 96 |
+
(ERROR) The `.gitattributes` blob contains too long lines.
|
| 97 |
+
|
| 98 |
+
`gitattributesMissing`::
|
| 99 |
+
(ERROR) Unable to read `.gitattributes` blob.
|
| 100 |
+
|
| 101 |
+
`gitattributesSymlink`::
|
| 102 |
+
(INFO) `.gitattributes` is a symlink.
|
| 103 |
+
|
| 104 |
+
`gitignoreSymlink`::
|
| 105 |
+
(INFO) `.gitignore` is a symlink.
|
| 106 |
+
|
| 107 |
+
`gitmodulesBlob`::
|
| 108 |
+
(ERROR) A non-blob found at `.gitmodules`.
|
| 109 |
+
|
| 110 |
+
`gitmodulesLarge`::
|
| 111 |
+
(ERROR) The `.gitmodules` file is too large to parse.
|
| 112 |
+
|
| 113 |
+
`gitmodulesMissing`::
|
| 114 |
+
(ERROR) Unable to read `.gitmodules` blob.
|
| 115 |
+
|
| 116 |
+
`gitmodulesName`::
|
| 117 |
+
(ERROR) A submodule name is invalid.
|
| 118 |
+
|
| 119 |
+
`gitmodulesParse`::
|
| 120 |
+
(INFO) Could not parse `.gitmodules` blob.
|
| 121 |
+
|
| 122 |
+
`gitmodulesPath`::
|
| 123 |
+
(ERROR) `.gitmodules` path is invalid.
|
| 124 |
+
|
| 125 |
+
`gitmodulesSymlink`::
|
| 126 |
+
(ERROR) `.gitmodules` is a symlink.
|
| 127 |
+
|
| 128 |
+
`gitmodulesUpdate`::
|
| 129 |
+
(ERROR) Found an invalid submodule update setting.
|
| 130 |
+
|
| 131 |
+
`gitmodulesUrl`::
|
| 132 |
+
(ERROR) Found an invalid submodule url.
|
| 133 |
+
|
| 134 |
+
`hasDot`::
|
| 135 |
+
(WARN) A tree contains an entry named `.`.
|
| 136 |
+
|
| 137 |
+
`hasDotdot`::
|
| 138 |
+
(WARN) A tree contains an entry named `..`.
|
| 139 |
+
|
| 140 |
+
`hasDotgit`::
|
| 141 |
+
(WARN) A tree contains an entry named `.git`.
|
| 142 |
+
|
| 143 |
+
`largePathname`::
|
| 144 |
+
(WARN) A tree contains an entry with a very long path name. If
|
| 145 |
+
the value of `fsck.largePathname` contains a colon, that value
|
| 146 |
+
is used as the maximum allowable length (e.g., "warn:10" would
|
| 147 |
+
complain about any path component of 11 or more bytes). The
|
| 148 |
+
default value is 4096.
|
| 149 |
+
|
| 150 |
+
`mailmapSymlink`::
|
| 151 |
+
(INFO) `.mailmap` is a symlink.
|
| 152 |
+
|
| 153 |
+
`missingAuthor`::
|
| 154 |
+
(ERROR) Author is missing.
|
| 155 |
+
|
| 156 |
+
`missingCommitter`::
|
| 157 |
+
(ERROR) Committer is missing.
|
| 158 |
+
|
| 159 |
+
`missingEmail`::
|
| 160 |
+
(ERROR) Email is missing in an author/committer line.
|
| 161 |
+
|
| 162 |
+
`missingNameBeforeEmail`::
|
| 163 |
+
(ERROR) Missing name before an email in an author/committer line.
|
| 164 |
+
|
| 165 |
+
`missingObject`::
|
| 166 |
+
(ERROR) Missing `object` line in tag object.
|
| 167 |
+
|
| 168 |
+
`missingSpaceBeforeDate`::
|
| 169 |
+
(ERROR) Missing space before date in an author/committer line.
|
| 170 |
+
|
| 171 |
+
`missingSpaceBeforeEmail`::
|
| 172 |
+
(ERROR) Missing space before the email in an author/committer line.
|
| 173 |
+
|
| 174 |
+
`missingTag`::
|
| 175 |
+
(ERROR) Unexpected end after `type` line in a tag object.
|
| 176 |
+
|
| 177 |
+
`missingTagEntry`::
|
| 178 |
+
(ERROR) Missing `tag` line in a tag object.
|
| 179 |
+
|
| 180 |
+
`missingTaggerEntry`::
|
| 181 |
+
(INFO) Missing `tagger` line in a tag object.
|
| 182 |
+
|
| 183 |
+
`missingTree`::
|
| 184 |
+
(ERROR) Missing `tree` line in a commit object.
|
| 185 |
+
|
| 186 |
+
`missingType`::
|
| 187 |
+
(ERROR) Invalid type value on the `type` line in a tag object.
|
| 188 |
+
|
| 189 |
+
`missingTypeEntry`::
|
| 190 |
+
(ERROR) Missing `type` line in a tag object.
|
| 191 |
+
|
| 192 |
+
`multipleAuthors`::
|
| 193 |
+
(ERROR) Multiple author lines found in a commit.
|
| 194 |
+
|
| 195 |
+
`nulInCommit`::
|
| 196 |
+
(WARN) Found a NUL byte in the commit object body.
|
| 197 |
+
|
| 198 |
+
`nulInHeader`::
|
| 199 |
+
(FATAL) NUL byte exists in the object header.
|
| 200 |
+
|
| 201 |
+
`nullSha1`::
|
| 202 |
+
(WARN) Tree contains entries pointing to a null sha1.
|
| 203 |
+
|
| 204 |
+
`packedRefEntryNotTerminated`::
|
| 205 |
+
(ERROR) The "packed-refs" file contains an entry that is
|
| 206 |
+
not terminated by a newline.
|
| 207 |
+
|
| 208 |
+
`packedRefUnsorted`::
|
| 209 |
+
(ERROR) The "packed-refs" file is not sorted.
|
| 210 |
+
|
| 211 |
+
`refMissingNewline`::
|
| 212 |
+
(INFO) A loose ref that does not end with newline(LF). As
|
| 213 |
+
valid implementations of Git never created such a loose ref
|
| 214 |
+
file, it may become an error in the future. Report to the
|
| 215 |
+
git@vger.kernel.org mailing list if you see this error, as
|
| 216 |
+
we need to know what tools created such a file.
|
| 217 |
+
|
| 218 |
+
`symlinkRef`::
|
| 219 |
+
(INFO) A symbolic link is used as a symref. Report to the
|
| 220 |
+
git@vger.kernel.org mailing list if you see this error, as we
|
| 221 |
+
are assessing the feasibility of dropping the support to drop
|
| 222 |
+
creating symbolic links as symrefs.
|
| 223 |
+
|
| 224 |
+
`symrefTargetIsNotARef`::
|
| 225 |
+
(INFO) The target of a symbolic reference points neither to
|
| 226 |
+
a root reference nor to a reference starting with "refs/".
|
| 227 |
+
Although we allow create a symref pointing to the referent which
|
| 228 |
+
is outside the "ref" by using `git symbolic-ref`, we may tighten
|
| 229 |
+
the rule in the future. Report to the git@vger.kernel.org
|
| 230 |
+
mailing list if you see this error, as we need to know what tools
|
| 231 |
+
created such a file.
|
| 232 |
+
|
| 233 |
+
`trailingRefContent`::
|
| 234 |
+
(INFO) A loose ref has trailing content. As valid implementations
|
| 235 |
+
of Git never created such a loose ref file, it may become an
|
| 236 |
+
error in the future. Report to the git@vger.kernel.org mailing
|
| 237 |
+
list if you see this error, as we need to know what tools
|
| 238 |
+
created such a file.
|
| 239 |
+
|
| 240 |
+
`treeNotSorted`::
|
| 241 |
+
(ERROR) A tree is not properly sorted.
|
| 242 |
+
|
| 243 |
+
`unknownType`::
|
| 244 |
+
(ERROR) Found an unknown object type.
|
| 245 |
+
|
| 246 |
+
`unterminatedHeader`::
|
| 247 |
+
(FATAL) Missing end-of-line in the object header.
|
| 248 |
+
|
| 249 |
+
`zeroPaddedDate`::
|
| 250 |
+
(ERROR) Found a zero padded date in an author/committer line.
|
| 251 |
+
|
| 252 |
+
`zeroPaddedFilemode`::
|
| 253 |
+
(WARN) Found a zero padded filemode in a tree.
|
git/mingw64/share/doc/git-doc/git-add.adoc
ADDED
|
@@ -0,0 +1,460 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-add(1)
|
| 2 |
+
==========
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-add - Add file contents to the index
|
| 7 |
+
|
| 8 |
+
SYNOPSIS
|
| 9 |
+
--------
|
| 10 |
+
[synopsis]
|
| 11 |
+
git add [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
|
| 12 |
+
[--edit | -e] [--[no-]all | -A | --[no-]ignore-removal | [--update | -u]] [--sparse]
|
| 13 |
+
[--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize]
|
| 14 |
+
[--chmod=(+|-)x] [--pathspec-from-file=<file> [--pathspec-file-nul]]
|
| 15 |
+
[--] [<pathspec>...]
|
| 16 |
+
|
| 17 |
+
DESCRIPTION
|
| 18 |
+
-----------
|
| 19 |
+
Add contents of new or changed files to the index. The "index" (also
|
| 20 |
+
known as the "staging area") is what you use to prepare the contents of
|
| 21 |
+
the next commit.
|
| 22 |
+
|
| 23 |
+
When you run `git commit` without any other arguments, it will only
|
| 24 |
+
commit staged changes. For example, if you've edited `file.c` and want
|
| 25 |
+
to commit your changes to that file, you can run:
|
| 26 |
+
|
| 27 |
+
git add file.c
|
| 28 |
+
git commit
|
| 29 |
+
|
| 30 |
+
You can also add only part of your changes to a file with `git add -p`.
|
| 31 |
+
|
| 32 |
+
This command can be performed multiple times before a commit. It only
|
| 33 |
+
adds the content of the specified file(s) at the time the add command is
|
| 34 |
+
run; if you want subsequent changes included in the next commit, then
|
| 35 |
+
you must run `git add` again to add the new content to the index.
|
| 36 |
+
|
| 37 |
+
The `git status` command can be used to obtain a summary of which
|
| 38 |
+
files have changes that are staged for the next commit.
|
| 39 |
+
|
| 40 |
+
The `git add` command will not add ignored files by default. You can
|
| 41 |
+
use the `--force` option to add ignored files. If you specify the exact
|
| 42 |
+
filename of an ignored file, `git add` will fail with a list of ignored
|
| 43 |
+
files. Otherwise it will silently ignore the file.
|
| 44 |
+
|
| 45 |
+
Please see linkgit:git-commit[1] for alternative ways to add content to a
|
| 46 |
+
commit.
|
| 47 |
+
|
| 48 |
+
|
| 49 |
+
OPTIONS
|
| 50 |
+
-------
|
| 51 |
+
`<pathspec>...`::
|
| 52 |
+
Files to add content from. Fileglobs (e.g. `*.c`) can
|
| 53 |
+
be given to add all matching files. Also a
|
| 54 |
+
leading directory name (e.g. `dir` to add `dir/file1`
|
| 55 |
+
and `dir/file2`) can be given to update the index to
|
| 56 |
+
match the current state of the directory as a whole (e.g.
|
| 57 |
+
specifying `dir` will record not just a file `dir/file1`
|
| 58 |
+
modified in the working tree, a file `dir/file2` added to
|
| 59 |
+
the working tree, but also a file `dir/file3` removed from
|
| 60 |
+
the working tree). Note that older versions of Git used
|
| 61 |
+
to ignore removed files; use `--no-all` option if you want
|
| 62 |
+
to add modified or new files but ignore removed ones.
|
| 63 |
+
+
|
| 64 |
+
For more details about the _<pathspec>_ syntax, see the 'pathspec' entry
|
| 65 |
+
in linkgit:gitglossary[7].
|
| 66 |
+
|
| 67 |
+
`-n`::
|
| 68 |
+
`--dry-run`::
|
| 69 |
+
Don't actually add the file(s), just show if they exist and/or will
|
| 70 |
+
be ignored.
|
| 71 |
+
|
| 72 |
+
`-v`::
|
| 73 |
+
`--verbose`::
|
| 74 |
+
Be verbose.
|
| 75 |
+
|
| 76 |
+
`-f`::
|
| 77 |
+
`--force`::
|
| 78 |
+
Allow adding otherwise ignored files. The option is also used when
|
| 79 |
+
`submodule.<name>.ignore=all` is set, but you want to stage an
|
| 80 |
+
update of the submodule. The `path` to the submodule must be explicitly
|
| 81 |
+
specified.
|
| 82 |
+
|
| 83 |
+
`--sparse`::
|
| 84 |
+
Allow updating index entries outside of the sparse-checkout cone.
|
| 85 |
+
Normally, `git add` refuses to update index entries whose paths do
|
| 86 |
+
not fit within the sparse-checkout cone, since those files might
|
| 87 |
+
be removed from the working tree without warning. See
|
| 88 |
+
linkgit:git-sparse-checkout[1] for more details.
|
| 89 |
+
|
| 90 |
+
`-i`::
|
| 91 |
+
`--interactive`::
|
| 92 |
+
Add modified contents in the working tree interactively to
|
| 93 |
+
the index. Optional path arguments may be supplied to limit
|
| 94 |
+
operation to a subset of the working tree. See ``Interactive
|
| 95 |
+
mode'' for details.
|
| 96 |
+
|
| 97 |
+
`-p`::
|
| 98 |
+
`--patch`::
|
| 99 |
+
Interactively choose hunks of patch between the index and the
|
| 100 |
+
work tree and add them to the index. This gives the user a chance
|
| 101 |
+
to review the difference before adding modified contents to the
|
| 102 |
+
index.
|
| 103 |
+
+
|
| 104 |
+
This effectively runs `add --interactive`, but bypasses the
|
| 105 |
+
initial command menu and directly jumps to the `patch` subcommand.
|
| 106 |
+
See ``Interactive mode'' for details.
|
| 107 |
+
|
| 108 |
+
include::diff-context-options.adoc[]
|
| 109 |
+
|
| 110 |
+
`-e`::
|
| 111 |
+
`--edit`::
|
| 112 |
+
Open the diff vs. the index in an editor and let the user
|
| 113 |
+
edit it. After the editor was closed, adjust the hunk headers
|
| 114 |
+
and apply the patch to the index.
|
| 115 |
+
+
|
| 116 |
+
The intent of this option is to pick and choose lines of the patch to
|
| 117 |
+
apply, or even to modify the contents of lines to be staged. This can be
|
| 118 |
+
quicker and more flexible than using the interactive hunk selector.
|
| 119 |
+
However, it is easy to confuse oneself and create a patch that does not
|
| 120 |
+
apply to the index. See EDITING PATCHES below.
|
| 121 |
+
|
| 122 |
+
`-u`::
|
| 123 |
+
`--update`::
|
| 124 |
+
Update the index just where it already has an entry matching
|
| 125 |
+
_<pathspec>_. This removes as well as modifies index entries to
|
| 126 |
+
match the working tree, but adds no new files.
|
| 127 |
+
+
|
| 128 |
+
If no _<pathspec>_ is given when `-u` option is used, all
|
| 129 |
+
tracked files in the entire working tree are updated (old versions
|
| 130 |
+
of Git used to limit the update to the current directory and its
|
| 131 |
+
subdirectories).
|
| 132 |
+
|
| 133 |
+
`-A`::
|
| 134 |
+
`--all`::
|
| 135 |
+
`--no-ignore-removal`::
|
| 136 |
+
Update the index not only where the working tree has a file
|
| 137 |
+
matching _<pathspec>_ but also where the index already has an
|
| 138 |
+
entry. This adds, modifies, and removes index entries to
|
| 139 |
+
match the working tree.
|
| 140 |
+
+
|
| 141 |
+
If no _<pathspec>_ is given when `-A` option is used, all
|
| 142 |
+
files in the entire working tree are updated (old versions
|
| 143 |
+
of Git used to limit the update to the current directory and its
|
| 144 |
+
subdirectories).
|
| 145 |
+
|
| 146 |
+
`--no-all`::
|
| 147 |
+
`--ignore-removal`::
|
| 148 |
+
Update the index by adding new files that are unknown to the
|
| 149 |
+
index and files modified in the working tree, but ignore
|
| 150 |
+
files that have been removed from the working tree. This
|
| 151 |
+
option is a no-op when no _<pathspec>_ is used.
|
| 152 |
+
+
|
| 153 |
+
This option is primarily to help users who are used to older
|
| 154 |
+
versions of Git, whose `git add <pathspec>...` was a synonym
|
| 155 |
+
for `git add --no-all <pathspec>...`, i.e. ignored removed files.
|
| 156 |
+
|
| 157 |
+
`-N`::
|
| 158 |
+
`--intent-to-add`::
|
| 159 |
+
Record only the fact that the path will be added later. An entry
|
| 160 |
+
for the path is placed in the index with no content. This is
|
| 161 |
+
useful for, among other things, showing the unstaged content of
|
| 162 |
+
such files with `git diff` and committing them with `git commit
|
| 163 |
+
-a`.
|
| 164 |
+
|
| 165 |
+
`--refresh`::
|
| 166 |
+
Don't add the file(s), but only refresh their stat()
|
| 167 |
+
information in the index.
|
| 168 |
+
|
| 169 |
+
`--ignore-errors`::
|
| 170 |
+
If some files could not be added because of errors indexing
|
| 171 |
+
them, do not abort the operation, but continue adding the
|
| 172 |
+
others. The command shall still exit with non-zero status.
|
| 173 |
+
The configuration variable `add.ignoreErrors` can be set to
|
| 174 |
+
true to make this the default behaviour.
|
| 175 |
+
|
| 176 |
+
`--ignore-missing`::
|
| 177 |
+
This option can only be used together with `--dry-run`. By using
|
| 178 |
+
this option the user can check if any of the given files would
|
| 179 |
+
be ignored, no matter if they are already present in the work
|
| 180 |
+
tree or not.
|
| 181 |
+
|
| 182 |
+
`--no-warn-embedded-repo`::
|
| 183 |
+
By default, `git add` will warn when adding an embedded
|
| 184 |
+
repository to the index without using `git submodule add` to
|
| 185 |
+
create an entry in `.gitmodules`. This option will suppress the
|
| 186 |
+
warning (e.g., if you are manually performing operations on
|
| 187 |
+
submodules).
|
| 188 |
+
|
| 189 |
+
`--renormalize`::
|
| 190 |
+
Apply the "clean" process freshly to all tracked files to
|
| 191 |
+
forcibly add them again to the index. This is useful after
|
| 192 |
+
changing `core.autocrlf` configuration or the `text` attribute
|
| 193 |
+
in order to correct files added with wrong _CRLF/LF_ line endings.
|
| 194 |
+
This option implies `-u`. Lone CR characters are untouched, thus
|
| 195 |
+
while a _CRLF_ cleans to _LF_, a _CRCRLF_ sequence is only partially
|
| 196 |
+
cleaned to _CRLF_.
|
| 197 |
+
|
| 198 |
+
`--chmod=(+|-)x`::
|
| 199 |
+
Override the executable bit of the added files. The executable
|
| 200 |
+
bit is only changed in the index, the files on disk are left
|
| 201 |
+
unchanged.
|
| 202 |
+
|
| 203 |
+
`--pathspec-from-file=<file>`::
|
| 204 |
+
Pathspec is passed in _<file>_ instead of commandline args. If
|
| 205 |
+
_<file>_ is exactly `-` then standard input is used. Pathspec
|
| 206 |
+
elements are separated by _LF_ or _CR/LF_. Pathspec elements can be
|
| 207 |
+
quoted as explained for the configuration variable `core.quotePath`
|
| 208 |
+
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
|
| 209 |
+
global `--literal-pathspecs`.
|
| 210 |
+
|
| 211 |
+
`--pathspec-file-nul`::
|
| 212 |
+
Only meaningful with `--pathspec-from-file`. Pathspec elements are
|
| 213 |
+
separated with _NUL_ character and all other characters are taken
|
| 214 |
+
literally (including newlines and quotes).
|
| 215 |
+
|
| 216 |
+
`--`::
|
| 217 |
+
This option can be used to separate command-line options from
|
| 218 |
+
the list of files, (useful when filenames might be mistaken
|
| 219 |
+
for command-line options).
|
| 220 |
+
|
| 221 |
+
|
| 222 |
+
EXAMPLES
|
| 223 |
+
--------
|
| 224 |
+
|
| 225 |
+
* Adds content from all ++*.txt++ files under `Documentation` directory
|
| 226 |
+
and its subdirectories:
|
| 227 |
+
+
|
| 228 |
+
------------
|
| 229 |
+
$ git add Documentation/\*.txt
|
| 230 |
+
------------
|
| 231 |
+
+
|
| 232 |
+
Note that the asterisk ++*++ is quoted from the shell in this
|
| 233 |
+
example; this lets the command include the files from
|
| 234 |
+
subdirectories of `Documentation/` directory.
|
| 235 |
+
|
| 236 |
+
* Considers adding content from all ++git-*.sh++ scripts:
|
| 237 |
+
+
|
| 238 |
+
------------
|
| 239 |
+
$ git add git-*.sh
|
| 240 |
+
------------
|
| 241 |
+
+
|
| 242 |
+
Because this example lets the shell expand the asterisk (i.e. you are
|
| 243 |
+
listing the files explicitly), it does not consider
|
| 244 |
+
`subdir/git-foo.sh`.
|
| 245 |
+
|
| 246 |
+
INTERACTIVE MODE
|
| 247 |
+
----------------
|
| 248 |
+
When the command enters the interactive mode, it shows the
|
| 249 |
+
output of the 'status' subcommand, and then goes into its
|
| 250 |
+
interactive command loop.
|
| 251 |
+
|
| 252 |
+
The command loop shows the list of subcommands available, and
|
| 253 |
+
gives a prompt "What now> ". In general, when the prompt ends
|
| 254 |
+
with a single '>', you can pick only one of the choices given
|
| 255 |
+
and type return, like this:
|
| 256 |
+
|
| 257 |
+
------------
|
| 258 |
+
*** Commands ***
|
| 259 |
+
1: status 2: update 3: revert 4: add untracked
|
| 260 |
+
5: patch 6: diff 7: quit 8: help
|
| 261 |
+
What now> 1
|
| 262 |
+
------------
|
| 263 |
+
|
| 264 |
+
You also could say `s` or `sta` or `status` above as long as the
|
| 265 |
+
choice is unique.
|
| 266 |
+
|
| 267 |
+
The main command loop has 6 subcommands (plus help and quit).
|
| 268 |
+
|
| 269 |
+
status::
|
| 270 |
+
|
| 271 |
+
This shows the change between `HEAD` and index (i.e. what will be
|
| 272 |
+
committed if you say `git commit`), and between index and
|
| 273 |
+
working tree files (i.e. what you could stage further before
|
| 274 |
+
`git commit` using `git add`) for each path. A sample output
|
| 275 |
+
looks like this:
|
| 276 |
+
+
|
| 277 |
+
------------
|
| 278 |
+
staged unstaged path
|
| 279 |
+
1: binary nothing foo.png
|
| 280 |
+
2: +403/-35 +1/-1 add-interactive.c
|
| 281 |
+
------------
|
| 282 |
+
+
|
| 283 |
+
It shows that `foo.png` has differences from `HEAD` (but that is
|
| 284 |
+
binary so line count cannot be shown) and there is no
|
| 285 |
+
difference between indexed copy and the working tree
|
| 286 |
+
version (if the working tree version were also different,
|
| 287 |
+
'binary' would have been shown in place of 'nothing'). The
|
| 288 |
+
other file, `add-interactive.c`, has 403 lines added
|
| 289 |
+
and 35 lines deleted if you commit what is in the index, but
|
| 290 |
+
working tree file has further modifications (one addition and
|
| 291 |
+
one deletion).
|
| 292 |
+
|
| 293 |
+
update::
|
| 294 |
+
|
| 295 |
+
This shows the status information and issues an "Update>>"
|
| 296 |
+
prompt. When the prompt ends with double '>>', you can
|
| 297 |
+
make more than one selection, concatenated with whitespace or
|
| 298 |
+
comma. Also you can say ranges. E.g. "2-5 7,9" to choose
|
| 299 |
+
2,3,4,5,7,9 from the list. If the second number in a range is
|
| 300 |
+
omitted, all remaining patches are taken. E.g. "7-" to choose
|
| 301 |
+
7,8,9 from the list. You can say '*' to choose everything.
|
| 302 |
+
+
|
| 303 |
+
What you chose are then highlighted with '*',
|
| 304 |
+
like this:
|
| 305 |
+
+
|
| 306 |
+
------------
|
| 307 |
+
staged unstaged path
|
| 308 |
+
1: binary nothing foo.png
|
| 309 |
+
* 2: +403/-35 +1/-1 add-interactive.c
|
| 310 |
+
------------
|
| 311 |
+
+
|
| 312 |
+
To remove selection, prefix the input with `-`
|
| 313 |
+
like this:
|
| 314 |
+
+
|
| 315 |
+
------------
|
| 316 |
+
Update>> -2
|
| 317 |
+
------------
|
| 318 |
+
+
|
| 319 |
+
After making the selection, answer with an empty line to stage the
|
| 320 |
+
contents of working tree files for selected paths in the index.
|
| 321 |
+
|
| 322 |
+
revert::
|
| 323 |
+
|
| 324 |
+
This has a very similar UI to 'update', and the staged
|
| 325 |
+
information for selected paths are reverted to that of the
|
| 326 |
+
HEAD version. Reverting new paths makes them untracked.
|
| 327 |
+
|
| 328 |
+
add untracked::
|
| 329 |
+
|
| 330 |
+
This has a very similar UI to 'update' and
|
| 331 |
+
'revert', and lets you add untracked paths to the index.
|
| 332 |
+
|
| 333 |
+
patch::
|
| 334 |
+
|
| 335 |
+
This lets you choose one path out of a 'status' like selection.
|
| 336 |
+
After choosing the path, it presents the diff between the index
|
| 337 |
+
and the working tree file and asks you if you want to stage
|
| 338 |
+
the change of each hunk. You can select one of the following
|
| 339 |
+
options and type return:
|
| 340 |
+
|
| 341 |
+
y - stage this hunk
|
| 342 |
+
n - do not stage this hunk
|
| 343 |
+
q - quit; do not stage this hunk or any of the remaining ones
|
| 344 |
+
a - stage this hunk and all later hunks in the file
|
| 345 |
+
d - do not stage this hunk or any of the later hunks in the file
|
| 346 |
+
g - select a hunk to go to
|
| 347 |
+
/ - search for a hunk matching the given regex
|
| 348 |
+
j - go to the next undecided hunk, roll over at the bottom
|
| 349 |
+
J - go to the next hunk, roll over at the bottom
|
| 350 |
+
k - go to the previous undecided hunk, roll over at the top
|
| 351 |
+
K - go to the previous hunk, roll over at the top
|
| 352 |
+
s - split the current hunk into smaller hunks
|
| 353 |
+
e - manually edit the current hunk
|
| 354 |
+
p - print the current hunk
|
| 355 |
+
P - print the current hunk using the pager
|
| 356 |
+
? - print help
|
| 357 |
+
+
|
| 358 |
+
After deciding the fate for all hunks, if there is any hunk
|
| 359 |
+
that was chosen, the index is updated with the selected hunks.
|
| 360 |
+
+
|
| 361 |
+
You can omit having to type return here, by setting the configuration
|
| 362 |
+
variable `interactive.singleKey` to `true`.
|
| 363 |
+
|
| 364 |
+
diff::
|
| 365 |
+
|
| 366 |
+
This lets you review what will be committed (i.e. between
|
| 367 |
+
`HEAD` and index).
|
| 368 |
+
|
| 369 |
+
|
| 370 |
+
EDITING PATCHES
|
| 371 |
+
---------------
|
| 372 |
+
|
| 373 |
+
Invoking `git add -e` or selecting `e` from the interactive hunk
|
| 374 |
+
selector will open a patch in your editor; after the editor exits, the
|
| 375 |
+
result is applied to the index. You are free to make arbitrary changes
|
| 376 |
+
to the patch, but note that some changes may have confusing results, or
|
| 377 |
+
even result in a patch that cannot be applied. If you want to abort the
|
| 378 |
+
operation entirely (i.e., stage nothing new in the index), simply delete
|
| 379 |
+
all lines of the patch. The list below describes some common things you
|
| 380 |
+
may see in a patch, and which editing operations make sense on them.
|
| 381 |
+
|
| 382 |
+
--
|
| 383 |
+
added content::
|
| 384 |
+
|
| 385 |
+
Added content is represented by lines beginning with "{plus}". You can
|
| 386 |
+
prevent staging any addition lines by deleting them.
|
| 387 |
+
|
| 388 |
+
removed content::
|
| 389 |
+
|
| 390 |
+
Removed content is represented by lines beginning with "-". You can
|
| 391 |
+
prevent staging their removal by converting the "-" to a " " (space).
|
| 392 |
+
|
| 393 |
+
modified content::
|
| 394 |
+
|
| 395 |
+
Modified content is represented by "-" lines (removing the old content)
|
| 396 |
+
followed by "{plus}" lines (adding the replacement content). You can
|
| 397 |
+
prevent staging the modification by converting "-" lines to " ", and
|
| 398 |
+
removing "{plus}" lines. Beware that modifying only half of the pair is
|
| 399 |
+
likely to introduce confusing changes to the index.
|
| 400 |
+
--
|
| 401 |
+
|
| 402 |
+
There are also more complex operations that can be performed. But beware
|
| 403 |
+
that because the patch is applied only to the index and not the working
|
| 404 |
+
tree, the working tree will appear to "undo" the change in the index.
|
| 405 |
+
For example, introducing a new line into the index that is in neither
|
| 406 |
+
the `HEAD` nor the working tree will stage the new line for commit, but
|
| 407 |
+
the line will appear to be reverted in the working tree.
|
| 408 |
+
|
| 409 |
+
Avoid using these constructs, or do so with extreme caution.
|
| 410 |
+
|
| 411 |
+
--
|
| 412 |
+
removing untouched content::
|
| 413 |
+
|
| 414 |
+
Content which does not differ between the index and working tree may be
|
| 415 |
+
shown on context lines, beginning with a " " (space). You can stage
|
| 416 |
+
context lines for removal by converting the space to a "-". The
|
| 417 |
+
resulting working tree file will appear to re-add the content.
|
| 418 |
+
|
| 419 |
+
modifying existing content::
|
| 420 |
+
|
| 421 |
+
One can also modify context lines by staging them for removal (by
|
| 422 |
+
converting " " to "-") and adding a "{plus}" line with the new content.
|
| 423 |
+
Similarly, one can modify "{plus}" lines for existing additions or
|
| 424 |
+
modifications. In all cases, the new modification will appear reverted
|
| 425 |
+
in the working tree.
|
| 426 |
+
|
| 427 |
+
new content::
|
| 428 |
+
|
| 429 |
+
You may also add new content that does not exist in the patch; simply
|
| 430 |
+
add new lines, each starting with "{plus}". The addition will appear
|
| 431 |
+
reverted in the working tree.
|
| 432 |
+
--
|
| 433 |
+
|
| 434 |
+
There are also several operations which should be avoided entirely, as
|
| 435 |
+
they will make the patch impossible to apply:
|
| 436 |
+
|
| 437 |
+
* adding context (" ") or removal ("-") lines
|
| 438 |
+
* deleting context or removal lines
|
| 439 |
+
* modifying the contents of context or removal lines
|
| 440 |
+
|
| 441 |
+
CONFIGURATION
|
| 442 |
+
-------------
|
| 443 |
+
|
| 444 |
+
include::includes/cmd-config-section-all.adoc[]
|
| 445 |
+
|
| 446 |
+
:git-add: 1
|
| 447 |
+
include::config/add.adoc[]
|
| 448 |
+
|
| 449 |
+
SEE ALSO
|
| 450 |
+
--------
|
| 451 |
+
linkgit:git-status[1]
|
| 452 |
+
linkgit:git-rm[1]
|
| 453 |
+
linkgit:git-reset[1]
|
| 454 |
+
linkgit:git-mv[1]
|
| 455 |
+
linkgit:git-commit[1]
|
| 456 |
+
linkgit:git-update-index[1]
|
| 457 |
+
|
| 458 |
+
GIT
|
| 459 |
+
---
|
| 460 |
+
Part of the linkgit:git[1] suite
|
git/mingw64/share/doc/git-doc/git-add.html
ADDED
|
@@ -0,0 +1,1058 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-add(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-add(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-add - Add file contents to the index</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content"><code>git</code> <code>add</code> [<code>--verbose</code> | <code>-v</code>] [<code>--dry-run</code> | <code>-n</code>] [<code>--force</code> | <code>-f</code>] [<code>--interactive</code> | <code>-i</code>] [<code>--patch</code> | <code>-p</code>]
|
| 456 |
+
[<code>--edit</code> | <code>-e</code>] [<code>--</code>[<code>no-</code>]<code>all</code> | <code>-A</code> | <code>--</code>[<code>no-</code>]<code>ignore-removal</code> | [<code>--update</code> | <code>-u</code>]] [<code>--sparse</code>]
|
| 457 |
+
[<code>--intent-to-add</code> | <code>-N</code>] [<code>--refresh</code>] [<code>--ignore-errors</code>] [<code>--ignore-missing</code>] [<code>--renormalize</code>]
|
| 458 |
+
[<code>--chmod=</code>(<code>+</code>|<code>-</code>)<code>x</code>] [<code>--pathspec-from-file=</code><em><file></em> [<code>--pathspec-file-nul</code>]]
|
| 459 |
+
[<code>--</code>] [<em><pathspec></em>…​]</pre>
|
| 460 |
+
</div>
|
| 461 |
+
</div>
|
| 462 |
+
</div>
|
| 463 |
+
<div class="sect1">
|
| 464 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 465 |
+
<div class="sectionbody">
|
| 466 |
+
<div class="paragraph">
|
| 467 |
+
<p>Add contents of new or changed files to the index. The "index" (also
|
| 468 |
+
known as the "staging area") is what you use to prepare the contents of
|
| 469 |
+
the next commit.</p>
|
| 470 |
+
</div>
|
| 471 |
+
<div class="paragraph">
|
| 472 |
+
<p>When you run <code>git</code> <code>commit</code> without any other arguments, it will only
|
| 473 |
+
commit staged changes. For example, if you’ve edited <code>file.c</code> and want
|
| 474 |
+
to commit your changes to that file, you can run:</p>
|
| 475 |
+
</div>
|
| 476 |
+
<div class="literalblock">
|
| 477 |
+
<div class="content">
|
| 478 |
+
<pre>git add file.c
|
| 479 |
+
git commit</pre>
|
| 480 |
+
</div>
|
| 481 |
+
</div>
|
| 482 |
+
<div class="paragraph">
|
| 483 |
+
<p>You can also add only part of your changes to a file with <code>git</code> <code>add</code> <code>-p</code>.</p>
|
| 484 |
+
</div>
|
| 485 |
+
<div class="paragraph">
|
| 486 |
+
<p>This command can be performed multiple times before a commit. It only
|
| 487 |
+
adds the content of the specified file(s) at the time the add command is
|
| 488 |
+
run; if you want subsequent changes included in the next commit, then
|
| 489 |
+
you must run <code>git</code> <code>add</code> again to add the new content to the index.</p>
|
| 490 |
+
</div>
|
| 491 |
+
<div class="paragraph">
|
| 492 |
+
<p>The <code>git</code> <code>status</code> command can be used to obtain a summary of which
|
| 493 |
+
files have changes that are staged for the next commit.</p>
|
| 494 |
+
</div>
|
| 495 |
+
<div class="paragraph">
|
| 496 |
+
<p>The <code>git</code> <code>add</code> command will not add ignored files by default. You can
|
| 497 |
+
use the <code>--force</code> option to add ignored files. If you specify the exact
|
| 498 |
+
filename of an ignored file, <code>git</code> <code>add</code> will fail with a list of ignored
|
| 499 |
+
files. Otherwise it will silently ignore the file.</p>
|
| 500 |
+
</div>
|
| 501 |
+
<div class="paragraph">
|
| 502 |
+
<p>Please see <a href="git-commit.html">git-commit(1)</a> for alternative ways to add content to a
|
| 503 |
+
commit.</p>
|
| 504 |
+
</div>
|
| 505 |
+
</div>
|
| 506 |
+
</div>
|
| 507 |
+
<div class="sect1">
|
| 508 |
+
<h2 id="_options">OPTIONS</h2>
|
| 509 |
+
<div class="sectionbody">
|
| 510 |
+
<div class="dlist">
|
| 511 |
+
<dl>
|
| 512 |
+
<dt class="hdlist1"><em><pathspec></em>...</dt>
|
| 513 |
+
<dd>
|
| 514 |
+
<p>Files to add content from. Fileglobs (e.g. <code>*.c</code>) can
|
| 515 |
+
be given to add all matching files. Also a
|
| 516 |
+
leading directory name (e.g. <code>dir</code> to add <code>dir/file1</code>
|
| 517 |
+
and <code>dir/file2</code>) can be given to update the index to
|
| 518 |
+
match the current state of the directory as a whole (e.g.
|
| 519 |
+
specifying <code>dir</code> will record not just a file <code>dir/file1</code>
|
| 520 |
+
modified in the working tree, a file <code>dir/file2</code> added to
|
| 521 |
+
the working tree, but also a file <code>dir/file3</code> removed from
|
| 522 |
+
the working tree). Note that older versions of Git used
|
| 523 |
+
to ignore removed files; use <code>--no-all</code> option if you want
|
| 524 |
+
to add modified or new files but ignore removed ones.</p>
|
| 525 |
+
<div class="paragraph">
|
| 526 |
+
<p>For more details about the <em><pathspec></em> syntax, see the <em>pathspec</em> entry
|
| 527 |
+
in <a href="gitglossary.html">gitglossary(7)</a>.</p>
|
| 528 |
+
</div>
|
| 529 |
+
</dd>
|
| 530 |
+
<dt class="hdlist1"><code>-n</code></dt>
|
| 531 |
+
<dt class="hdlist1"><code>--dry-run</code></dt>
|
| 532 |
+
<dd>
|
| 533 |
+
<p>Don’t actually add the file(s), just show if they exist and/or will
|
| 534 |
+
be ignored.</p>
|
| 535 |
+
</dd>
|
| 536 |
+
<dt class="hdlist1"><code>-v</code></dt>
|
| 537 |
+
<dt class="hdlist1"><code>--verbose</code></dt>
|
| 538 |
+
<dd>
|
| 539 |
+
<p>Be verbose.</p>
|
| 540 |
+
</dd>
|
| 541 |
+
<dt class="hdlist1"><code>-f</code></dt>
|
| 542 |
+
<dt class="hdlist1"><code>--force</code></dt>
|
| 543 |
+
<dd>
|
| 544 |
+
<p>Allow adding otherwise ignored files. The option is also used when
|
| 545 |
+
<code>submodule.</code><em><name></em><code>.ignore=all</code> is set, but you want to stage an
|
| 546 |
+
update of the submodule. The <code>path</code> to the submodule must be explicitly
|
| 547 |
+
specified.</p>
|
| 548 |
+
</dd>
|
| 549 |
+
<dt class="hdlist1"><code>--sparse</code></dt>
|
| 550 |
+
<dd>
|
| 551 |
+
<p>Allow updating index entries outside of the sparse-checkout cone.
|
| 552 |
+
Normally, <code>git</code> <code>add</code> refuses to update index entries whose paths do
|
| 553 |
+
not fit within the sparse-checkout cone, since those files might
|
| 554 |
+
be removed from the working tree without warning. See
|
| 555 |
+
<a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more details.</p>
|
| 556 |
+
</dd>
|
| 557 |
+
<dt class="hdlist1"><code>-i</code></dt>
|
| 558 |
+
<dt class="hdlist1"><code>--interactive</code></dt>
|
| 559 |
+
<dd>
|
| 560 |
+
<p>Add modified contents in the working tree interactively to
|
| 561 |
+
the index. Optional path arguments may be supplied to limit
|
| 562 |
+
operation to a subset of the working tree. See “Interactive
|
| 563 |
+
mode” for details.</p>
|
| 564 |
+
</dd>
|
| 565 |
+
<dt class="hdlist1"><code>-p</code></dt>
|
| 566 |
+
<dt class="hdlist1"><code>--patch</code></dt>
|
| 567 |
+
<dd>
|
| 568 |
+
<p>Interactively choose hunks of patch between the index and the
|
| 569 |
+
work tree and add them to the index. This gives the user a chance
|
| 570 |
+
to review the difference before adding modified contents to the
|
| 571 |
+
index.</p>
|
| 572 |
+
<div class="paragraph">
|
| 573 |
+
<p>This effectively runs <code>add</code> <code>--interactive</code>, but bypasses the
|
| 574 |
+
initial command menu and directly jumps to the <code>patch</code> subcommand.
|
| 575 |
+
See “Interactive mode” for details.</p>
|
| 576 |
+
</div>
|
| 577 |
+
</dd>
|
| 578 |
+
<dt class="hdlist1"><code>-U</code><em><n></em></dt>
|
| 579 |
+
<dt class="hdlist1"><code>--unified=</code><em><n></em></dt>
|
| 580 |
+
<dd>
|
| 581 |
+
<p>Generate diffs with <em><n></em> lines of context. The number of context
|
| 582 |
+
lines defaults to <code>diff.context</code> or 3 if the configuration variable
|
| 583 |
+
is unset. (<code>-U</code> without <em><n></em> is silently accepted as a synonym for
|
| 584 |
+
<code>-p</code> due to a historical accident).</p>
|
| 585 |
+
</dd>
|
| 586 |
+
<dt class="hdlist1"><code>--inter-hunk-context=</code><em><n></em></dt>
|
| 587 |
+
<dd>
|
| 588 |
+
<p>Show the context between diff hunks, up to the specified <em><number></em>
|
| 589 |
+
of lines, thereby fusing hunks that are close to each other.
|
| 590 |
+
Defaults to <code>diff.interHunkContext</code> or 0 if the config option
|
| 591 |
+
is unset.</p>
|
| 592 |
+
</dd>
|
| 593 |
+
<dt class="hdlist1"><code>-e</code></dt>
|
| 594 |
+
<dt class="hdlist1"><code>--edit</code></dt>
|
| 595 |
+
<dd>
|
| 596 |
+
<p>Open the diff vs. the index in an editor and let the user
|
| 597 |
+
edit it. After the editor was closed, adjust the hunk headers
|
| 598 |
+
and apply the patch to the index.</p>
|
| 599 |
+
<div class="paragraph">
|
| 600 |
+
<p>The intent of this option is to pick and choose lines of the patch to
|
| 601 |
+
apply, or even to modify the contents of lines to be staged. This can be
|
| 602 |
+
quicker and more flexible than using the interactive hunk selector.
|
| 603 |
+
However, it is easy to confuse oneself and create a patch that does not
|
| 604 |
+
apply to the index. See EDITING PATCHES below.</p>
|
| 605 |
+
</div>
|
| 606 |
+
</dd>
|
| 607 |
+
<dt class="hdlist1"><code>-u</code></dt>
|
| 608 |
+
<dt class="hdlist1"><code>--update</code></dt>
|
| 609 |
+
<dd>
|
| 610 |
+
<p>Update the index just where it already has an entry matching
|
| 611 |
+
<em><pathspec></em>. This removes as well as modifies index entries to
|
| 612 |
+
match the working tree, but adds no new files.</p>
|
| 613 |
+
<div class="paragraph">
|
| 614 |
+
<p>If no <em><pathspec></em> is given when <code>-u</code> option is used, all
|
| 615 |
+
tracked files in the entire working tree are updated (old versions
|
| 616 |
+
of Git used to limit the update to the current directory and its
|
| 617 |
+
subdirectories).</p>
|
| 618 |
+
</div>
|
| 619 |
+
</dd>
|
| 620 |
+
<dt class="hdlist1"><code>-A</code></dt>
|
| 621 |
+
<dt class="hdlist1"><code>--all</code></dt>
|
| 622 |
+
<dt class="hdlist1"><code>--no-ignore-removal</code></dt>
|
| 623 |
+
<dd>
|
| 624 |
+
<p>Update the index not only where the working tree has a file
|
| 625 |
+
matching <em><pathspec></em> but also where the index already has an
|
| 626 |
+
entry. This adds, modifies, and removes index entries to
|
| 627 |
+
match the working tree.</p>
|
| 628 |
+
<div class="paragraph">
|
| 629 |
+
<p>If no <em><pathspec></em> is given when <code>-A</code> option is used, all
|
| 630 |
+
files in the entire working tree are updated (old versions
|
| 631 |
+
of Git used to limit the update to the current directory and its
|
| 632 |
+
subdirectories).</p>
|
| 633 |
+
</div>
|
| 634 |
+
</dd>
|
| 635 |
+
<dt class="hdlist1"><code>--no-all</code></dt>
|
| 636 |
+
<dt class="hdlist1"><code>--ignore-removal</code></dt>
|
| 637 |
+
<dd>
|
| 638 |
+
<p>Update the index by adding new files that are unknown to the
|
| 639 |
+
index and files modified in the working tree, but ignore
|
| 640 |
+
files that have been removed from the working tree. This
|
| 641 |
+
option is a no-op when no <em><pathspec></em> is used.</p>
|
| 642 |
+
<div class="paragraph">
|
| 643 |
+
<p>This option is primarily to help users who are used to older
|
| 644 |
+
versions of Git, whose <code>git</code> <code>add</code> <em><pathspec></em>... was a synonym
|
| 645 |
+
for <code>git</code> <code>add</code> <code>--no-all</code> <em><pathspec></em>..., i.e. ignored removed files.</p>
|
| 646 |
+
</div>
|
| 647 |
+
</dd>
|
| 648 |
+
<dt class="hdlist1"><code>-N</code></dt>
|
| 649 |
+
<dt class="hdlist1"><code>--intent-to-add</code></dt>
|
| 650 |
+
<dd>
|
| 651 |
+
<p>Record only the fact that the path will be added later. An entry
|
| 652 |
+
for the path is placed in the index with no content. This is
|
| 653 |
+
useful for, among other things, showing the unstaged content of
|
| 654 |
+
such files with <code>git</code> <code>diff</code> and committing them with <code>git</code> <code>commit</code>
|
| 655 |
+
<code>-a</code>.</p>
|
| 656 |
+
</dd>
|
| 657 |
+
<dt class="hdlist1"><code>--refresh</code></dt>
|
| 658 |
+
<dd>
|
| 659 |
+
<p>Don’t add the file(s), but only refresh their stat()
|
| 660 |
+
information in the index.</p>
|
| 661 |
+
</dd>
|
| 662 |
+
<dt class="hdlist1"><code>--ignore-errors</code></dt>
|
| 663 |
+
<dd>
|
| 664 |
+
<p>If some files could not be added because of errors indexing
|
| 665 |
+
them, do not abort the operation, but continue adding the
|
| 666 |
+
others. The command shall still exit with non-zero status.
|
| 667 |
+
The configuration variable <code>add.ignoreErrors</code> can be set to
|
| 668 |
+
true to make this the default behaviour.</p>
|
| 669 |
+
</dd>
|
| 670 |
+
<dt class="hdlist1"><code>--ignore-missing</code></dt>
|
| 671 |
+
<dd>
|
| 672 |
+
<p>This option can only be used together with <code>--dry-run</code>. By using
|
| 673 |
+
this option the user can check if any of the given files would
|
| 674 |
+
be ignored, no matter if they are already present in the work
|
| 675 |
+
tree or not.</p>
|
| 676 |
+
</dd>
|
| 677 |
+
<dt class="hdlist1"><code>--no-warn-embedded-repo</code></dt>
|
| 678 |
+
<dd>
|
| 679 |
+
<p>By default, <code>git</code> <code>add</code> will warn when adding an embedded
|
| 680 |
+
repository to the index without using <code>git</code> <code>submodule</code> <code>add</code> to
|
| 681 |
+
create an entry in .<code>gitmodules</code>. This option will suppress the
|
| 682 |
+
warning (e.g., if you are manually performing operations on
|
| 683 |
+
submodules).</p>
|
| 684 |
+
</dd>
|
| 685 |
+
<dt class="hdlist1"><code>--renormalize</code></dt>
|
| 686 |
+
<dd>
|
| 687 |
+
<p>Apply the "clean" process freshly to all tracked files to
|
| 688 |
+
forcibly add them again to the index. This is useful after
|
| 689 |
+
changing <code>core.autocrlf</code> configuration or the <code>text</code> attribute
|
| 690 |
+
in order to correct files added with wrong <em>CRLF/LF</em> line endings.
|
| 691 |
+
This option implies <code>-u</code>. Lone CR characters are untouched, thus
|
| 692 |
+
while a <em>CRLF</em> cleans to <em>LF</em>, a <em>CRCRLF</em> sequence is only partially
|
| 693 |
+
cleaned to <em>CRLF</em>.</p>
|
| 694 |
+
</dd>
|
| 695 |
+
<dt class="hdlist1"><code>--chmod=</code>(<code>+</code>|<code>-</code>)<code>x</code></dt>
|
| 696 |
+
<dd>
|
| 697 |
+
<p>Override the executable bit of the added files. The executable
|
| 698 |
+
bit is only changed in the index, the files on disk are left
|
| 699 |
+
unchanged.</p>
|
| 700 |
+
</dd>
|
| 701 |
+
<dt class="hdlist1"><code>--pathspec-from-file=</code><em><file></em></dt>
|
| 702 |
+
<dd>
|
| 703 |
+
<p>Pathspec is passed in <em><file></em> instead of commandline args. If
|
| 704 |
+
<em><file></em> is exactly <code>-</code> then standard input is used. Pathspec
|
| 705 |
+
elements are separated by <em>LF</em> or <em>CR/LF</em>. Pathspec elements can be
|
| 706 |
+
quoted as explained for the configuration variable <code>core.quotePath</code>
|
| 707 |
+
(see <a href="git-config.html">git-config(1)</a>). See also <code>--pathspec-file-nul</code> and
|
| 708 |
+
global <code>--literal-pathspecs</code>.</p>
|
| 709 |
+
</dd>
|
| 710 |
+
<dt class="hdlist1"><code>--pathspec-file-nul</code></dt>
|
| 711 |
+
<dd>
|
| 712 |
+
<p>Only meaningful with <code>--pathspec-from-file</code>. Pathspec elements are
|
| 713 |
+
separated with <em>NUL</em> character and all other characters are taken
|
| 714 |
+
literally (including newlines and quotes).</p>
|
| 715 |
+
</dd>
|
| 716 |
+
<dt class="hdlist1"><code>--</code></dt>
|
| 717 |
+
<dd>
|
| 718 |
+
<p>This option can be used to separate command-line options from
|
| 719 |
+
the list of files, (useful when filenames might be mistaken
|
| 720 |
+
for command-line options).</p>
|
| 721 |
+
</dd>
|
| 722 |
+
</dl>
|
| 723 |
+
</div>
|
| 724 |
+
</div>
|
| 725 |
+
</div>
|
| 726 |
+
<div class="sect1">
|
| 727 |
+
<h2 id="_examples">EXAMPLES</h2>
|
| 728 |
+
<div class="sectionbody">
|
| 729 |
+
<div class="ulist">
|
| 730 |
+
<ul>
|
| 731 |
+
<li>
|
| 732 |
+
<p>Adds content from all <code>*.txt</code> files under <code>Documentation</code> directory
|
| 733 |
+
and its subdirectories:</p>
|
| 734 |
+
<div class="listingblock">
|
| 735 |
+
<div class="content">
|
| 736 |
+
<pre>$ git add Documentation/\*.txt</pre>
|
| 737 |
+
</div>
|
| 738 |
+
</div>
|
| 739 |
+
<div class="paragraph">
|
| 740 |
+
<p>Note that the asterisk <code>*</code> is quoted from the shell in this
|
| 741 |
+
example; this lets the command include the files from
|
| 742 |
+
subdirectories of <code>Documentation/</code> directory.</p>
|
| 743 |
+
</div>
|
| 744 |
+
</li>
|
| 745 |
+
<li>
|
| 746 |
+
<p>Considers adding content from all <code>git-*.sh</code> scripts:</p>
|
| 747 |
+
<div class="listingblock">
|
| 748 |
+
<div class="content">
|
| 749 |
+
<pre>$ git add git-*.sh</pre>
|
| 750 |
+
</div>
|
| 751 |
+
</div>
|
| 752 |
+
<div class="paragraph">
|
| 753 |
+
<p>Because this example lets the shell expand the asterisk (i.e. you are
|
| 754 |
+
listing the files explicitly), it does not consider
|
| 755 |
+
<code>subdir/git-foo.sh</code>.</p>
|
| 756 |
+
</div>
|
| 757 |
+
</li>
|
| 758 |
+
</ul>
|
| 759 |
+
</div>
|
| 760 |
+
</div>
|
| 761 |
+
</div>
|
| 762 |
+
<div class="sect1">
|
| 763 |
+
<h2 id="_interactive_mode">INTERACTIVE MODE</h2>
|
| 764 |
+
<div class="sectionbody">
|
| 765 |
+
<div class="paragraph">
|
| 766 |
+
<p>When the command enters the interactive mode, it shows the
|
| 767 |
+
output of the <em>status</em> subcommand, and then goes into its
|
| 768 |
+
interactive command loop.</p>
|
| 769 |
+
</div>
|
| 770 |
+
<div class="paragraph">
|
| 771 |
+
<p>The command loop shows the list of subcommands available, and
|
| 772 |
+
gives a prompt "What now> ". In general, when the prompt ends
|
| 773 |
+
with a single <em>></em>, you can pick only one of the choices given
|
| 774 |
+
and type return, like this:</p>
|
| 775 |
+
</div>
|
| 776 |
+
<div class="listingblock">
|
| 777 |
+
<div class="content">
|
| 778 |
+
<pre> *** Commands ***
|
| 779 |
+
1: status 2: update 3: revert 4: add untracked
|
| 780 |
+
5: patch 6: diff 7: quit 8: help
|
| 781 |
+
What now> 1</pre>
|
| 782 |
+
</div>
|
| 783 |
+
</div>
|
| 784 |
+
<div class="paragraph">
|
| 785 |
+
<p>You also could say <code>s</code> or <code>sta</code> or <code>status</code> above as long as the
|
| 786 |
+
choice is unique.</p>
|
| 787 |
+
</div>
|
| 788 |
+
<div class="paragraph">
|
| 789 |
+
<p>The main command loop has 6 subcommands (plus help and quit).</p>
|
| 790 |
+
</div>
|
| 791 |
+
<div class="dlist">
|
| 792 |
+
<dl>
|
| 793 |
+
<dt class="hdlist1">status</dt>
|
| 794 |
+
<dd>
|
| 795 |
+
<p>This shows the change between <code>HEAD</code> and index (i.e. what will be
|
| 796 |
+
committed if you say <code>git</code> <code>commit</code>), and between index and
|
| 797 |
+
working tree files (i.e. what you could stage further before
|
| 798 |
+
<code>git</code> <code>commit</code> using <code>git</code> <code>add</code>) for each path. A sample output
|
| 799 |
+
looks like this:</p>
|
| 800 |
+
<div class="listingblock">
|
| 801 |
+
<div class="content">
|
| 802 |
+
<pre> staged unstaged path
|
| 803 |
+
1: binary nothing foo.png
|
| 804 |
+
2: +403/-35 +1/-1 add-interactive.c</pre>
|
| 805 |
+
</div>
|
| 806 |
+
</div>
|
| 807 |
+
<div class="paragraph">
|
| 808 |
+
<p>It shows that <code>foo.png</code> has differences from <code>HEAD</code> (but that is
|
| 809 |
+
binary so line count cannot be shown) and there is no
|
| 810 |
+
difference between indexed copy and the working tree
|
| 811 |
+
version (if the working tree version were also different,
|
| 812 |
+
<em>binary</em> would have been shown in place of <em>nothing</em>). The
|
| 813 |
+
other file, <code>add-interactive.c</code>, has 403 lines added
|
| 814 |
+
and 35 lines deleted if you commit what is in the index, but
|
| 815 |
+
working tree file has further modifications (one addition and
|
| 816 |
+
one deletion).</p>
|
| 817 |
+
</div>
|
| 818 |
+
</dd>
|
| 819 |
+
<dt class="hdlist1">update</dt>
|
| 820 |
+
<dd>
|
| 821 |
+
<p>This shows the status information and issues an "Update>>"
|
| 822 |
+
prompt. When the prompt ends with double <em>>></em>, you can
|
| 823 |
+
make more than one selection, concatenated with whitespace or
|
| 824 |
+
comma. Also you can say ranges. E.g. "2-5 7,9" to choose
|
| 825 |
+
2,3,4,5,7,9 from the list. If the second number in a range is
|
| 826 |
+
omitted, all remaining patches are taken. E.g. "7-" to choose
|
| 827 |
+
7,8,9 from the list. You can say <em>*</em> to choose everything.</p>
|
| 828 |
+
<div class="paragraph">
|
| 829 |
+
<p>What you chose are then highlighted with <em>*</em>,
|
| 830 |
+
like this:</p>
|
| 831 |
+
</div>
|
| 832 |
+
<div class="listingblock">
|
| 833 |
+
<div class="content">
|
| 834 |
+
<pre> staged unstaged path
|
| 835 |
+
1: binary nothing foo.png
|
| 836 |
+
* 2: +403/-35 +1/-1 add-interactive.c</pre>
|
| 837 |
+
</div>
|
| 838 |
+
</div>
|
| 839 |
+
<div class="paragraph">
|
| 840 |
+
<p>To remove selection, prefix the input with <code>-</code>
|
| 841 |
+
like this:</p>
|
| 842 |
+
</div>
|
| 843 |
+
<div class="listingblock">
|
| 844 |
+
<div class="content">
|
| 845 |
+
<pre>Update>> -2</pre>
|
| 846 |
+
</div>
|
| 847 |
+
</div>
|
| 848 |
+
<div class="paragraph">
|
| 849 |
+
<p>After making the selection, answer with an empty line to stage the
|
| 850 |
+
contents of working tree files for selected paths in the index.</p>
|
| 851 |
+
</div>
|
| 852 |
+
</dd>
|
| 853 |
+
<dt class="hdlist1">revert</dt>
|
| 854 |
+
<dd>
|
| 855 |
+
<p>This has a very similar UI to <em>update</em>, and the staged
|
| 856 |
+
information for selected paths are reverted to that of the
|
| 857 |
+
HEAD version. Reverting new paths makes them untracked.</p>
|
| 858 |
+
</dd>
|
| 859 |
+
<dt class="hdlist1">add untracked</dt>
|
| 860 |
+
<dd>
|
| 861 |
+
<p>This has a very similar UI to <em>update</em> and
|
| 862 |
+
<em>revert</em>, and lets you add untracked paths to the index.</p>
|
| 863 |
+
</dd>
|
| 864 |
+
<dt class="hdlist1">patch</dt>
|
| 865 |
+
<dd>
|
| 866 |
+
<p>This lets you choose one path out of a <em>status</em> like selection.
|
| 867 |
+
After choosing the path, it presents the diff between the index
|
| 868 |
+
and the working tree file and asks you if you want to stage
|
| 869 |
+
the change of each hunk. You can select one of the following
|
| 870 |
+
options and type return:</p>
|
| 871 |
+
<div class="literalblock">
|
| 872 |
+
<div class="content">
|
| 873 |
+
<pre>y - stage this hunk
|
| 874 |
+
n - do not stage this hunk
|
| 875 |
+
q - quit; do not stage this hunk or any of the remaining ones
|
| 876 |
+
a - stage this hunk and all later hunks in the file
|
| 877 |
+
d - do not stage this hunk or any of the later hunks in the file
|
| 878 |
+
g - select a hunk to go to
|
| 879 |
+
/ - search for a hunk matching the given regex
|
| 880 |
+
j - go to the next undecided hunk, roll over at the bottom
|
| 881 |
+
J - go to the next hunk, roll over at the bottom
|
| 882 |
+
k - go to the previous undecided hunk, roll over at the top
|
| 883 |
+
K - go to the previous hunk, roll over at the top
|
| 884 |
+
s - split the current hunk into smaller hunks
|
| 885 |
+
e - manually edit the current hunk
|
| 886 |
+
p - print the current hunk
|
| 887 |
+
P - print the current hunk using the pager
|
| 888 |
+
? - print help</pre>
|
| 889 |
+
</div>
|
| 890 |
+
</div>
|
| 891 |
+
<div class="paragraph">
|
| 892 |
+
<p>After deciding the fate for all hunks, if there is any hunk
|
| 893 |
+
that was chosen, the index is updated with the selected hunks.</p>
|
| 894 |
+
</div>
|
| 895 |
+
<div class="paragraph">
|
| 896 |
+
<p>You can omit having to type return here, by setting the configuration
|
| 897 |
+
variable <code>interactive.singleKey</code> to <code>true</code>.</p>
|
| 898 |
+
</div>
|
| 899 |
+
</dd>
|
| 900 |
+
<dt class="hdlist1">diff</dt>
|
| 901 |
+
<dd>
|
| 902 |
+
<p>This lets you review what will be committed (i.e. between
|
| 903 |
+
<code>HEAD</code> and index).</p>
|
| 904 |
+
</dd>
|
| 905 |
+
</dl>
|
| 906 |
+
</div>
|
| 907 |
+
</div>
|
| 908 |
+
</div>
|
| 909 |
+
<div class="sect1">
|
| 910 |
+
<h2 id="_editing_patches">EDITING PATCHES</h2>
|
| 911 |
+
<div class="sectionbody">
|
| 912 |
+
<div class="paragraph">
|
| 913 |
+
<p>Invoking <code>git</code> <code>add</code> <code>-e</code> or selecting <code>e</code> from the interactive hunk
|
| 914 |
+
selector will open a patch in your editor; after the editor exits, the
|
| 915 |
+
result is applied to the index. You are free to make arbitrary changes
|
| 916 |
+
to the patch, but note that some changes may have confusing results, or
|
| 917 |
+
even result in a patch that cannot be applied. If you want to abort the
|
| 918 |
+
operation entirely (i.e., stage nothing new in the index), simply delete
|
| 919 |
+
all lines of the patch. The list below describes some common things you
|
| 920 |
+
may see in a patch, and which editing operations make sense on them.</p>
|
| 921 |
+
</div>
|
| 922 |
+
<div class="openblock">
|
| 923 |
+
<div class="content">
|
| 924 |
+
<div class="dlist">
|
| 925 |
+
<dl>
|
| 926 |
+
<dt class="hdlist1">added content</dt>
|
| 927 |
+
<dd>
|
| 928 |
+
<p>Added content is represented by lines beginning with "+". You can
|
| 929 |
+
prevent staging any addition lines by deleting them.</p>
|
| 930 |
+
</dd>
|
| 931 |
+
<dt class="hdlist1">removed content</dt>
|
| 932 |
+
<dd>
|
| 933 |
+
<p>Removed content is represented by lines beginning with "-". You can
|
| 934 |
+
prevent staging their removal by converting the "-" to a " " (space).</p>
|
| 935 |
+
</dd>
|
| 936 |
+
<dt class="hdlist1">modified content</dt>
|
| 937 |
+
<dd>
|
| 938 |
+
<p>Modified content is represented by "-" lines (removing the old content)
|
| 939 |
+
followed by "+" lines (adding the replacement content). You can
|
| 940 |
+
prevent staging the modification by converting "-" lines to " ", and
|
| 941 |
+
removing "+" lines. Beware that modifying only half of the pair is
|
| 942 |
+
likely to introduce confusing changes to the index.</p>
|
| 943 |
+
</dd>
|
| 944 |
+
</dl>
|
| 945 |
+
</div>
|
| 946 |
+
</div>
|
| 947 |
+
</div>
|
| 948 |
+
<div class="paragraph">
|
| 949 |
+
<p>There are also more complex operations that can be performed. But beware
|
| 950 |
+
that because the patch is applied only to the index and not the working
|
| 951 |
+
tree, the working tree will appear to "undo" the change in the index.
|
| 952 |
+
For example, introducing a new line into the index that is in neither
|
| 953 |
+
the <code>HEAD</code> nor the working tree will stage the new line for commit, but
|
| 954 |
+
the line will appear to be reverted in the working tree.</p>
|
| 955 |
+
</div>
|
| 956 |
+
<div class="paragraph">
|
| 957 |
+
<p>Avoid using these constructs, or do so with extreme caution.</p>
|
| 958 |
+
</div>
|
| 959 |
+
<div class="openblock">
|
| 960 |
+
<div class="content">
|
| 961 |
+
<div class="dlist">
|
| 962 |
+
<dl>
|
| 963 |
+
<dt class="hdlist1">removing untouched content</dt>
|
| 964 |
+
<dd>
|
| 965 |
+
<p>Content which does not differ between the index and working tree may be
|
| 966 |
+
shown on context lines, beginning with a " " (space). You can stage
|
| 967 |
+
context lines for removal by converting the space to a "-". The
|
| 968 |
+
resulting working tree file will appear to re-add the content.</p>
|
| 969 |
+
</dd>
|
| 970 |
+
<dt class="hdlist1">modifying existing content</dt>
|
| 971 |
+
<dd>
|
| 972 |
+
<p>One can also modify context lines by staging them for removal (by
|
| 973 |
+
converting " " to "-") and adding a "+" line with the new content.
|
| 974 |
+
Similarly, one can modify "+" lines for existing additions or
|
| 975 |
+
modifications. In all cases, the new modification will appear reverted
|
| 976 |
+
in the working tree.</p>
|
| 977 |
+
</dd>
|
| 978 |
+
<dt class="hdlist1">new content</dt>
|
| 979 |
+
<dd>
|
| 980 |
+
<p>You may also add new content that does not exist in the patch; simply
|
| 981 |
+
add new lines, each starting with "+". The addition will appear
|
| 982 |
+
reverted in the working tree.</p>
|
| 983 |
+
</dd>
|
| 984 |
+
</dl>
|
| 985 |
+
</div>
|
| 986 |
+
</div>
|
| 987 |
+
</div>
|
| 988 |
+
<div class="paragraph">
|
| 989 |
+
<p>There are also several operations which should be avoided entirely, as
|
| 990 |
+
they will make the patch impossible to apply:</p>
|
| 991 |
+
</div>
|
| 992 |
+
<div class="ulist">
|
| 993 |
+
<ul>
|
| 994 |
+
<li>
|
| 995 |
+
<p>adding context (" ") or removal ("-") lines</p>
|
| 996 |
+
</li>
|
| 997 |
+
<li>
|
| 998 |
+
<p>deleting context or removal lines</p>
|
| 999 |
+
</li>
|
| 1000 |
+
<li>
|
| 1001 |
+
<p>modifying the contents of context or removal lines</p>
|
| 1002 |
+
</li>
|
| 1003 |
+
</ul>
|
| 1004 |
+
</div>
|
| 1005 |
+
</div>
|
| 1006 |
+
</div>
|
| 1007 |
+
<div class="sect1">
|
| 1008 |
+
<h2 id="_configuration">CONFIGURATION</h2>
|
| 1009 |
+
<div class="sectionbody">
|
| 1010 |
+
<div class="paragraph">
|
| 1011 |
+
<p>Everything below this line in this section is selectively included
|
| 1012 |
+
from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
|
| 1013 |
+
as what’s found there:</p>
|
| 1014 |
+
</div>
|
| 1015 |
+
<div class="dlist">
|
| 1016 |
+
<dl>
|
| 1017 |
+
<dt class="hdlist1"><code>add.ignoreErrors</code></dt>
|
| 1018 |
+
<dt class="hdlist1"><code>add.ignore-errors</code> (deprecated)</dt>
|
| 1019 |
+
<dd>
|
| 1020 |
+
<p>Tells <code>git</code> <code>add</code> to continue adding files when some files cannot be
|
| 1021 |
+
added due to indexing errors.
|
| 1022 |
+
Equivalent to the <code>--ignore-errors</code> option.
|
| 1023 |
+
<code>add.ignore-errors</code> is deprecated, as it does not follow the usual
|
| 1024 |
+
naming convention for configuration variables.</p>
|
| 1025 |
+
</dd>
|
| 1026 |
+
</dl>
|
| 1027 |
+
</div>
|
| 1028 |
+
</div>
|
| 1029 |
+
</div>
|
| 1030 |
+
<div class="sect1">
|
| 1031 |
+
<h2 id="_see_also">SEE ALSO</h2>
|
| 1032 |
+
<div class="sectionbody">
|
| 1033 |
+
<div class="paragraph">
|
| 1034 |
+
<p><a href="git-status.html">git-status(1)</a>
|
| 1035 |
+
<a href="git-rm.html">git-rm(1)</a>
|
| 1036 |
+
<a href="git-reset.html">git-reset(1)</a>
|
| 1037 |
+
<a href="git-mv.html">git-mv(1)</a>
|
| 1038 |
+
<a href="git-commit.html">git-commit(1)</a>
|
| 1039 |
+
<a href="git-update-index.html">git-update-index(1)</a></p>
|
| 1040 |
+
</div>
|
| 1041 |
+
</div>
|
| 1042 |
+
</div>
|
| 1043 |
+
<div class="sect1">
|
| 1044 |
+
<h2 id="_git">GIT</h2>
|
| 1045 |
+
<div class="sectionbody">
|
| 1046 |
+
<div class="paragraph">
|
| 1047 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 1048 |
+
</div>
|
| 1049 |
+
</div>
|
| 1050 |
+
</div>
|
| 1051 |
+
</div>
|
| 1052 |
+
<div id="footer">
|
| 1053 |
+
<div id="footer-text">
|
| 1054 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 1055 |
+
</div>
|
| 1056 |
+
</div>
|
| 1057 |
+
</body>
|
| 1058 |
+
</html>
|
git/mingw64/share/doc/git-doc/git-am.adoc
ADDED
|
@@ -0,0 +1,316 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-am(1)
|
| 2 |
+
=========
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-am - Apply a series of patches from a mailbox
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
SYNOPSIS
|
| 10 |
+
--------
|
| 11 |
+
[verse]
|
| 12 |
+
'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--[no-]verify]
|
| 13 |
+
[--[no-]3way] [--interactive] [--committer-date-is-author-date]
|
| 14 |
+
[--ignore-date] [--ignore-space-change | --ignore-whitespace]
|
| 15 |
+
[--whitespace=<action>] [-C<n>] [-p<n>] [--directory=<dir>]
|
| 16 |
+
[--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
|
| 17 |
+
[--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>]
|
| 18 |
+
[--quoted-cr=<action>]
|
| 19 |
+
[--empty=(stop|drop|keep)]
|
| 20 |
+
[(<mbox> | <Maildir>)...]
|
| 21 |
+
'git am' (--continue | --skip | --abort | --quit | --retry | --show-current-patch[=(diff|raw)] | --allow-empty)
|
| 22 |
+
|
| 23 |
+
DESCRIPTION
|
| 24 |
+
-----------
|
| 25 |
+
Splits mail messages in a mailbox into commit log messages,
|
| 26 |
+
authorship information, and patches, and applies them to the
|
| 27 |
+
current branch. You could think of it as a reverse operation
|
| 28 |
+
of linkgit:git-format-patch[1] run on a branch with a straight
|
| 29 |
+
history without merges.
|
| 30 |
+
|
| 31 |
+
OPTIONS
|
| 32 |
+
-------
|
| 33 |
+
(<mbox>|<Maildir>)...::
|
| 34 |
+
The list of mailbox files to read patches from. If you do not
|
| 35 |
+
supply this argument, the command reads from the standard input.
|
| 36 |
+
If you supply directories, they will be treated as Maildirs.
|
| 37 |
+
|
| 38 |
+
-s::
|
| 39 |
+
--signoff::
|
| 40 |
+
Add a `Signed-off-by` trailer to the commit message (see
|
| 41 |
+
linkgit:git-interpret-trailers[1]), using the committer identity
|
| 42 |
+
of yourself. See the signoff option in linkgit:git-commit[1]
|
| 43 |
+
for more information.
|
| 44 |
+
|
| 45 |
+
-k::
|
| 46 |
+
--keep::
|
| 47 |
+
Pass `-k` flag to linkgit:git-mailinfo[1].
|
| 48 |
+
|
| 49 |
+
--keep-non-patch::
|
| 50 |
+
Pass `-b` flag to linkgit:git-mailinfo[1].
|
| 51 |
+
|
| 52 |
+
--keep-cr::
|
| 53 |
+
--no-keep-cr::
|
| 54 |
+
With `--keep-cr`, call linkgit:git-mailsplit[1]
|
| 55 |
+
with the same option, to prevent it from stripping CR at the end of
|
| 56 |
+
lines. `am.keepcr` configuration variable can be used to specify the
|
| 57 |
+
default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
|
| 58 |
+
|
| 59 |
+
-c::
|
| 60 |
+
--scissors::
|
| 61 |
+
Remove everything in body before a scissors line (see
|
| 62 |
+
linkgit:git-mailinfo[1]). Can be activated by default using
|
| 63 |
+
the `mailinfo.scissors` configuration variable.
|
| 64 |
+
|
| 65 |
+
--no-scissors::
|
| 66 |
+
Ignore scissors lines (see linkgit:git-mailinfo[1]).
|
| 67 |
+
|
| 68 |
+
--quoted-cr=<action>::
|
| 69 |
+
This flag will be passed down to linkgit:git-mailinfo[1].
|
| 70 |
+
|
| 71 |
+
--empty=(drop|keep|stop)::
|
| 72 |
+
How to handle an e-mail message lacking a patch:
|
| 73 |
+
+
|
| 74 |
+
--
|
| 75 |
+
`drop`;;
|
| 76 |
+
The e-mail message will be skipped.
|
| 77 |
+
`keep`;;
|
| 78 |
+
An empty commit will be created, with the contents of the e-mail
|
| 79 |
+
message as its log.
|
| 80 |
+
`stop`;;
|
| 81 |
+
The command will fail, stopping in the middle of the current `am`
|
| 82 |
+
session. This is the default behavior.
|
| 83 |
+
--
|
| 84 |
+
|
| 85 |
+
-m::
|
| 86 |
+
--message-id::
|
| 87 |
+
Pass the `-m` flag to linkgit:git-mailinfo[1],
|
| 88 |
+
so that the `Message-ID` header is added to the commit message.
|
| 89 |
+
The `am.messageid` configuration variable can be used to specify
|
| 90 |
+
the default behaviour.
|
| 91 |
+
|
| 92 |
+
--no-message-id::
|
| 93 |
+
Do not add the Message-ID header to the commit message.
|
| 94 |
+
`--no-message-id` is useful to override `am.messageid`.
|
| 95 |
+
|
| 96 |
+
-q::
|
| 97 |
+
--quiet::
|
| 98 |
+
Be quiet. Only print error messages.
|
| 99 |
+
|
| 100 |
+
-u::
|
| 101 |
+
--utf8::
|
| 102 |
+
Pass `-u` flag to linkgit:git-mailinfo[1].
|
| 103 |
+
The proposed commit log message taken from the e-mail
|
| 104 |
+
is re-coded into UTF-8 encoding (configuration variable
|
| 105 |
+
`i18n.commitEncoding` can be used to specify the project's
|
| 106 |
+
preferred encoding if it is not UTF-8).
|
| 107 |
+
+
|
| 108 |
+
This was optional in prior versions of git, but now it is the
|
| 109 |
+
default. You can use `--no-utf8` to override this.
|
| 110 |
+
|
| 111 |
+
--no-utf8::
|
| 112 |
+
Pass `-n` flag to linkgit:git-mailinfo[1].
|
| 113 |
+
|
| 114 |
+
-3::
|
| 115 |
+
--3way::
|
| 116 |
+
--no-3way::
|
| 117 |
+
When the patch does not apply cleanly, fall back on
|
| 118 |
+
3-way merge if the patch records the identity of blobs
|
| 119 |
+
it is supposed to apply to and we have those blobs
|
| 120 |
+
available locally. `--no-3way` can be used to override
|
| 121 |
+
am.threeWay configuration variable. For more information,
|
| 122 |
+
see am.threeWay in linkgit:git-config[1].
|
| 123 |
+
|
| 124 |
+
include::rerere-options.adoc[]
|
| 125 |
+
|
| 126 |
+
--ignore-space-change::
|
| 127 |
+
--ignore-whitespace::
|
| 128 |
+
--whitespace=<action>::
|
| 129 |
+
-C<n>::
|
| 130 |
+
-p<n>::
|
| 131 |
+
--directory=<dir>::
|
| 132 |
+
--exclude=<path>::
|
| 133 |
+
--include=<path>::
|
| 134 |
+
--reject::
|
| 135 |
+
These flags are passed to the linkgit:git-apply[1] program that
|
| 136 |
+
applies the patch.
|
| 137 |
+
+
|
| 138 |
+
Valid <action> for the `--whitespace` option are:
|
| 139 |
+
`nowarn`, `warn`, `fix`, `error`, and `error-all`.
|
| 140 |
+
|
| 141 |
+
--patch-format::
|
| 142 |
+
By default the command will try to detect the patch format
|
| 143 |
+
automatically. This option allows the user to bypass the automatic
|
| 144 |
+
detection and specify the patch format that the patch(es) should be
|
| 145 |
+
interpreted as. Valid formats are mbox, mboxrd,
|
| 146 |
+
stgit, stgit-series, and hg.
|
| 147 |
+
|
| 148 |
+
-i::
|
| 149 |
+
--interactive::
|
| 150 |
+
Run interactively.
|
| 151 |
+
|
| 152 |
+
--verify::
|
| 153 |
+
-n::
|
| 154 |
+
--no-verify::
|
| 155 |
+
Run the `pre-applypatch` and `applypatch-msg` hooks. This is the
|
| 156 |
+
default. Skip these hooks with `-n` or `--no-verify`. See also
|
| 157 |
+
linkgit:githooks[5].
|
| 158 |
+
+
|
| 159 |
+
Note that `post-applypatch` cannot be skipped.
|
| 160 |
+
|
| 161 |
+
--committer-date-is-author-date::
|
| 162 |
+
By default the command records the date from the e-mail
|
| 163 |
+
message as the commit author date, and uses the time of
|
| 164 |
+
commit creation as the committer date. This allows the
|
| 165 |
+
user to lie about the committer date by using the same
|
| 166 |
+
value as the author date.
|
| 167 |
+
+
|
| 168 |
+
WARNING: The history walking machinery assumes that commits have
|
| 169 |
+
non-decreasing commit timestamps. You should consider if you really need
|
| 170 |
+
to use this option. Then you should only use this option to override the
|
| 171 |
+
committer date when applying commits on top of a base which commit is
|
| 172 |
+
older (in terms of the commit date) than the oldest patch you are
|
| 173 |
+
applying.
|
| 174 |
+
|
| 175 |
+
--ignore-date::
|
| 176 |
+
By default the command records the date from the e-mail
|
| 177 |
+
message as the commit author date, and uses the time of
|
| 178 |
+
commit creation as the committer date. This allows the
|
| 179 |
+
user to lie about the author date by using the same
|
| 180 |
+
value as the committer date.
|
| 181 |
+
|
| 182 |
+
--skip::
|
| 183 |
+
Skip the current patch. This is only meaningful when
|
| 184 |
+
restarting an aborted patch.
|
| 185 |
+
|
| 186 |
+
-S[<keyid>]::
|
| 187 |
+
--gpg-sign[=<keyid>]::
|
| 188 |
+
--no-gpg-sign::
|
| 189 |
+
GPG-sign commits. The `keyid` argument is optional and
|
| 190 |
+
defaults to the committer identity; if specified, it must be
|
| 191 |
+
stuck to the option without a space. `--no-gpg-sign` is useful to
|
| 192 |
+
countermand both `commit.gpgSign` configuration variable, and
|
| 193 |
+
earlier `--gpg-sign`.
|
| 194 |
+
|
| 195 |
+
--continue::
|
| 196 |
+
-r::
|
| 197 |
+
--resolved::
|
| 198 |
+
After a patch failure (e.g. attempting to apply
|
| 199 |
+
conflicting patch), the user has applied it by hand and
|
| 200 |
+
the index file stores the result of the application.
|
| 201 |
+
Make a commit using the authorship and commit log
|
| 202 |
+
extracted from the e-mail message and the current index
|
| 203 |
+
file, and continue.
|
| 204 |
+
|
| 205 |
+
--resolvemsg=<msg>::
|
| 206 |
+
When a patch failure occurs, <msg> will be printed
|
| 207 |
+
to the screen before exiting. This overrides the
|
| 208 |
+
standard message informing you to use `--continue`
|
| 209 |
+
or `--skip` to handle the failure. This is solely
|
| 210 |
+
for internal use between linkgit:git-rebase[1] and
|
| 211 |
+
linkgit:git-am[1].
|
| 212 |
+
|
| 213 |
+
--abort::
|
| 214 |
+
Restore the original branch and abort the patching operation.
|
| 215 |
+
Revert the contents of files involved in the am operation to their
|
| 216 |
+
pre-am state.
|
| 217 |
+
|
| 218 |
+
--quit::
|
| 219 |
+
Abort the patching operation but keep HEAD and the index
|
| 220 |
+
untouched.
|
| 221 |
+
|
| 222 |
+
--retry::
|
| 223 |
+
Try to apply the last conflicting patch again. This is generally
|
| 224 |
+
only useful for passing extra options to the retry attempt
|
| 225 |
+
(e.g., `--3way`), since otherwise you'll just see the same
|
| 226 |
+
failure again.
|
| 227 |
+
|
| 228 |
+
--show-current-patch[=(diff|raw)]::
|
| 229 |
+
Show the message at which linkgit:git-am[1] has stopped due to
|
| 230 |
+
conflicts. If `raw` is specified, show the raw contents of
|
| 231 |
+
the e-mail message; if `diff`, show the diff portion only.
|
| 232 |
+
Defaults to `raw`.
|
| 233 |
+
|
| 234 |
+
--allow-empty::
|
| 235 |
+
After a patch failure on an input e-mail message lacking a patch,
|
| 236 |
+
create an empty commit with the contents of the e-mail message
|
| 237 |
+
as its log message.
|
| 238 |
+
|
| 239 |
+
[[discussion]]
|
| 240 |
+
DISCUSSION
|
| 241 |
+
----------
|
| 242 |
+
|
| 243 |
+
The commit author name is taken from the "From: " line of the
|
| 244 |
+
message, and commit author date is taken from the "Date: " line
|
| 245 |
+
of the message. The "Subject: " line is used as the title of
|
| 246 |
+
the commit, after stripping common prefix "[PATCH <anything>]".
|
| 247 |
+
The "Subject: " line is supposed to concisely describe what the
|
| 248 |
+
commit is about in one line of text.
|
| 249 |
+
|
| 250 |
+
"From: ", "Date: ", and "Subject: " lines starting the body override the
|
| 251 |
+
respective commit author name and title values taken from the headers.
|
| 252 |
+
|
| 253 |
+
The commit message is formed by the title taken from the
|
| 254 |
+
"Subject: ", a blank line and the body of the message up to
|
| 255 |
+
where the patch begins. Excess whitespace at the end of each
|
| 256 |
+
line is automatically stripped.
|
| 257 |
+
|
| 258 |
+
The patch is expected to be inline, directly following the
|
| 259 |
+
message.
|
| 260 |
+
include::format-patch-end-of-commit-message.adoc[]
|
| 261 |
+
|
| 262 |
+
This means that the contents of the commit message can inadvertently
|
| 263 |
+
interrupt the processing (see the <<caveats,CAVEATS>> section below).
|
| 264 |
+
|
| 265 |
+
When initially invoking linkgit:git-am[1], you give it the names of the mailboxes
|
| 266 |
+
to process. Upon seeing the first patch that does not apply, it
|
| 267 |
+
aborts in the middle. You can recover from this in one of two ways:
|
| 268 |
+
|
| 269 |
+
. skip the current patch by re-running the command with the `--skip`
|
| 270 |
+
option.
|
| 271 |
+
|
| 272 |
+
. hand resolve the conflict in the working directory, and update
|
| 273 |
+
the index file to bring it into a state that the patch should
|
| 274 |
+
have produced. Then run the command with the `--continue` option.
|
| 275 |
+
|
| 276 |
+
The command refuses to process new mailboxes until the current
|
| 277 |
+
operation is finished, so if you decide to start over from scratch,
|
| 278 |
+
run `git am --abort` before running the command with mailbox
|
| 279 |
+
names.
|
| 280 |
+
|
| 281 |
+
Before any patches are applied, ORIG_HEAD is set to the tip of the
|
| 282 |
+
current branch. This is useful if you have problems with multiple
|
| 283 |
+
commits, like running linkgit:git-am[1] on the wrong branch or an error
|
| 284 |
+
in the commits that is more easily fixed by changing the mailbox (e.g.
|
| 285 |
+
errors in the "From:" lines).
|
| 286 |
+
|
| 287 |
+
[[caveats]]
|
| 288 |
+
CAVEATS
|
| 289 |
+
-------
|
| 290 |
+
|
| 291 |
+
:git-am: 1
|
| 292 |
+
include::format-patch-caveats.adoc[]
|
| 293 |
+
|
| 294 |
+
HOOKS
|
| 295 |
+
-----
|
| 296 |
+
This command can run `applypatch-msg`, `pre-applypatch`,
|
| 297 |
+
and `post-applypatch` hooks. See linkgit:githooks[5] for more
|
| 298 |
+
information.
|
| 299 |
+
|
| 300 |
+
See the `--verify`/`-n`/`--no-verify` options.
|
| 301 |
+
|
| 302 |
+
CONFIGURATION
|
| 303 |
+
-------------
|
| 304 |
+
|
| 305 |
+
include::includes/cmd-config-section-all.adoc[]
|
| 306 |
+
|
| 307 |
+
include::config/am.adoc[]
|
| 308 |
+
|
| 309 |
+
SEE ALSO
|
| 310 |
+
--------
|
| 311 |
+
linkgit:git-apply[1],
|
| 312 |
+
linkgit:git-format-patch[1].
|
| 313 |
+
|
| 314 |
+
GIT
|
| 315 |
+
---
|
| 316 |
+
Part of the linkgit:git[1] suite
|
git/mingw64/share/doc/git-doc/git-am.html
ADDED
|
@@ -0,0 +1,951 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-am(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-am(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-am - Apply a series of patches from a mailbox</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content"><em>git am</em> [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--[no-]verify]
|
| 456 |
+
[--[no-]3way] [--interactive] [--committer-date-is-author-date]
|
| 457 |
+
[--ignore-date] [--ignore-space-change | --ignore-whitespace]
|
| 458 |
+
[--whitespace=<action>] [-C<n>] [-p<n>] [--directory=<dir>]
|
| 459 |
+
[--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
|
| 460 |
+
[--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>]
|
| 461 |
+
[--quoted-cr=<action>]
|
| 462 |
+
[--empty=(stop|drop|keep)]
|
| 463 |
+
[(<mbox> | <Maildir>)…​]
|
| 464 |
+
<em>git am</em> (--continue | --skip | --abort | --quit | --retry | --show-current-patch[=(diff|raw)] | --allow-empty)</pre>
|
| 465 |
+
</div>
|
| 466 |
+
</div>
|
| 467 |
+
</div>
|
| 468 |
+
<div class="sect1">
|
| 469 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 470 |
+
<div class="sectionbody">
|
| 471 |
+
<div class="paragraph">
|
| 472 |
+
<p>Splits mail messages in a mailbox into commit log messages,
|
| 473 |
+
authorship information, and patches, and applies them to the
|
| 474 |
+
current branch. You could think of it as a reverse operation
|
| 475 |
+
of <a href="git-format-patch.html">git-format-patch(1)</a> run on a branch with a straight
|
| 476 |
+
history without merges.</p>
|
| 477 |
+
</div>
|
| 478 |
+
</div>
|
| 479 |
+
</div>
|
| 480 |
+
<div class="sect1">
|
| 481 |
+
<h2 id="_options">OPTIONS</h2>
|
| 482 |
+
<div class="sectionbody">
|
| 483 |
+
<div class="dlist">
|
| 484 |
+
<dl>
|
| 485 |
+
<dt class="hdlist1">(<mbox>|<Maildir>)…​</dt>
|
| 486 |
+
<dd>
|
| 487 |
+
<p>The list of mailbox files to read patches from. If you do not
|
| 488 |
+
supply this argument, the command reads from the standard input.
|
| 489 |
+
If you supply directories, they will be treated as Maildirs.</p>
|
| 490 |
+
</dd>
|
| 491 |
+
<dt class="hdlist1">-s</dt>
|
| 492 |
+
<dt class="hdlist1">--signoff</dt>
|
| 493 |
+
<dd>
|
| 494 |
+
<p>Add a <code>Signed-off-by</code> trailer to the commit message (see
|
| 495 |
+
<a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>), using the committer identity
|
| 496 |
+
of yourself. See the signoff option in <a href="git-commit.html">git-commit(1)</a>
|
| 497 |
+
for more information.</p>
|
| 498 |
+
</dd>
|
| 499 |
+
<dt class="hdlist1">-k</dt>
|
| 500 |
+
<dt class="hdlist1">--keep</dt>
|
| 501 |
+
<dd>
|
| 502 |
+
<p>Pass <code>-k</code> flag to <a href="git-mailinfo.html">git-mailinfo(1)</a>.</p>
|
| 503 |
+
</dd>
|
| 504 |
+
<dt class="hdlist1">--keep-non-patch</dt>
|
| 505 |
+
<dd>
|
| 506 |
+
<p>Pass <code>-b</code> flag to <a href="git-mailinfo.html">git-mailinfo(1)</a>.</p>
|
| 507 |
+
</dd>
|
| 508 |
+
<dt class="hdlist1">--keep-cr</dt>
|
| 509 |
+
<dt class="hdlist1">--no-keep-cr</dt>
|
| 510 |
+
<dd>
|
| 511 |
+
<p>With <code>--keep-cr</code>, call <a href="git-mailsplit.html">git-mailsplit(1)</a>
|
| 512 |
+
with the same option, to prevent it from stripping CR at the end of
|
| 513 |
+
lines. <code>am.keepcr</code> configuration variable can be used to specify the
|
| 514 |
+
default behaviour. <code>--no-keep-cr</code> is useful to override <code>am.keepcr</code>.</p>
|
| 515 |
+
</dd>
|
| 516 |
+
<dt class="hdlist1">-c</dt>
|
| 517 |
+
<dt class="hdlist1">--scissors</dt>
|
| 518 |
+
<dd>
|
| 519 |
+
<p>Remove everything in body before a scissors line (see
|
| 520 |
+
<a href="git-mailinfo.html">git-mailinfo(1)</a>). Can be activated by default using
|
| 521 |
+
the <code>mailinfo.scissors</code> configuration variable.</p>
|
| 522 |
+
</dd>
|
| 523 |
+
<dt class="hdlist1">--no-scissors</dt>
|
| 524 |
+
<dd>
|
| 525 |
+
<p>Ignore scissors lines (see <a href="git-mailinfo.html">git-mailinfo(1)</a>).</p>
|
| 526 |
+
</dd>
|
| 527 |
+
<dt class="hdlist1">--quoted-cr=<action></dt>
|
| 528 |
+
<dd>
|
| 529 |
+
<p>This flag will be passed down to <a href="git-mailinfo.html">git-mailinfo(1)</a>.</p>
|
| 530 |
+
</dd>
|
| 531 |
+
<dt class="hdlist1">--empty=(drop|keep|stop)</dt>
|
| 532 |
+
<dd>
|
| 533 |
+
<p>How to handle an e-mail message lacking a patch:</p>
|
| 534 |
+
<div class="openblock">
|
| 535 |
+
<div class="content">
|
| 536 |
+
<div class="dlist">
|
| 537 |
+
<dl>
|
| 538 |
+
<dt class="hdlist1"><code>drop</code></dt>
|
| 539 |
+
<dd>
|
| 540 |
+
<p>The e-mail message will be skipped.</p>
|
| 541 |
+
</dd>
|
| 542 |
+
<dt class="hdlist1"><code>keep</code></dt>
|
| 543 |
+
<dd>
|
| 544 |
+
<p>An empty commit will be created, with the contents of the e-mail
|
| 545 |
+
message as its log.</p>
|
| 546 |
+
</dd>
|
| 547 |
+
<dt class="hdlist1"><code>stop</code></dt>
|
| 548 |
+
<dd>
|
| 549 |
+
<p>The command will fail, stopping in the middle of the current <code>am</code>
|
| 550 |
+
session. This is the default behavior.</p>
|
| 551 |
+
</dd>
|
| 552 |
+
</dl>
|
| 553 |
+
</div>
|
| 554 |
+
</div>
|
| 555 |
+
</div>
|
| 556 |
+
</dd>
|
| 557 |
+
<dt class="hdlist1">-m</dt>
|
| 558 |
+
<dt class="hdlist1">--message-id</dt>
|
| 559 |
+
<dd>
|
| 560 |
+
<p>Pass the <code>-m</code> flag to <a href="git-mailinfo.html">git-mailinfo(1)</a>,
|
| 561 |
+
so that the <code>Message-ID</code> header is added to the commit message.
|
| 562 |
+
The <code>am.messageid</code> configuration variable can be used to specify
|
| 563 |
+
the default behaviour.</p>
|
| 564 |
+
</dd>
|
| 565 |
+
<dt class="hdlist1">--no-message-id</dt>
|
| 566 |
+
<dd>
|
| 567 |
+
<p>Do not add the Message-ID header to the commit message.
|
| 568 |
+
<code>--no-message-id</code> is useful to override <code>am.messageid</code>.</p>
|
| 569 |
+
</dd>
|
| 570 |
+
<dt class="hdlist1">-q</dt>
|
| 571 |
+
<dt class="hdlist1">--quiet</dt>
|
| 572 |
+
<dd>
|
| 573 |
+
<p>Be quiet. Only print error messages.</p>
|
| 574 |
+
</dd>
|
| 575 |
+
<dt class="hdlist1">-u</dt>
|
| 576 |
+
<dt class="hdlist1">--utf8</dt>
|
| 577 |
+
<dd>
|
| 578 |
+
<p>Pass <code>-u</code> flag to <a href="git-mailinfo.html">git-mailinfo(1)</a>.
|
| 579 |
+
The proposed commit log message taken from the e-mail
|
| 580 |
+
is re-coded into UTF-8 encoding (configuration variable
|
| 581 |
+
<code>i18n.commitEncoding</code> can be used to specify the project’s
|
| 582 |
+
preferred encoding if it is not UTF-8).</p>
|
| 583 |
+
<div class="paragraph">
|
| 584 |
+
<p>This was optional in prior versions of git, but now it is the
|
| 585 |
+
default. You can use <code>--no-utf8</code> to override this.</p>
|
| 586 |
+
</div>
|
| 587 |
+
</dd>
|
| 588 |
+
<dt class="hdlist1">--no-utf8</dt>
|
| 589 |
+
<dd>
|
| 590 |
+
<p>Pass <code>-n</code> flag to <a href="git-mailinfo.html">git-mailinfo(1)</a>.</p>
|
| 591 |
+
</dd>
|
| 592 |
+
<dt class="hdlist1">-3</dt>
|
| 593 |
+
<dt class="hdlist1">--3way</dt>
|
| 594 |
+
<dt class="hdlist1">--no-3way</dt>
|
| 595 |
+
<dd>
|
| 596 |
+
<p>When the patch does not apply cleanly, fall back on
|
| 597 |
+
3-way merge if the patch records the identity of blobs
|
| 598 |
+
it is supposed to apply to and we have those blobs
|
| 599 |
+
available locally. <code>--no-3way</code> can be used to override
|
| 600 |
+
am.threeWay configuration variable. For more information,
|
| 601 |
+
see am.threeWay in <a href="git-config.html">git-config(1)</a>.</p>
|
| 602 |
+
</dd>
|
| 603 |
+
<dt class="hdlist1"><code>--rerere-autoupdate</code></dt>
|
| 604 |
+
<dt class="hdlist1"><code>--no-rerere-autoupdate</code></dt>
|
| 605 |
+
<dd>
|
| 606 |
+
<p>After the rerere mechanism reuses a recorded resolution on
|
| 607 |
+
the current conflict to update the files in the working
|
| 608 |
+
tree, allow it to also update the index with the result of
|
| 609 |
+
resolution. <code>--no-rerere-autoupdate</code> is a good way to
|
| 610 |
+
double-check what <a href="git-rerere.html">git-rerere(1)</a> did and catch potential
|
| 611 |
+
mismerges, before committing the result to the index with a
|
| 612 |
+
separate <a href="git-add.html">git-add(1)</a>.</p>
|
| 613 |
+
</dd>
|
| 614 |
+
<dt class="hdlist1">--ignore-space-change</dt>
|
| 615 |
+
<dt class="hdlist1">--ignore-whitespace</dt>
|
| 616 |
+
<dt class="hdlist1">--whitespace=<action></dt>
|
| 617 |
+
<dt class="hdlist1">-C<n></dt>
|
| 618 |
+
<dt class="hdlist1">-p<n></dt>
|
| 619 |
+
<dt class="hdlist1">--directory=<dir></dt>
|
| 620 |
+
<dt class="hdlist1">--exclude=<path></dt>
|
| 621 |
+
<dt class="hdlist1">--include=<path></dt>
|
| 622 |
+
<dt class="hdlist1">--reject</dt>
|
| 623 |
+
<dd>
|
| 624 |
+
<p>These flags are passed to the <a href="git-apply.html">git-apply(1)</a> program that
|
| 625 |
+
applies the patch.</p>
|
| 626 |
+
<div class="paragraph">
|
| 627 |
+
<p>Valid <action> for the <code>--whitespace</code> option are:
|
| 628 |
+
<code>nowarn</code>, <code>warn</code>, <code>fix</code>, <code>error</code>, and <code>error-all</code>.</p>
|
| 629 |
+
</div>
|
| 630 |
+
</dd>
|
| 631 |
+
<dt class="hdlist1">--patch-format</dt>
|
| 632 |
+
<dd>
|
| 633 |
+
<p>By default the command will try to detect the patch format
|
| 634 |
+
automatically. This option allows the user to bypass the automatic
|
| 635 |
+
detection and specify the patch format that the patch(es) should be
|
| 636 |
+
interpreted as. Valid formats are mbox, mboxrd,
|
| 637 |
+
stgit, stgit-series, and hg.</p>
|
| 638 |
+
</dd>
|
| 639 |
+
<dt class="hdlist1">-i</dt>
|
| 640 |
+
<dt class="hdlist1">--interactive</dt>
|
| 641 |
+
<dd>
|
| 642 |
+
<p>Run interactively.</p>
|
| 643 |
+
</dd>
|
| 644 |
+
<dt class="hdlist1">--verify</dt>
|
| 645 |
+
<dt class="hdlist1">-n</dt>
|
| 646 |
+
<dt class="hdlist1">--no-verify</dt>
|
| 647 |
+
<dd>
|
| 648 |
+
<p>Run the <code>pre-applypatch</code> and <code>applypatch-msg</code> hooks. This is the
|
| 649 |
+
default. Skip these hooks with <code>-n</code> or <code>--no-verify</code>. See also
|
| 650 |
+
<a href="githooks.html">githooks(5)</a>.</p>
|
| 651 |
+
<div class="paragraph">
|
| 652 |
+
<p>Note that <code>post-applypatch</code> cannot be skipped.</p>
|
| 653 |
+
</div>
|
| 654 |
+
</dd>
|
| 655 |
+
<dt class="hdlist1">--committer-date-is-author-date</dt>
|
| 656 |
+
<dd>
|
| 657 |
+
<p>By default the command records the date from the e-mail
|
| 658 |
+
message as the commit author date, and uses the time of
|
| 659 |
+
commit creation as the committer date. This allows the
|
| 660 |
+
user to lie about the committer date by using the same
|
| 661 |
+
value as the author date.</p>
|
| 662 |
+
<div class="admonitionblock warning">
|
| 663 |
+
<table>
|
| 664 |
+
<tr>
|
| 665 |
+
<td class="icon">
|
| 666 |
+
<div class="title">Warning</div>
|
| 667 |
+
</td>
|
| 668 |
+
<td class="content">
|
| 669 |
+
The history walking machinery assumes that commits have
|
| 670 |
+
non-decreasing commit timestamps. You should consider if you really need
|
| 671 |
+
to use this option. Then you should only use this option to override the
|
| 672 |
+
committer date when applying commits on top of a base which commit is
|
| 673 |
+
older (in terms of the commit date) than the oldest patch you are
|
| 674 |
+
applying.
|
| 675 |
+
</td>
|
| 676 |
+
</tr>
|
| 677 |
+
</table>
|
| 678 |
+
</div>
|
| 679 |
+
</dd>
|
| 680 |
+
<dt class="hdlist1">--ignore-date</dt>
|
| 681 |
+
<dd>
|
| 682 |
+
<p>By default the command records the date from the e-mail
|
| 683 |
+
message as the commit author date, and uses the time of
|
| 684 |
+
commit creation as the committer date. This allows the
|
| 685 |
+
user to lie about the author date by using the same
|
| 686 |
+
value as the committer date.</p>
|
| 687 |
+
</dd>
|
| 688 |
+
<dt class="hdlist1">--skip</dt>
|
| 689 |
+
<dd>
|
| 690 |
+
<p>Skip the current patch. This is only meaningful when
|
| 691 |
+
restarting an aborted patch.</p>
|
| 692 |
+
</dd>
|
| 693 |
+
<dt class="hdlist1">-S[<keyid>]</dt>
|
| 694 |
+
<dt class="hdlist1">--gpg-sign[=<keyid>]</dt>
|
| 695 |
+
<dt class="hdlist1">--no-gpg-sign</dt>
|
| 696 |
+
<dd>
|
| 697 |
+
<p>GPG-sign commits. The <code>keyid</code> argument is optional and
|
| 698 |
+
defaults to the committer identity; if specified, it must be
|
| 699 |
+
stuck to the option without a space. <code>--no-gpg-sign</code> is useful to
|
| 700 |
+
countermand both <code>commit.gpgSign</code> configuration variable, and
|
| 701 |
+
earlier <code>--gpg-sign</code>.</p>
|
| 702 |
+
</dd>
|
| 703 |
+
<dt class="hdlist1">--continue</dt>
|
| 704 |
+
<dt class="hdlist1">-r</dt>
|
| 705 |
+
<dt class="hdlist1">--resolved</dt>
|
| 706 |
+
<dd>
|
| 707 |
+
<p>After a patch failure (e.g. attempting to apply
|
| 708 |
+
conflicting patch), the user has applied it by hand and
|
| 709 |
+
the index file stores the result of the application.
|
| 710 |
+
Make a commit using the authorship and commit log
|
| 711 |
+
extracted from the e-mail message and the current index
|
| 712 |
+
file, and continue.</p>
|
| 713 |
+
</dd>
|
| 714 |
+
<dt class="hdlist1">--resolvemsg=<msg></dt>
|
| 715 |
+
<dd>
|
| 716 |
+
<p>When a patch failure occurs, <msg> will be printed
|
| 717 |
+
to the screen before exiting. This overrides the
|
| 718 |
+
standard message informing you to use <code>--continue</code>
|
| 719 |
+
or <code>--skip</code> to handle the failure. This is solely
|
| 720 |
+
for internal use between <a href="git-rebase.html">git-rebase(1)</a> and
|
| 721 |
+
<a href="git-am.html">git-am(1)</a>.</p>
|
| 722 |
+
</dd>
|
| 723 |
+
<dt class="hdlist1">--abort</dt>
|
| 724 |
+
<dd>
|
| 725 |
+
<p>Restore the original branch and abort the patching operation.
|
| 726 |
+
Revert the contents of files involved in the am operation to their
|
| 727 |
+
pre-am state.</p>
|
| 728 |
+
</dd>
|
| 729 |
+
<dt class="hdlist1">--quit</dt>
|
| 730 |
+
<dd>
|
| 731 |
+
<p>Abort the patching operation but keep HEAD and the index
|
| 732 |
+
untouched.</p>
|
| 733 |
+
</dd>
|
| 734 |
+
<dt class="hdlist1">--retry</dt>
|
| 735 |
+
<dd>
|
| 736 |
+
<p>Try to apply the last conflicting patch again. This is generally
|
| 737 |
+
only useful for passing extra options to the retry attempt
|
| 738 |
+
(e.g., <code>--3way</code>), since otherwise you’ll just see the same
|
| 739 |
+
failure again.</p>
|
| 740 |
+
</dd>
|
| 741 |
+
<dt class="hdlist1">--show-current-patch[=(diff|raw)]</dt>
|
| 742 |
+
<dd>
|
| 743 |
+
<p>Show the message at which <a href="git-am.html">git-am(1)</a> has stopped due to
|
| 744 |
+
conflicts. If <code>raw</code> is specified, show the raw contents of
|
| 745 |
+
the e-mail message; if <code>diff</code>, show the diff portion only.
|
| 746 |
+
Defaults to <code>raw</code>.</p>
|
| 747 |
+
</dd>
|
| 748 |
+
<dt class="hdlist1">--allow-empty</dt>
|
| 749 |
+
<dd>
|
| 750 |
+
<p>After a patch failure on an input e-mail message lacking a patch,
|
| 751 |
+
create an empty commit with the contents of the e-mail message
|
| 752 |
+
as its log message.</p>
|
| 753 |
+
</dd>
|
| 754 |
+
</dl>
|
| 755 |
+
</div>
|
| 756 |
+
</div>
|
| 757 |
+
</div>
|
| 758 |
+
<div class="sect1">
|
| 759 |
+
<h2 id="discussion">DISCUSSION</h2>
|
| 760 |
+
<div class="sectionbody">
|
| 761 |
+
<div class="paragraph">
|
| 762 |
+
<p>The commit author name is taken from the "From: " line of the
|
| 763 |
+
message, and commit author date is taken from the "Date: " line
|
| 764 |
+
of the message. The "Subject: " line is used as the title of
|
| 765 |
+
the commit, after stripping common prefix "[PATCH <anything>]".
|
| 766 |
+
The "Subject: " line is supposed to concisely describe what the
|
| 767 |
+
commit is about in one line of text.</p>
|
| 768 |
+
</div>
|
| 769 |
+
<div class="paragraph">
|
| 770 |
+
<p>"From: ", "Date: ", and "Subject: " lines starting the body override the
|
| 771 |
+
respective commit author name and title values taken from the headers.</p>
|
| 772 |
+
</div>
|
| 773 |
+
<div class="paragraph">
|
| 774 |
+
<p>The commit message is formed by the title taken from the
|
| 775 |
+
"Subject: ", a blank line and the body of the message up to
|
| 776 |
+
where the patch begins. Excess whitespace at the end of each
|
| 777 |
+
line is automatically stripped.</p>
|
| 778 |
+
</div>
|
| 779 |
+
<div class="paragraph">
|
| 780 |
+
<p>The patch is expected to be inline, directly following the
|
| 781 |
+
message.
|
| 782 |
+
Any line that is of the form:</p>
|
| 783 |
+
</div>
|
| 784 |
+
<div class="ulist">
|
| 785 |
+
<ul>
|
| 786 |
+
<li>
|
| 787 |
+
<p>three-dashes and end-of-line, or</p>
|
| 788 |
+
</li>
|
| 789 |
+
<li>
|
| 790 |
+
<p>a line that begins with "diff -", or</p>
|
| 791 |
+
</li>
|
| 792 |
+
<li>
|
| 793 |
+
<p>a line that begins with "Index: "</p>
|
| 794 |
+
</li>
|
| 795 |
+
</ul>
|
| 796 |
+
</div>
|
| 797 |
+
<div class="paragraph">
|
| 798 |
+
<p>is taken as the beginning of a patch, and the commit log message
|
| 799 |
+
is terminated before the first occurrence of such a line.</p>
|
| 800 |
+
</div>
|
| 801 |
+
<div class="paragraph">
|
| 802 |
+
<p>This means that the contents of the commit message can inadvertently
|
| 803 |
+
interrupt the processing (see the <a href="#caveats">CAVEATS</a> section below).</p>
|
| 804 |
+
</div>
|
| 805 |
+
<div class="paragraph">
|
| 806 |
+
<p>When initially invoking <a href="git-am.html">git-am(1)</a>, you give it the names of the mailboxes
|
| 807 |
+
to process. Upon seeing the first patch that does not apply, it
|
| 808 |
+
aborts in the middle. You can recover from this in one of two ways:</p>
|
| 809 |
+
</div>
|
| 810 |
+
<div class="olist arabic">
|
| 811 |
+
<ol class="arabic">
|
| 812 |
+
<li>
|
| 813 |
+
<p>skip the current patch by re-running the command with the <code>--skip</code>
|
| 814 |
+
option.</p>
|
| 815 |
+
</li>
|
| 816 |
+
<li>
|
| 817 |
+
<p>hand resolve the conflict in the working directory, and update
|
| 818 |
+
the index file to bring it into a state that the patch should
|
| 819 |
+
have produced. Then run the command with the <code>--continue</code> option.</p>
|
| 820 |
+
</li>
|
| 821 |
+
</ol>
|
| 822 |
+
</div>
|
| 823 |
+
<div class="paragraph">
|
| 824 |
+
<p>The command refuses to process new mailboxes until the current
|
| 825 |
+
operation is finished, so if you decide to start over from scratch,
|
| 826 |
+
run <code>git</code> <code>am</code> <code>--abort</code> before running the command with mailbox
|
| 827 |
+
names.</p>
|
| 828 |
+
</div>
|
| 829 |
+
<div class="paragraph">
|
| 830 |
+
<p>Before any patches are applied, ORIG_HEAD is set to the tip of the
|
| 831 |
+
current branch. This is useful if you have problems with multiple
|
| 832 |
+
commits, like running <a href="git-am.html">git-am(1)</a> on the wrong branch or an error
|
| 833 |
+
in the commits that is more easily fixed by changing the mailbox (e.g.
|
| 834 |
+
errors in the "From:" lines).</p>
|
| 835 |
+
</div>
|
| 836 |
+
</div>
|
| 837 |
+
</div>
|
| 838 |
+
<div class="sect1">
|
| 839 |
+
<h2 id="caveats">CAVEATS</h2>
|
| 840 |
+
<div class="sectionbody">
|
| 841 |
+
<div class="paragraph">
|
| 842 |
+
<p>The output from <a href="git-format-patch.html">git-format-patch(1)</a> can lead to a different
|
| 843 |
+
commit message when applied with <a href="git-am.html">git-am(1)</a>. The patch that is
|
| 844 |
+
applied may also be different from the one that was generated, or patch
|
| 845 |
+
application may fail outright.
|
| 846 |
+
See the <a href="#discussion">DISCUSSION</a> section above for the syntactic rules.</p>
|
| 847 |
+
</div>
|
| 848 |
+
<div class="paragraph">
|
| 849 |
+
<p>Note that this is especially problematic for unindented diffs that occur
|
| 850 |
+
in the commit message; the diff in the commit message might get applied
|
| 851 |
+
along with the patch section, or the patch application machinery might
|
| 852 |
+
trip up because the patch target doesn’t apply. This could for example
|
| 853 |
+
be caused by a diff in a Markdown code block.</p>
|
| 854 |
+
</div>
|
| 855 |
+
<div class="paragraph">
|
| 856 |
+
<p>The solution for this is to indent the diff or other text that could
|
| 857 |
+
cause problems.</p>
|
| 858 |
+
</div>
|
| 859 |
+
<div class="paragraph">
|
| 860 |
+
<p>This loss of fidelity might be simple to notice if you are applying
|
| 861 |
+
patches directly from a mailbox. However, changes originating from Git
|
| 862 |
+
could be applied in bulk, in which case this would be much harder to
|
| 863 |
+
notice. This could for example be a Linux distribution which uses patch
|
| 864 |
+
files to apply changes on top of the commits from the upstream
|
| 865 |
+
repositories. This goes to show that this behavior does not only impact
|
| 866 |
+
email workflows.</p>
|
| 867 |
+
</div>
|
| 868 |
+
<div class="paragraph">
|
| 869 |
+
<p>Given these limitations, one might be tempted to use a general-purpose
|
| 870 |
+
utility like patch(1) instead. However, patch(1) will not only look for
|
| 871 |
+
unindented diffs (like <a href="git-am.html">git-am(1)</a>) but will try to apply indented
|
| 872 |
+
diffs as well.</p>
|
| 873 |
+
</div>
|
| 874 |
+
</div>
|
| 875 |
+
</div>
|
| 876 |
+
<div class="sect1">
|
| 877 |
+
<h2 id="_hooks">HOOKS</h2>
|
| 878 |
+
<div class="sectionbody">
|
| 879 |
+
<div class="paragraph">
|
| 880 |
+
<p>This command can run <code>applypatch-msg</code>, <code>pre-applypatch</code>,
|
| 881 |
+
and <code>post-applypatch</code> hooks. See <a href="githooks.html">githooks(5)</a> for more
|
| 882 |
+
information.</p>
|
| 883 |
+
</div>
|
| 884 |
+
<div class="paragraph">
|
| 885 |
+
<p>See the <code>--verify</code>/<code>-n</code>/<code>--no-verify</code> options.</p>
|
| 886 |
+
</div>
|
| 887 |
+
</div>
|
| 888 |
+
</div>
|
| 889 |
+
<div class="sect1">
|
| 890 |
+
<h2 id="_configuration">CONFIGURATION</h2>
|
| 891 |
+
<div class="sectionbody">
|
| 892 |
+
<div class="paragraph">
|
| 893 |
+
<p>Everything below this line in this section is selectively included
|
| 894 |
+
from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
|
| 895 |
+
as what’s found there:</p>
|
| 896 |
+
</div>
|
| 897 |
+
<div class="dlist">
|
| 898 |
+
<dl>
|
| 899 |
+
<dt class="hdlist1">am.keepcr</dt>
|
| 900 |
+
<dd>
|
| 901 |
+
<p>If true, <a href="git-am.html">git-am(1)</a> will call <a href="git-mailsplit.html">git-mailsplit(1)</a>
|
| 902 |
+
for patches in mbox format with parameter <code>--keep-cr</code>. In this
|
| 903 |
+
case <a href="git-mailsplit.html">git-mailsplit(1)</a> will
|
| 904 |
+
not remove <code>\r</code> from lines ending with <code>\r\n</code>. Can be overridden
|
| 905 |
+
by giving <code>--no-keep-cr</code> from the command line.</p>
|
| 906 |
+
</dd>
|
| 907 |
+
<dt class="hdlist1">am.threeWay</dt>
|
| 908 |
+
<dd>
|
| 909 |
+
<p>By default, <a href="git-am.html">git-am(1)</a> will fail if the patch does not
|
| 910 |
+
apply cleanly. When set to true, this setting tells
|
| 911 |
+
<a href="git-am.html">git-am(1)</a> to fall back on 3-way merge if the patch
|
| 912 |
+
records the identity of blobs it is supposed to apply to and we
|
| 913 |
+
have those blobs available locally (equivalent to giving the
|
| 914 |
+
<code>--3way</code> option from the command line). Defaults to <code>false</code>.</p>
|
| 915 |
+
</dd>
|
| 916 |
+
<dt class="hdlist1">am.messageId</dt>
|
| 917 |
+
<dd>
|
| 918 |
+
<p>Add a <code>Message-ID</code> trailer based on the email header to the
|
| 919 |
+
commit when using <a href="git-am.html">git-am(1)</a> (see
|
| 920 |
+
<a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>). See also the <code>--message-id</code>
|
| 921 |
+
and <code>--no-message-id</code> options.</p>
|
| 922 |
+
</dd>
|
| 923 |
+
</dl>
|
| 924 |
+
</div>
|
| 925 |
+
</div>
|
| 926 |
+
</div>
|
| 927 |
+
<div class="sect1">
|
| 928 |
+
<h2 id="_see_also">SEE ALSO</h2>
|
| 929 |
+
<div class="sectionbody">
|
| 930 |
+
<div class="paragraph">
|
| 931 |
+
<p><a href="git-apply.html">git-apply(1)</a>,
|
| 932 |
+
<a href="git-format-patch.html">git-format-patch(1)</a>.</p>
|
| 933 |
+
</div>
|
| 934 |
+
</div>
|
| 935 |
+
</div>
|
| 936 |
+
<div class="sect1">
|
| 937 |
+
<h2 id="_git">GIT</h2>
|
| 938 |
+
<div class="sectionbody">
|
| 939 |
+
<div class="paragraph">
|
| 940 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 941 |
+
</div>
|
| 942 |
+
</div>
|
| 943 |
+
</div>
|
| 944 |
+
</div>
|
| 945 |
+
<div id="footer">
|
| 946 |
+
<div id="footer-text">
|
| 947 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 948 |
+
</div>
|
| 949 |
+
</div>
|
| 950 |
+
</body>
|
| 951 |
+
</html>
|
git/mingw64/share/doc/git-doc/git-annotate.adoc
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-annotate(1)
|
| 2 |
+
===============
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-annotate - Annotate file lines with commit information
|
| 7 |
+
|
| 8 |
+
SYNOPSIS
|
| 9 |
+
--------
|
| 10 |
+
[verse]
|
| 11 |
+
'git annotate' [<options>] [<rev-opts>] [<rev>] [--] <file>
|
| 12 |
+
|
| 13 |
+
DESCRIPTION
|
| 14 |
+
-----------
|
| 15 |
+
Annotates each line in the given file with information from the commit
|
| 16 |
+
which introduced the line. Optionally annotates from a given revision.
|
| 17 |
+
|
| 18 |
+
The only difference between this command and linkgit:git-blame[1] is that
|
| 19 |
+
they use slightly different output formats, and this command exists only
|
| 20 |
+
for backward compatibility to support existing scripts, and provide a more
|
| 21 |
+
familiar command name for people coming from other SCM systems.
|
| 22 |
+
|
| 23 |
+
OPTIONS
|
| 24 |
+
-------
|
| 25 |
+
include::blame-options.adoc[]
|
| 26 |
+
|
| 27 |
+
SEE ALSO
|
| 28 |
+
--------
|
| 29 |
+
linkgit:git-blame[1]
|
| 30 |
+
|
| 31 |
+
GIT
|
| 32 |
+
---
|
| 33 |
+
Part of the linkgit:git[1] suite
|
git/mingw64/share/doc/git-doc/git-annotate.html
ADDED
|
@@ -0,0 +1,724 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-annotate(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-annotate(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-annotate - Annotate file lines with commit information</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content"><em>git annotate</em> [<options>] [<rev-opts>] [<rev>] [--] <file></pre>
|
| 456 |
+
</div>
|
| 457 |
+
</div>
|
| 458 |
+
</div>
|
| 459 |
+
<div class="sect1">
|
| 460 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 461 |
+
<div class="sectionbody">
|
| 462 |
+
<div class="paragraph">
|
| 463 |
+
<p>Annotates each line in the given file with information from the commit
|
| 464 |
+
which introduced the line. Optionally annotates from a given revision.</p>
|
| 465 |
+
</div>
|
| 466 |
+
<div class="paragraph">
|
| 467 |
+
<p>The only difference between this command and <a href="git-blame.html">git-blame(1)</a> is that
|
| 468 |
+
they use slightly different output formats, and this command exists only
|
| 469 |
+
for backward compatibility to support existing scripts, and provide a more
|
| 470 |
+
familiar command name for people coming from other SCM systems.</p>
|
| 471 |
+
</div>
|
| 472 |
+
</div>
|
| 473 |
+
</div>
|
| 474 |
+
<div class="sect1">
|
| 475 |
+
<h2 id="_options">OPTIONS</h2>
|
| 476 |
+
<div class="sectionbody">
|
| 477 |
+
<div class="dlist">
|
| 478 |
+
<dl>
|
| 479 |
+
<dt class="hdlist1"><code>-b</code></dt>
|
| 480 |
+
<dd>
|
| 481 |
+
<p>Show blank SHA-1 for boundary commits. This can also
|
| 482 |
+
be controlled via the <code>blame.blankBoundary</code> config option.</p>
|
| 483 |
+
</dd>
|
| 484 |
+
<dt class="hdlist1"><code>--root</code></dt>
|
| 485 |
+
<dd>
|
| 486 |
+
<p>Do not treat root commits as boundaries. This can also be
|
| 487 |
+
controlled via the <code>blame.showRoot</code> config option.</p>
|
| 488 |
+
</dd>
|
| 489 |
+
<dt class="hdlist1"><code>--show-stats</code></dt>
|
| 490 |
+
<dd>
|
| 491 |
+
<p>Include additional statistics at the end of blame output.</p>
|
| 492 |
+
</dd>
|
| 493 |
+
<dt class="hdlist1"><code>-L</code> <em><start></em><code>,</code><em><end></em></dt>
|
| 494 |
+
<dt class="hdlist1"><code>-L</code> <code>:</code><em><funcname></em></dt>
|
| 495 |
+
<dd>
|
| 496 |
+
<p>Annotate only the line range given by <em><start></em><code>,</code><em><end></em>,
|
| 497 |
+
or by the function name regex <em><funcname></em>.
|
| 498 |
+
May be specified multiple times. Overlapping ranges are allowed.</p>
|
| 499 |
+
<div class="paragraph">
|
| 500 |
+
<p><em><start></em> and <em><end></em> are optional. <code>-L</code> <em><start></em> or <code>-L</code> <em><start></em><code>,</code> spans from
|
| 501 |
+
<em><start></em> to end of file. <code>-L</code> <code>,</code><em><end></em> spans from start of file to <em><end></em>.</p>
|
| 502 |
+
</div>
|
| 503 |
+
<div class="paragraph">
|
| 504 |
+
<p><em><start></em> and <em><end></em> can take one of these forms:</p>
|
| 505 |
+
</div>
|
| 506 |
+
<div class="ulist">
|
| 507 |
+
<ul>
|
| 508 |
+
<li>
|
| 509 |
+
<p><em><number></em></p>
|
| 510 |
+
<div class="paragraph">
|
| 511 |
+
<p>If <em><start></em> or <em><end></em> is a number, it specifies an
|
| 512 |
+
absolute line number (lines count from 1).</p>
|
| 513 |
+
</div>
|
| 514 |
+
</li>
|
| 515 |
+
<li>
|
| 516 |
+
<p><code>/</code><em><regex></em><code>/</code></p>
|
| 517 |
+
<div class="paragraph">
|
| 518 |
+
<p>This form will use the first line matching the given
|
| 519 |
+
POSIX <em><regex></em>. If <em><start></em> is a regex, it will search from the end of
|
| 520 |
+
the previous <code>-L</code> range, if any, otherwise from the start of file.
|
| 521 |
+
If <em><start></em> is <code>^/</code><em><regex></em><code>/</code>, it will search from the start of file.
|
| 522 |
+
If <em><end></em> is a regex, it will search starting at the line given by
|
| 523 |
+
<em><start></em>.</p>
|
| 524 |
+
</div>
|
| 525 |
+
</li>
|
| 526 |
+
<li>
|
| 527 |
+
<p><code>+</code><em><offset></em> or <code>-</code><em><offset></em></p>
|
| 528 |
+
<div class="paragraph">
|
| 529 |
+
<p>This is only valid for <em><end></em> and will specify a number
|
| 530 |
+
of lines before or after the line given by <em><start></em>.</p>
|
| 531 |
+
</div>
|
| 532 |
+
</li>
|
| 533 |
+
</ul>
|
| 534 |
+
</div>
|
| 535 |
+
<div class="paragraph">
|
| 536 |
+
<p>If <code>:</code><em><funcname></em> is given in place of <em><start></em> and <em><end></em>, it is a
|
| 537 |
+
regular expression that denotes the range from the first funcname line
|
| 538 |
+
that matches <em><funcname></em>, up to the next funcname line. <code>:</code><em><funcname></em>
|
| 539 |
+
searches from the end of the previous <code>-L</code> range, if any, otherwise
|
| 540 |
+
from the start of file. <code>^:</code><em><funcname></em> searches from the start of
|
| 541 |
+
file. The function names are determined in the same way as <code>git</code> <code>diff</code>
|
| 542 |
+
works out patch hunk headers (see <em>Defining a custom hunk-header</em>
|
| 543 |
+
in <a href="gitattributes.html">gitattributes(5)</a>).</p>
|
| 544 |
+
</div>
|
| 545 |
+
</dd>
|
| 546 |
+
<dt class="hdlist1"><code>-l</code></dt>
|
| 547 |
+
<dd>
|
| 548 |
+
<p>Show long rev (Default: off).</p>
|
| 549 |
+
</dd>
|
| 550 |
+
<dt class="hdlist1"><code>-t</code></dt>
|
| 551 |
+
<dd>
|
| 552 |
+
<p>Show raw timestamp (Default: off).</p>
|
| 553 |
+
</dd>
|
| 554 |
+
<dt class="hdlist1"><code>-S</code> <em><revs-file></em></dt>
|
| 555 |
+
<dd>
|
| 556 |
+
<p>Use revisions from <em><revs-file></em> instead of calling
|
| 557 |
+
<a href="git-rev-list.html">git-rev-list(1)</a>.</p>
|
| 558 |
+
</dd>
|
| 559 |
+
<dt class="hdlist1"><code>--reverse</code> <em><start></em><code>..</code><em><end></em></dt>
|
| 560 |
+
<dd>
|
| 561 |
+
<p>Walk history forward instead of backward. Instead of showing
|
| 562 |
+
the revision in which a line appeared, this shows the last
|
| 563 |
+
revision in which a line has existed. This requires a range of
|
| 564 |
+
revision like <em><start></em><code>..</code><em><end></em> where the path to blame exists in
|
| 565 |
+
<em><start></em>. <code>git</code> <code>blame</code> <code>--reverse</code> <em><start></em> is taken as <code>git</code> <code>blame</code>
|
| 566 |
+
<code>--reverse</code> <em><start></em><code>..</code><code>HEAD</code> for convenience.</p>
|
| 567 |
+
</dd>
|
| 568 |
+
<dt class="hdlist1"><code>--first-parent</code></dt>
|
| 569 |
+
<dd>
|
| 570 |
+
<p>Follow only the first parent commit upon seeing a merge
|
| 571 |
+
commit. This option can be used to determine when a line
|
| 572 |
+
was introduced to a particular integration branch, rather
|
| 573 |
+
than when it was introduced to the history overall.</p>
|
| 574 |
+
</dd>
|
| 575 |
+
<dt class="hdlist1"><code>-p</code></dt>
|
| 576 |
+
<dt class="hdlist1"><code>--porcelain</code></dt>
|
| 577 |
+
<dd>
|
| 578 |
+
<p>Show in a format designed for machine consumption.</p>
|
| 579 |
+
</dd>
|
| 580 |
+
<dt class="hdlist1"><code>--line-porcelain</code></dt>
|
| 581 |
+
<dd>
|
| 582 |
+
<p>Show the porcelain format, but output commit information for
|
| 583 |
+
each line, not just the first time a commit is referenced.
|
| 584 |
+
Implies <code>--porcelain</code>.</p>
|
| 585 |
+
</dd>
|
| 586 |
+
<dt class="hdlist1"><code>--incremental</code></dt>
|
| 587 |
+
<dd>
|
| 588 |
+
<p>Show the result incrementally in a format designed for
|
| 589 |
+
machine consumption.</p>
|
| 590 |
+
</dd>
|
| 591 |
+
<dt class="hdlist1"><code>--encoding=</code><em><encoding></em></dt>
|
| 592 |
+
<dd>
|
| 593 |
+
<p>Specify the encoding used to output author names
|
| 594 |
+
and commit summaries. Setting it to <code>none</code> makes blame
|
| 595 |
+
output unconverted data. For more information see the
|
| 596 |
+
discussion about encoding in the <a href="git-log.html">git-log(1)</a>
|
| 597 |
+
manual page.</p>
|
| 598 |
+
</dd>
|
| 599 |
+
<dt class="hdlist1"><code>--contents</code> <em><file></em></dt>
|
| 600 |
+
<dd>
|
| 601 |
+
<p>Annotate using the contents from <em><file></em>, starting from <em><rev></em>
|
| 602 |
+
if it is specified, and <code>HEAD</code> otherwise. You may specify <code>-</code> to make
|
| 603 |
+
the command read from the standard input for the file contents.</p>
|
| 604 |
+
</dd>
|
| 605 |
+
<dt class="hdlist1"><code>--date</code> <em><format></em></dt>
|
| 606 |
+
<dd>
|
| 607 |
+
<p>Specify the format used to output dates. If <code>--date</code> is not
|
| 608 |
+
provided, the value of the <code>blame.date</code> config variable is
|
| 609 |
+
used. If the <code>blame.date</code> config variable is also not set, the
|
| 610 |
+
iso format is used. For supported values, see the discussion
|
| 611 |
+
of the <code>--date</code> option at <a href="git-log.html">git-log(1)</a>.</p>
|
| 612 |
+
</dd>
|
| 613 |
+
<dt class="hdlist1"><code>--progress</code></dt>
|
| 614 |
+
<dt class="hdlist1"><code>--no-progress</code></dt>
|
| 615 |
+
<dd>
|
| 616 |
+
<p>Enable progress reporting on the standard error stream even if
|
| 617 |
+
not attached to a terminal. By default, progress status is
|
| 618 |
+
reported only when it is attached. You can’t use <code>--progress</code>
|
| 619 |
+
together with <code>--porcelain</code> or <code>--incremental</code>.</p>
|
| 620 |
+
</dd>
|
| 621 |
+
<dt class="hdlist1"><code>-M</code>[<em><num></em>]</dt>
|
| 622 |
+
<dd>
|
| 623 |
+
<p>Detect moved or copied lines within a file. When a commit
|
| 624 |
+
moves or copies a block of lines (e.g. the original file
|
| 625 |
+
has <em>A</em> and then <em>B</em>, and the commit changes it to <em>B</em> and then
|
| 626 |
+
<em>A</em>), the traditional <code>blame</code> algorithm notices only half of
|
| 627 |
+
the movement and typically blames the lines that were moved
|
| 628 |
+
up (i.e. <em>B</em>) to the parent and assigns blame to the lines that
|
| 629 |
+
were moved down (i.e. <em>A</em>) to the child commit. With this
|
| 630 |
+
option, both groups of lines are blamed on the parent by
|
| 631 |
+
running extra passes of inspection.</p>
|
| 632 |
+
<div class="paragraph">
|
| 633 |
+
<p><em><num></em> is optional, but it is the lower bound on the number of
|
| 634 |
+
alphanumeric characters that Git must detect as moving/copying
|
| 635 |
+
within a file for it to associate those lines with the parent
|
| 636 |
+
commit. The default value is 20.</p>
|
| 637 |
+
</div>
|
| 638 |
+
</dd>
|
| 639 |
+
<dt class="hdlist1"><code>-C</code>[<em><num></em>]</dt>
|
| 640 |
+
<dd>
|
| 641 |
+
<p>In addition to <code>-M</code>, detect lines moved or copied from other
|
| 642 |
+
files that were modified in the same commit. This is
|
| 643 |
+
useful when you reorganize your program and move code
|
| 644 |
+
around across files. When this option is given twice,
|
| 645 |
+
the command additionally looks for copies from other
|
| 646 |
+
files in the commit that creates the file. When this
|
| 647 |
+
option is given three times, the command additionally
|
| 648 |
+
looks for copies from other files in any commit.</p>
|
| 649 |
+
<div class="paragraph">
|
| 650 |
+
<p><em><num></em> is optional, but it is the lower bound on the number of
|
| 651 |
+
alphanumeric characters that Git must detect as moving/copying
|
| 652 |
+
between files for it to associate those lines with the parent
|
| 653 |
+
commit. And the default value is 40. If there are more than one
|
| 654 |
+
<code>-C</code> options given, the <em><num></em> argument of the last <code>-C</code> will
|
| 655 |
+
take effect.</p>
|
| 656 |
+
</div>
|
| 657 |
+
</dd>
|
| 658 |
+
<dt class="hdlist1"><code>--ignore-rev</code> <em><rev></em></dt>
|
| 659 |
+
<dd>
|
| 660 |
+
<p>Ignore changes made by the revision when assigning blame, as if the
|
| 661 |
+
change never happened. Lines that were changed or added by an ignored
|
| 662 |
+
commit will be blamed on the previous commit that changed that line or
|
| 663 |
+
nearby lines. This option may be specified multiple times to ignore
|
| 664 |
+
more than one revision. If the <code>blame.markIgnoredLines</code> config option
|
| 665 |
+
is set, then lines that were changed by an ignored commit and attributed to
|
| 666 |
+
another commit will be marked with a ? in the blame output. If the
|
| 667 |
+
<code>blame.markUnblamableLines</code> config option is set, then those lines touched
|
| 668 |
+
by an ignored commit that we could not attribute to another revision are
|
| 669 |
+
marked with a <code>*</code>. In the porcelain modes, we print <code>ignored</code> and
|
| 670 |
+
<code>unblamable</code> on a newline respectively.</p>
|
| 671 |
+
</dd>
|
| 672 |
+
<dt class="hdlist1"><code>--ignore-revs-file</code> <em><file></em></dt>
|
| 673 |
+
<dd>
|
| 674 |
+
<p>Ignore revisions listed in <em><file></em>, which must be in the same format as an
|
| 675 |
+
<code>fsck.skipList</code>. This option may be repeated, and these files will be
|
| 676 |
+
processed after any files specified with the <code>blame.ignoreRevsFile</code> config
|
| 677 |
+
option. An empty file name, "", will clear the list of revs from
|
| 678 |
+
previously processed files.</p>
|
| 679 |
+
</dd>
|
| 680 |
+
<dt class="hdlist1"><code>--color-lines</code></dt>
|
| 681 |
+
<dd>
|
| 682 |
+
<p>Color line annotations in the default format differently if they come from
|
| 683 |
+
the same commit as the preceding line. This makes it easier to distinguish
|
| 684 |
+
code blocks introduced by different commits. The color defaults to cyan and
|
| 685 |
+
can be adjusted using the <code>color.blame.repeatedLines</code> config option.</p>
|
| 686 |
+
</dd>
|
| 687 |
+
<dt class="hdlist1"><code>--color-by-age</code></dt>
|
| 688 |
+
<dd>
|
| 689 |
+
<p>Color line annotations depending on the age of the line in
|
| 690 |
+
the default format. The <code>color.blame.highlightRecent</code> config
|
| 691 |
+
option controls what color is used for each range of age.</p>
|
| 692 |
+
</dd>
|
| 693 |
+
<dt class="hdlist1"><code>-h</code></dt>
|
| 694 |
+
<dd>
|
| 695 |
+
<p>Show help message.</p>
|
| 696 |
+
</dd>
|
| 697 |
+
</dl>
|
| 698 |
+
</div>
|
| 699 |
+
</div>
|
| 700 |
+
</div>
|
| 701 |
+
<div class="sect1">
|
| 702 |
+
<h2 id="_see_also">SEE ALSO</h2>
|
| 703 |
+
<div class="sectionbody">
|
| 704 |
+
<div class="paragraph">
|
| 705 |
+
<p><a href="git-blame.html">git-blame(1)</a></p>
|
| 706 |
+
</div>
|
| 707 |
+
</div>
|
| 708 |
+
</div>
|
| 709 |
+
<div class="sect1">
|
| 710 |
+
<h2 id="_git">GIT</h2>
|
| 711 |
+
<div class="sectionbody">
|
| 712 |
+
<div class="paragraph">
|
| 713 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 714 |
+
</div>
|
| 715 |
+
</div>
|
| 716 |
+
</div>
|
| 717 |
+
</div>
|
| 718 |
+
<div id="footer">
|
| 719 |
+
<div id="footer-text">
|
| 720 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 721 |
+
</div>
|
| 722 |
+
</div>
|
| 723 |
+
</body>
|
| 724 |
+
</html>
|
git/mingw64/share/doc/git-doc/git-apply.adoc
ADDED
|
@@ -0,0 +1,299 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-apply(1)
|
| 2 |
+
============
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-apply - Apply a patch to files and/or to the index
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
SYNOPSIS
|
| 10 |
+
--------
|
| 11 |
+
[verse]
|
| 12 |
+
'git apply' [--stat] [--numstat] [--summary] [--check]
|
| 13 |
+
[--index | --intent-to-add] [--3way] [--ours | --theirs | --union]
|
| 14 |
+
[--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
|
| 15 |
+
[--allow-binary-replacement | --binary] [--reject] [-z]
|
| 16 |
+
[-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
|
| 17 |
+
[--ignore-space-change | --ignore-whitespace]
|
| 18 |
+
[--whitespace=(nowarn|warn|fix|error|error-all)]
|
| 19 |
+
[--exclude=<path>] [--include=<path>] [--directory=<root>]
|
| 20 |
+
[--verbose | --quiet] [--unsafe-paths] [--allow-empty] [<patch>...]
|
| 21 |
+
|
| 22 |
+
DESCRIPTION
|
| 23 |
+
-----------
|
| 24 |
+
Reads the supplied diff output (i.e. "a patch") and applies it to files.
|
| 25 |
+
When running from a subdirectory in a repository, patched paths
|
| 26 |
+
outside the directory are ignored.
|
| 27 |
+
With the `--index` option, the patch is also applied to the index, and
|
| 28 |
+
with the `--cached` option, the patch is only applied to the index.
|
| 29 |
+
Without these options, the command applies the patch only to files,
|
| 30 |
+
and does not require them to be in a Git repository.
|
| 31 |
+
|
| 32 |
+
This command applies the patch but does not create a commit. Use
|
| 33 |
+
linkgit:git-am[1] to create commits from patches generated by
|
| 34 |
+
linkgit:git-format-patch[1] and/or received by email.
|
| 35 |
+
|
| 36 |
+
OPTIONS
|
| 37 |
+
-------
|
| 38 |
+
<patch>...::
|
| 39 |
+
The files to read the patch from. '-' can be used to read
|
| 40 |
+
from the standard input.
|
| 41 |
+
|
| 42 |
+
--stat::
|
| 43 |
+
Instead of applying the patch, output diffstat for the
|
| 44 |
+
input. Turns off "apply".
|
| 45 |
+
|
| 46 |
+
--numstat::
|
| 47 |
+
Similar to `--stat`, but shows the number of added and
|
| 48 |
+
deleted lines in decimal notation and the pathname without
|
| 49 |
+
abbreviation, to make it more machine friendly. For
|
| 50 |
+
binary files, outputs two `-` instead of saying
|
| 51 |
+
`0 0`. Turns off "apply".
|
| 52 |
+
|
| 53 |
+
--summary::
|
| 54 |
+
Instead of applying the patch, output a condensed
|
| 55 |
+
summary of information obtained from git diff extended
|
| 56 |
+
headers, such as creations, renames, and mode changes.
|
| 57 |
+
Turns off "apply".
|
| 58 |
+
|
| 59 |
+
--check::
|
| 60 |
+
Instead of applying the patch, see if the patch is
|
| 61 |
+
applicable to the current working tree and/or the index
|
| 62 |
+
file and detects errors. Turns off "apply".
|
| 63 |
+
|
| 64 |
+
--index::
|
| 65 |
+
Apply the patch to both the index and the working tree (or
|
| 66 |
+
merely check that it would apply cleanly to both if `--check` is
|
| 67 |
+
in effect). Note that `--index` expects index entries and
|
| 68 |
+
working tree copies for relevant paths to be identical (their
|
| 69 |
+
contents and metadata such as file mode must match), and will
|
| 70 |
+
raise an error if they are not, even if the patch would apply
|
| 71 |
+
cleanly to both the index and the working tree in isolation.
|
| 72 |
+
|
| 73 |
+
--cached::
|
| 74 |
+
Apply the patch to just the index, without touching the working
|
| 75 |
+
tree. If `--check` is in effect, merely check that it would
|
| 76 |
+
apply cleanly to the index entry.
|
| 77 |
+
|
| 78 |
+
-N::
|
| 79 |
+
--intent-to-add::
|
| 80 |
+
When applying the patch only to the working tree, mark new
|
| 81 |
+
files to be added to the index later (see `--intent-to-add`
|
| 82 |
+
option in linkgit:git-add[1]). This option is ignored if
|
| 83 |
+
`--index` or `--cached` are used, and has no effect outside a Git
|
| 84 |
+
repository. Note that `--index` could be implied by other options
|
| 85 |
+
such as `--3way`.
|
| 86 |
+
|
| 87 |
+
-3::
|
| 88 |
+
--3way::
|
| 89 |
+
Attempt 3-way merge if the patch records the identity of blobs it is supposed
|
| 90 |
+
to apply to and we have those blobs available locally, possibly leaving the
|
| 91 |
+
conflict markers in the files in the working tree for the user to
|
| 92 |
+
resolve. This option implies the `--index` option unless the
|
| 93 |
+
`--cached` option is used, and is incompatible with the `--reject` option.
|
| 94 |
+
When used with the `--cached` option, any conflicts are left at higher stages
|
| 95 |
+
in the cache.
|
| 96 |
+
|
| 97 |
+
--ours::
|
| 98 |
+
--theirs::
|
| 99 |
+
--union::
|
| 100 |
+
Instead of leaving conflicts in the file, resolve conflicts favouring
|
| 101 |
+
our (or their or both) side of the lines. Requires --3way.
|
| 102 |
+
|
| 103 |
+
--build-fake-ancestor=<file>::
|
| 104 |
+
Newer 'git diff' output has embedded 'index information'
|
| 105 |
+
for each blob to help identify the original version that
|
| 106 |
+
the patch applies to. When this flag is given, and if
|
| 107 |
+
the original versions of the blobs are available locally,
|
| 108 |
+
builds a temporary index containing those blobs.
|
| 109 |
+
+
|
| 110 |
+
When a pure mode change is encountered (which has no index information),
|
| 111 |
+
the information is read from the current index instead.
|
| 112 |
+
|
| 113 |
+
-R::
|
| 114 |
+
--reverse::
|
| 115 |
+
Apply the patch in reverse.
|
| 116 |
+
|
| 117 |
+
--reject::
|
| 118 |
+
For atomicity, 'git apply' by default fails the whole patch and
|
| 119 |
+
does not touch the working tree when some of the hunks
|
| 120 |
+
do not apply. This option makes it apply
|
| 121 |
+
the parts of the patch that are applicable, and leave the
|
| 122 |
+
rejected hunks in corresponding *.rej files.
|
| 123 |
+
|
| 124 |
+
-z::
|
| 125 |
+
When `--numstat` has been given, do not munge pathnames,
|
| 126 |
+
but use a NUL-terminated machine-readable format.
|
| 127 |
+
+
|
| 128 |
+
Without this option, pathnames with "unusual" characters are quoted as
|
| 129 |
+
explained for the configuration variable `core.quotePath` (see
|
| 130 |
+
linkgit:git-config[1]).
|
| 131 |
+
|
| 132 |
+
-p<n>::
|
| 133 |
+
Remove <n> leading path components (separated by slashes) from
|
| 134 |
+
traditional diff paths. E.g., with `-p2`, a patch against
|
| 135 |
+
`a/dir/file` will be applied directly to `file`. The default is
|
| 136 |
+
1.
|
| 137 |
+
|
| 138 |
+
-C<n>::
|
| 139 |
+
Ensure at least <n> lines of surrounding context match before
|
| 140 |
+
and after each change. When fewer lines of surrounding
|
| 141 |
+
context exist they all must match. By default no context is
|
| 142 |
+
ever ignored.
|
| 143 |
+
|
| 144 |
+
--unidiff-zero::
|
| 145 |
+
By default, 'git apply' expects that the patch being
|
| 146 |
+
applied is a unified diff with at least one line of context.
|
| 147 |
+
This provides good safety measures, but breaks down when
|
| 148 |
+
applying a diff generated with `--unified=0`. To bypass these
|
| 149 |
+
checks use `--unidiff-zero`.
|
| 150 |
+
+
|
| 151 |
+
Note, for the reasons stated above, the usage of context-free patches is
|
| 152 |
+
discouraged.
|
| 153 |
+
|
| 154 |
+
--apply::
|
| 155 |
+
If you use any of the options marked "Turns off
|
| 156 |
+
'apply'" above, 'git apply' reads and outputs the
|
| 157 |
+
requested information without actually applying the
|
| 158 |
+
patch. Give this flag after those flags to also apply
|
| 159 |
+
the patch.
|
| 160 |
+
|
| 161 |
+
--no-add::
|
| 162 |
+
When applying a patch, ignore additions made by the
|
| 163 |
+
patch. This can be used to extract the common part between
|
| 164 |
+
two files by first running 'diff' on them and applying
|
| 165 |
+
the result with this option, which would apply the
|
| 166 |
+
deletion part but not the addition part.
|
| 167 |
+
|
| 168 |
+
--allow-binary-replacement::
|
| 169 |
+
--binary::
|
| 170 |
+
Historically we did not allow binary patch application
|
| 171 |
+
without an explicit permission from the user, and this
|
| 172 |
+
flag was the way to do so. Currently, we always allow binary
|
| 173 |
+
patch application, so this is a no-op.
|
| 174 |
+
|
| 175 |
+
--exclude=<path-pattern>::
|
| 176 |
+
Don't apply changes to files matching the given path pattern. This can
|
| 177 |
+
be useful when importing patchsets, where you want to exclude certain
|
| 178 |
+
files or directories.
|
| 179 |
+
|
| 180 |
+
--include=<path-pattern>::
|
| 181 |
+
Apply changes to files matching the given path pattern. This can
|
| 182 |
+
be useful when importing patchsets, where you want to include certain
|
| 183 |
+
files or directories.
|
| 184 |
+
+
|
| 185 |
+
When `--exclude` and `--include` patterns are used, they are examined in the
|
| 186 |
+
order they appear on the command line, and the first match determines if a
|
| 187 |
+
patch to each path is used. A patch to a path that does not match any
|
| 188 |
+
include/exclude pattern is used by default if there is no include pattern
|
| 189 |
+
on the command line, and ignored if there is any include pattern.
|
| 190 |
+
|
| 191 |
+
--ignore-space-change::
|
| 192 |
+
--ignore-whitespace::
|
| 193 |
+
When applying a patch, ignore changes in whitespace in context
|
| 194 |
+
lines if necessary.
|
| 195 |
+
Context lines will preserve their whitespace, and they will not
|
| 196 |
+
undergo whitespace fixing regardless of the value of the
|
| 197 |
+
`--whitespace` option. New lines will still be fixed, though.
|
| 198 |
+
|
| 199 |
+
--whitespace=<action>::
|
| 200 |
+
When applying a patch, detect a new or modified line that has
|
| 201 |
+
whitespace errors. What are considered whitespace errors is
|
| 202 |
+
controlled by `core.whitespace` configuration. By default,
|
| 203 |
+
trailing whitespaces (including lines that solely consist of
|
| 204 |
+
whitespaces) and a space character that is immediately followed
|
| 205 |
+
by a tab character inside the initial indent of the line are
|
| 206 |
+
considered whitespace errors.
|
| 207 |
+
+
|
| 208 |
+
By default, the command outputs warning messages but applies the patch.
|
| 209 |
+
When `git-apply` is used for statistics and not applying a
|
| 210 |
+
patch, it defaults to `nowarn`.
|
| 211 |
+
+
|
| 212 |
+
You can use different `<action>` values to control this
|
| 213 |
+
behavior:
|
| 214 |
+
+
|
| 215 |
+
* `nowarn` turns off the trailing whitespace warning.
|
| 216 |
+
* `warn` outputs warnings for a few such errors, but applies the
|
| 217 |
+
patch as-is (default).
|
| 218 |
+
* `fix` outputs warnings for a few such errors, and applies the
|
| 219 |
+
patch after fixing them (`strip` is a synonym -- the tool
|
| 220 |
+
used to consider only trailing whitespace characters as errors, and the
|
| 221 |
+
fix involved 'stripping' them, but modern Gits do more).
|
| 222 |
+
* `error` outputs warnings for a few such errors, and refuses
|
| 223 |
+
to apply the patch.
|
| 224 |
+
* `error-all` is similar to `error` but shows all errors.
|
| 225 |
+
|
| 226 |
+
--inaccurate-eof::
|
| 227 |
+
Under certain circumstances, some versions of 'diff' do not correctly
|
| 228 |
+
detect a missing new-line at the end of the file. As a result, patches
|
| 229 |
+
created by such 'diff' programs do not record incomplete lines
|
| 230 |
+
correctly. This option adds support for applying such patches by
|
| 231 |
+
working around this bug.
|
| 232 |
+
|
| 233 |
+
-v::
|
| 234 |
+
--verbose::
|
| 235 |
+
Report progress to stderr. By default, only a message about the
|
| 236 |
+
current patch being applied will be printed. This option will cause
|
| 237 |
+
additional information to be reported.
|
| 238 |
+
|
| 239 |
+
-q::
|
| 240 |
+
--quiet::
|
| 241 |
+
Suppress stderr output. Messages about patch status and progress
|
| 242 |
+
will not be printed.
|
| 243 |
+
|
| 244 |
+
--recount::
|
| 245 |
+
Do not trust the line counts in the hunk headers, but infer them
|
| 246 |
+
by inspecting the patch (e.g. after editing the patch without
|
| 247 |
+
adjusting the hunk headers appropriately).
|
| 248 |
+
|
| 249 |
+
--directory=<root>::
|
| 250 |
+
Prepend <root> to all filenames. If a "-p" argument was also passed,
|
| 251 |
+
it is applied before prepending the new root.
|
| 252 |
+
+
|
| 253 |
+
For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`
|
| 254 |
+
can be applied to the file in the working tree `modules/git-gui/git-gui.sh` by
|
| 255 |
+
running `git apply --directory=modules/git-gui`.
|
| 256 |
+
|
| 257 |
+
--unsafe-paths::
|
| 258 |
+
By default, a patch that affects outside the working area
|
| 259 |
+
(either a Git controlled working tree, or the current working
|
| 260 |
+
directory when "git apply" is used as a replacement of GNU
|
| 261 |
+
patch) is rejected as a mistake (or a mischief).
|
| 262 |
+
+
|
| 263 |
+
When `git apply` is used as a "better GNU patch", the user can pass
|
| 264 |
+
the `--unsafe-paths` option to override this safety check. This option
|
| 265 |
+
has no effect when `--index` or `--cached` is in use.
|
| 266 |
+
|
| 267 |
+
--allow-empty::
|
| 268 |
+
Don't return an error for patches containing no diff. This includes
|
| 269 |
+
empty patches and patches with commit text only.
|
| 270 |
+
|
| 271 |
+
CONFIGURATION
|
| 272 |
+
-------------
|
| 273 |
+
|
| 274 |
+
include::includes/cmd-config-section-all.adoc[]
|
| 275 |
+
|
| 276 |
+
include::config/apply.adoc[]
|
| 277 |
+
|
| 278 |
+
SUBMODULES
|
| 279 |
+
----------
|
| 280 |
+
If the patch contains any changes to submodules then 'git apply'
|
| 281 |
+
treats these changes as follows.
|
| 282 |
+
|
| 283 |
+
If `--index` is specified (explicitly or implicitly), then the submodule
|
| 284 |
+
commits must match the index exactly for the patch to apply. If any
|
| 285 |
+
of the submodules are checked-out, then these check-outs are completely
|
| 286 |
+
ignored, i.e., they are not required to be up to date or clean and they
|
| 287 |
+
are not updated.
|
| 288 |
+
|
| 289 |
+
If `--index` is not specified, then the submodule commits in the patch
|
| 290 |
+
are ignored and only the absence or presence of the corresponding
|
| 291 |
+
subdirectory is checked and (if possible) updated.
|
| 292 |
+
|
| 293 |
+
SEE ALSO
|
| 294 |
+
--------
|
| 295 |
+
linkgit:git-am[1].
|
| 296 |
+
|
| 297 |
+
GIT
|
| 298 |
+
---
|
| 299 |
+
Part of the linkgit:git[1] suite
|
git/mingw64/share/doc/git-doc/git-apply.html
ADDED
|
@@ -0,0 +1,852 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-apply(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-apply(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-apply - Apply a patch to files and/or to the index</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content"><em>git apply</em> [--stat] [--numstat] [--summary] [--check]
|
| 456 |
+
[--index | --intent-to-add] [--3way] [--ours | --theirs | --union]
|
| 457 |
+
[--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
|
| 458 |
+
[--allow-binary-replacement | --binary] [--reject] [-z]
|
| 459 |
+
[-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
|
| 460 |
+
[--ignore-space-change | --ignore-whitespace]
|
| 461 |
+
[--whitespace=(nowarn|warn|fix|error|error-all)]
|
| 462 |
+
[--exclude=<path>] [--include=<path>] [--directory=<root>]
|
| 463 |
+
[--verbose | --quiet] [--unsafe-paths] [--allow-empty] [<patch>…​]</pre>
|
| 464 |
+
</div>
|
| 465 |
+
</div>
|
| 466 |
+
</div>
|
| 467 |
+
<div class="sect1">
|
| 468 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 469 |
+
<div class="sectionbody">
|
| 470 |
+
<div class="paragraph">
|
| 471 |
+
<p>Reads the supplied diff output (i.e. "a patch") and applies it to files.
|
| 472 |
+
When running from a subdirectory in a repository, patched paths
|
| 473 |
+
outside the directory are ignored.
|
| 474 |
+
With the <code>--index</code> option, the patch is also applied to the index, and
|
| 475 |
+
with the <code>--cached</code> option, the patch is only applied to the index.
|
| 476 |
+
Without these options, the command applies the patch only to files,
|
| 477 |
+
and does not require them to be in a Git repository.</p>
|
| 478 |
+
</div>
|
| 479 |
+
<div class="paragraph">
|
| 480 |
+
<p>This command applies the patch but does not create a commit. Use
|
| 481 |
+
<a href="git-am.html">git-am(1)</a> to create commits from patches generated by
|
| 482 |
+
<a href="git-format-patch.html">git-format-patch(1)</a> and/or received by email.</p>
|
| 483 |
+
</div>
|
| 484 |
+
</div>
|
| 485 |
+
</div>
|
| 486 |
+
<div class="sect1">
|
| 487 |
+
<h2 id="_options">OPTIONS</h2>
|
| 488 |
+
<div class="sectionbody">
|
| 489 |
+
<div class="dlist">
|
| 490 |
+
<dl>
|
| 491 |
+
<dt class="hdlist1"><patch>…​</dt>
|
| 492 |
+
<dd>
|
| 493 |
+
<p>The files to read the patch from. <em>-</em> can be used to read
|
| 494 |
+
from the standard input.</p>
|
| 495 |
+
</dd>
|
| 496 |
+
<dt class="hdlist1">--stat</dt>
|
| 497 |
+
<dd>
|
| 498 |
+
<p>Instead of applying the patch, output diffstat for the
|
| 499 |
+
input. Turns off "apply".</p>
|
| 500 |
+
</dd>
|
| 501 |
+
<dt class="hdlist1">--numstat</dt>
|
| 502 |
+
<dd>
|
| 503 |
+
<p>Similar to <code>--stat</code>, but shows the number of added and
|
| 504 |
+
deleted lines in decimal notation and the pathname without
|
| 505 |
+
abbreviation, to make it more machine friendly. For
|
| 506 |
+
binary files, outputs two <code>-</code> instead of saying
|
| 507 |
+
<code>0</code> <code>0</code>. Turns off "apply".</p>
|
| 508 |
+
</dd>
|
| 509 |
+
<dt class="hdlist1">--summary</dt>
|
| 510 |
+
<dd>
|
| 511 |
+
<p>Instead of applying the patch, output a condensed
|
| 512 |
+
summary of information obtained from git diff extended
|
| 513 |
+
headers, such as creations, renames, and mode changes.
|
| 514 |
+
Turns off "apply".</p>
|
| 515 |
+
</dd>
|
| 516 |
+
<dt class="hdlist1">--check</dt>
|
| 517 |
+
<dd>
|
| 518 |
+
<p>Instead of applying the patch, see if the patch is
|
| 519 |
+
applicable to the current working tree and/or the index
|
| 520 |
+
file and detects errors. Turns off "apply".</p>
|
| 521 |
+
</dd>
|
| 522 |
+
<dt class="hdlist1">--index</dt>
|
| 523 |
+
<dd>
|
| 524 |
+
<p>Apply the patch to both the index and the working tree (or
|
| 525 |
+
merely check that it would apply cleanly to both if <code>--check</code> is
|
| 526 |
+
in effect). Note that <code>--index</code> expects index entries and
|
| 527 |
+
working tree copies for relevant paths to be identical (their
|
| 528 |
+
contents and metadata such as file mode must match), and will
|
| 529 |
+
raise an error if they are not, even if the patch would apply
|
| 530 |
+
cleanly to both the index and the working tree in isolation.</p>
|
| 531 |
+
</dd>
|
| 532 |
+
<dt class="hdlist1">--cached</dt>
|
| 533 |
+
<dd>
|
| 534 |
+
<p>Apply the patch to just the index, without touching the working
|
| 535 |
+
tree. If <code>--check</code> is in effect, merely check that it would
|
| 536 |
+
apply cleanly to the index entry.</p>
|
| 537 |
+
</dd>
|
| 538 |
+
<dt class="hdlist1">-N</dt>
|
| 539 |
+
<dt class="hdlist1">--intent-to-add</dt>
|
| 540 |
+
<dd>
|
| 541 |
+
<p>When applying the patch only to the working tree, mark new
|
| 542 |
+
files to be added to the index later (see <code>--intent-to-add</code>
|
| 543 |
+
option in <a href="git-add.html">git-add(1)</a>). This option is ignored if
|
| 544 |
+
<code>--index</code> or <code>--cached</code> are used, and has no effect outside a Git
|
| 545 |
+
repository. Note that <code>--index</code> could be implied by other options
|
| 546 |
+
such as <code>--3way</code>.</p>
|
| 547 |
+
</dd>
|
| 548 |
+
<dt class="hdlist1">-3</dt>
|
| 549 |
+
<dt class="hdlist1">--3way</dt>
|
| 550 |
+
<dd>
|
| 551 |
+
<p>Attempt 3-way merge if the patch records the identity of blobs it is supposed
|
| 552 |
+
to apply to and we have those blobs available locally, possibly leaving the
|
| 553 |
+
conflict markers in the files in the working tree for the user to
|
| 554 |
+
resolve. This option implies the <code>--index</code> option unless the
|
| 555 |
+
<code>--cached</code> option is used, and is incompatible with the <code>--reject</code> option.
|
| 556 |
+
When used with the <code>--cached</code> option, any conflicts are left at higher stages
|
| 557 |
+
in the cache.</p>
|
| 558 |
+
</dd>
|
| 559 |
+
<dt class="hdlist1">--ours</dt>
|
| 560 |
+
<dt class="hdlist1">--theirs</dt>
|
| 561 |
+
<dt class="hdlist1">--union</dt>
|
| 562 |
+
<dd>
|
| 563 |
+
<p>Instead of leaving conflicts in the file, resolve conflicts favouring
|
| 564 |
+
our (or their or both) side of the lines. Requires --3way.</p>
|
| 565 |
+
</dd>
|
| 566 |
+
<dt class="hdlist1">--build-fake-ancestor=<file></dt>
|
| 567 |
+
<dd>
|
| 568 |
+
<p>Newer <em>git diff</em> output has embedded <em>index information</em>
|
| 569 |
+
for each blob to help identify the original version that
|
| 570 |
+
the patch applies to. When this flag is given, and if
|
| 571 |
+
the original versions of the blobs are available locally,
|
| 572 |
+
builds a temporary index containing those blobs.</p>
|
| 573 |
+
<div class="paragraph">
|
| 574 |
+
<p>When a pure mode change is encountered (which has no index information),
|
| 575 |
+
the information is read from the current index instead.</p>
|
| 576 |
+
</div>
|
| 577 |
+
</dd>
|
| 578 |
+
<dt class="hdlist1">-R</dt>
|
| 579 |
+
<dt class="hdlist1">--reverse</dt>
|
| 580 |
+
<dd>
|
| 581 |
+
<p>Apply the patch in reverse.</p>
|
| 582 |
+
</dd>
|
| 583 |
+
<dt class="hdlist1">--reject</dt>
|
| 584 |
+
<dd>
|
| 585 |
+
<p>For atomicity, <em>git apply</em> by default fails the whole patch and
|
| 586 |
+
does not touch the working tree when some of the hunks
|
| 587 |
+
do not apply. This option makes it apply
|
| 588 |
+
the parts of the patch that are applicable, and leave the
|
| 589 |
+
rejected hunks in corresponding *.rej files.</p>
|
| 590 |
+
</dd>
|
| 591 |
+
<dt class="hdlist1">-z</dt>
|
| 592 |
+
<dd>
|
| 593 |
+
<p>When <code>--numstat</code> has been given, do not munge pathnames,
|
| 594 |
+
but use a NUL-terminated machine-readable format.</p>
|
| 595 |
+
<div class="paragraph">
|
| 596 |
+
<p>Without this option, pathnames with "unusual" characters are quoted as
|
| 597 |
+
explained for the configuration variable <code>core.quotePath</code> (see
|
| 598 |
+
<a href="git-config.html">git-config(1)</a>).</p>
|
| 599 |
+
</div>
|
| 600 |
+
</dd>
|
| 601 |
+
<dt class="hdlist1">-p<n></dt>
|
| 602 |
+
<dd>
|
| 603 |
+
<p>Remove <n> leading path components (separated by slashes) from
|
| 604 |
+
traditional diff paths. E.g., with <code>-p2</code>, a patch against
|
| 605 |
+
<code>a/dir/file</code> will be applied directly to <code>file</code>. The default is
|
| 606 |
+
1.</p>
|
| 607 |
+
</dd>
|
| 608 |
+
<dt class="hdlist1">-C<n></dt>
|
| 609 |
+
<dd>
|
| 610 |
+
<p>Ensure at least <n> lines of surrounding context match before
|
| 611 |
+
and after each change. When fewer lines of surrounding
|
| 612 |
+
context exist they all must match. By default no context is
|
| 613 |
+
ever ignored.</p>
|
| 614 |
+
</dd>
|
| 615 |
+
<dt class="hdlist1">--unidiff-zero</dt>
|
| 616 |
+
<dd>
|
| 617 |
+
<p>By default, <em>git apply</em> expects that the patch being
|
| 618 |
+
applied is a unified diff with at least one line of context.
|
| 619 |
+
This provides good safety measures, but breaks down when
|
| 620 |
+
applying a diff generated with <code>--unified=0</code>. To bypass these
|
| 621 |
+
checks use <code>--unidiff-zero</code>.</p>
|
| 622 |
+
<div class="paragraph">
|
| 623 |
+
<p>Note, for the reasons stated above, the usage of context-free patches is
|
| 624 |
+
discouraged.</p>
|
| 625 |
+
</div>
|
| 626 |
+
</dd>
|
| 627 |
+
<dt class="hdlist1">--apply</dt>
|
| 628 |
+
<dd>
|
| 629 |
+
<p>If you use any of the options marked "Turns off
|
| 630 |
+
<em>apply</em>" above, <em>git apply</em> reads and outputs the
|
| 631 |
+
requested information without actually applying the
|
| 632 |
+
patch. Give this flag after those flags to also apply
|
| 633 |
+
the patch.</p>
|
| 634 |
+
</dd>
|
| 635 |
+
<dt class="hdlist1">--no-add</dt>
|
| 636 |
+
<dd>
|
| 637 |
+
<p>When applying a patch, ignore additions made by the
|
| 638 |
+
patch. This can be used to extract the common part between
|
| 639 |
+
two files by first running <em>diff</em> on them and applying
|
| 640 |
+
the result with this option, which would apply the
|
| 641 |
+
deletion part but not the addition part.</p>
|
| 642 |
+
</dd>
|
| 643 |
+
<dt class="hdlist1">--allow-binary-replacement</dt>
|
| 644 |
+
<dt class="hdlist1">--binary</dt>
|
| 645 |
+
<dd>
|
| 646 |
+
<p>Historically we did not allow binary patch application
|
| 647 |
+
without an explicit permission from the user, and this
|
| 648 |
+
flag was the way to do so. Currently, we always allow binary
|
| 649 |
+
patch application, so this is a no-op.</p>
|
| 650 |
+
</dd>
|
| 651 |
+
<dt class="hdlist1">--exclude=<path-pattern></dt>
|
| 652 |
+
<dd>
|
| 653 |
+
<p>Don’t apply changes to files matching the given path pattern. This can
|
| 654 |
+
be useful when importing patchsets, where you want to exclude certain
|
| 655 |
+
files or directories.</p>
|
| 656 |
+
</dd>
|
| 657 |
+
<dt class="hdlist1">--include=<path-pattern></dt>
|
| 658 |
+
<dd>
|
| 659 |
+
<p>Apply changes to files matching the given path pattern. This can
|
| 660 |
+
be useful when importing patchsets, where you want to include certain
|
| 661 |
+
files or directories.</p>
|
| 662 |
+
<div class="paragraph">
|
| 663 |
+
<p>When <code>--exclude</code> and <code>--include</code> patterns are used, they are examined in the
|
| 664 |
+
order they appear on the command line, and the first match determines if a
|
| 665 |
+
patch to each path is used. A patch to a path that does not match any
|
| 666 |
+
include/exclude pattern is used by default if there is no include pattern
|
| 667 |
+
on the command line, and ignored if there is any include pattern.</p>
|
| 668 |
+
</div>
|
| 669 |
+
</dd>
|
| 670 |
+
<dt class="hdlist1">--ignore-space-change</dt>
|
| 671 |
+
<dt class="hdlist1">--ignore-whitespace</dt>
|
| 672 |
+
<dd>
|
| 673 |
+
<p>When applying a patch, ignore changes in whitespace in context
|
| 674 |
+
lines if necessary.
|
| 675 |
+
Context lines will preserve their whitespace, and they will not
|
| 676 |
+
undergo whitespace fixing regardless of the value of the
|
| 677 |
+
<code>--whitespace</code> option. New lines will still be fixed, though.</p>
|
| 678 |
+
</dd>
|
| 679 |
+
<dt class="hdlist1">--whitespace=<action></dt>
|
| 680 |
+
<dd>
|
| 681 |
+
<p>When applying a patch, detect a new or modified line that has
|
| 682 |
+
whitespace errors. What are considered whitespace errors is
|
| 683 |
+
controlled by <code>core.whitespace</code> configuration. By default,
|
| 684 |
+
trailing whitespaces (including lines that solely consist of
|
| 685 |
+
whitespaces) and a space character that is immediately followed
|
| 686 |
+
by a tab character inside the initial indent of the line are
|
| 687 |
+
considered whitespace errors.</p>
|
| 688 |
+
<div class="paragraph">
|
| 689 |
+
<p>By default, the command outputs warning messages but applies the patch.
|
| 690 |
+
When <code>git-apply</code> is used for statistics and not applying a
|
| 691 |
+
patch, it defaults to <code>nowarn</code>.</p>
|
| 692 |
+
</div>
|
| 693 |
+
<div class="paragraph">
|
| 694 |
+
<p>You can use different <em><action></em> values to control this
|
| 695 |
+
behavior:</p>
|
| 696 |
+
</div>
|
| 697 |
+
<div class="ulist">
|
| 698 |
+
<ul>
|
| 699 |
+
<li>
|
| 700 |
+
<p><code>nowarn</code> turns off the trailing whitespace warning.</p>
|
| 701 |
+
</li>
|
| 702 |
+
<li>
|
| 703 |
+
<p><code>warn</code> outputs warnings for a few such errors, but applies the
|
| 704 |
+
patch as-is (default).</p>
|
| 705 |
+
</li>
|
| 706 |
+
<li>
|
| 707 |
+
<p><code>fix</code> outputs warnings for a few such errors, and applies the
|
| 708 |
+
patch after fixing them (<code>strip</code> is a synonym — the tool
|
| 709 |
+
used to consider only trailing whitespace characters as errors, and the
|
| 710 |
+
fix involved <em>stripping</em> them, but modern Gits do more).</p>
|
| 711 |
+
</li>
|
| 712 |
+
<li>
|
| 713 |
+
<p><code>error</code> outputs warnings for a few such errors, and refuses
|
| 714 |
+
to apply the patch.</p>
|
| 715 |
+
</li>
|
| 716 |
+
<li>
|
| 717 |
+
<p><code>error-all</code> is similar to <code>error</code> but shows all errors.</p>
|
| 718 |
+
</li>
|
| 719 |
+
</ul>
|
| 720 |
+
</div>
|
| 721 |
+
</dd>
|
| 722 |
+
<dt class="hdlist1">--inaccurate-eof</dt>
|
| 723 |
+
<dd>
|
| 724 |
+
<p>Under certain circumstances, some versions of <em>diff</em> do not correctly
|
| 725 |
+
detect a missing new-line at the end of the file. As a result, patches
|
| 726 |
+
created by such <em>diff</em> programs do not record incomplete lines
|
| 727 |
+
correctly. This option adds support for applying such patches by
|
| 728 |
+
working around this bug.</p>
|
| 729 |
+
</dd>
|
| 730 |
+
<dt class="hdlist1">-v</dt>
|
| 731 |
+
<dt class="hdlist1">--verbose</dt>
|
| 732 |
+
<dd>
|
| 733 |
+
<p>Report progress to stderr. By default, only a message about the
|
| 734 |
+
current patch being applied will be printed. This option will cause
|
| 735 |
+
additional information to be reported.</p>
|
| 736 |
+
</dd>
|
| 737 |
+
<dt class="hdlist1">-q</dt>
|
| 738 |
+
<dt class="hdlist1">--quiet</dt>
|
| 739 |
+
<dd>
|
| 740 |
+
<p>Suppress stderr output. Messages about patch status and progress
|
| 741 |
+
will not be printed.</p>
|
| 742 |
+
</dd>
|
| 743 |
+
<dt class="hdlist1">--recount</dt>
|
| 744 |
+
<dd>
|
| 745 |
+
<p>Do not trust the line counts in the hunk headers, but infer them
|
| 746 |
+
by inspecting the patch (e.g. after editing the patch without
|
| 747 |
+
adjusting the hunk headers appropriately).</p>
|
| 748 |
+
</dd>
|
| 749 |
+
<dt class="hdlist1">--directory=<root></dt>
|
| 750 |
+
<dd>
|
| 751 |
+
<p>Prepend <root> to all filenames. If a "-p" argument was also passed,
|
| 752 |
+
it is applied before prepending the new root.</p>
|
| 753 |
+
<div class="paragraph">
|
| 754 |
+
<p>For example, a patch that talks about updating <code>a/git-gui.sh</code> to <code>b/git-gui.sh</code>
|
| 755 |
+
can be applied to the file in the working tree <code>modules/git-gui/git-gui.sh</code> by
|
| 756 |
+
running <code>git</code> <code>apply</code> <code>--directory=modules/git-gui</code>.</p>
|
| 757 |
+
</div>
|
| 758 |
+
</dd>
|
| 759 |
+
<dt class="hdlist1">--unsafe-paths</dt>
|
| 760 |
+
<dd>
|
| 761 |
+
<p>By default, a patch that affects outside the working area
|
| 762 |
+
(either a Git controlled working tree, or the current working
|
| 763 |
+
directory when "git apply" is used as a replacement of GNU
|
| 764 |
+
patch) is rejected as a mistake (or a mischief).</p>
|
| 765 |
+
<div class="paragraph">
|
| 766 |
+
<p>When <code>git</code> <code>apply</code> is used as a "better GNU patch", the user can pass
|
| 767 |
+
the <code>--unsafe-paths</code> option to override this safety check. This option
|
| 768 |
+
has no effect when <code>--index</code> or <code>--cached</code> is in use.</p>
|
| 769 |
+
</div>
|
| 770 |
+
</dd>
|
| 771 |
+
<dt class="hdlist1">--allow-empty</dt>
|
| 772 |
+
<dd>
|
| 773 |
+
<p>Don’t return an error for patches containing no diff. This includes
|
| 774 |
+
empty patches and patches with commit text only.</p>
|
| 775 |
+
</dd>
|
| 776 |
+
</dl>
|
| 777 |
+
</div>
|
| 778 |
+
</div>
|
| 779 |
+
</div>
|
| 780 |
+
<div class="sect1">
|
| 781 |
+
<h2 id="_configuration">CONFIGURATION</h2>
|
| 782 |
+
<div class="sectionbody">
|
| 783 |
+
<div class="paragraph">
|
| 784 |
+
<p>Everything below this line in this section is selectively included
|
| 785 |
+
from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
|
| 786 |
+
as what’s found there:</p>
|
| 787 |
+
</div>
|
| 788 |
+
<div class="dlist">
|
| 789 |
+
<dl>
|
| 790 |
+
<dt class="hdlist1">apply.ignoreWhitespace</dt>
|
| 791 |
+
<dd>
|
| 792 |
+
<p>When set to <em>change</em>, tells <em>git apply</em> to ignore changes in
|
| 793 |
+
whitespace, in the same way as the <code>--ignore-space-change</code>
|
| 794 |
+
option.
|
| 795 |
+
When set to one of: no, none, never, false, it tells <em>git apply</em> to
|
| 796 |
+
respect all whitespace differences.
|
| 797 |
+
See <a href="git-apply.html">git-apply(1)</a>.</p>
|
| 798 |
+
</dd>
|
| 799 |
+
<dt class="hdlist1">apply.whitespace</dt>
|
| 800 |
+
<dd>
|
| 801 |
+
<p>Tells <em>git apply</em> how to handle whitespace, in the same way
|
| 802 |
+
as the <code>--whitespace</code> option. See <a href="git-apply.html">git-apply(1)</a>.</p>
|
| 803 |
+
</dd>
|
| 804 |
+
</dl>
|
| 805 |
+
</div>
|
| 806 |
+
</div>
|
| 807 |
+
</div>
|
| 808 |
+
<div class="sect1">
|
| 809 |
+
<h2 id="_submodules">SUBMODULES</h2>
|
| 810 |
+
<div class="sectionbody">
|
| 811 |
+
<div class="paragraph">
|
| 812 |
+
<p>If the patch contains any changes to submodules then <em>git apply</em>
|
| 813 |
+
treats these changes as follows.</p>
|
| 814 |
+
</div>
|
| 815 |
+
<div class="paragraph">
|
| 816 |
+
<p>If <code>--index</code> is specified (explicitly or implicitly), then the submodule
|
| 817 |
+
commits must match the index exactly for the patch to apply. If any
|
| 818 |
+
of the submodules are checked-out, then these check-outs are completely
|
| 819 |
+
ignored, i.e., they are not required to be up to date or clean and they
|
| 820 |
+
are not updated.</p>
|
| 821 |
+
</div>
|
| 822 |
+
<div class="paragraph">
|
| 823 |
+
<p>If <code>--index</code> is not specified, then the submodule commits in the patch
|
| 824 |
+
are ignored and only the absence or presence of the corresponding
|
| 825 |
+
subdirectory is checked and (if possible) updated.</p>
|
| 826 |
+
</div>
|
| 827 |
+
</div>
|
| 828 |
+
</div>
|
| 829 |
+
<div class="sect1">
|
| 830 |
+
<h2 id="_see_also">SEE ALSO</h2>
|
| 831 |
+
<div class="sectionbody">
|
| 832 |
+
<div class="paragraph">
|
| 833 |
+
<p><a href="git-am.html">git-am(1)</a>.</p>
|
| 834 |
+
</div>
|
| 835 |
+
</div>
|
| 836 |
+
</div>
|
| 837 |
+
<div class="sect1">
|
| 838 |
+
<h2 id="_git">GIT</h2>
|
| 839 |
+
<div class="sectionbody">
|
| 840 |
+
<div class="paragraph">
|
| 841 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 842 |
+
</div>
|
| 843 |
+
</div>
|
| 844 |
+
</div>
|
| 845 |
+
</div>
|
| 846 |
+
<div id="footer">
|
| 847 |
+
<div id="footer-text">
|
| 848 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 849 |
+
</div>
|
| 850 |
+
</div>
|
| 851 |
+
</body>
|
| 852 |
+
</html>
|
git/mingw64/share/doc/git-doc/git-archive.adoc
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-archive(1)
|
| 2 |
+
==============
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-archive - Create an archive of files from a named tree
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
SYNOPSIS
|
| 10 |
+
--------
|
| 11 |
+
[verse]
|
| 12 |
+
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
|
| 13 |
+
[-o <file> | --output=<file>] [--worktree-attributes]
|
| 14 |
+
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
|
| 15 |
+
[<path>...]
|
| 16 |
+
|
| 17 |
+
DESCRIPTION
|
| 18 |
+
-----------
|
| 19 |
+
Creates an archive of the specified format containing the tree
|
| 20 |
+
structure for the named tree, and writes it out to the standard
|
| 21 |
+
output. If <prefix> is specified it is
|
| 22 |
+
prepended to the filenames in the archive.
|
| 23 |
+
|
| 24 |
+
'git archive' behaves differently when given a tree ID as opposed to a
|
| 25 |
+
commit ID or tag ID. When a tree ID is provided, the current time is
|
| 26 |
+
used as the modification time of each file in the archive. On the
|
| 27 |
+
other hand, when a commit ID or tag ID is provided, the commit time as
|
| 28 |
+
recorded in the referenced commit object is used instead.
|
| 29 |
+
Additionally the commit ID is stored in a global extended pax header
|
| 30 |
+
if the tar format is used; it can be extracted using 'git
|
| 31 |
+
get-tar-commit-id'. In ZIP files it is stored as a file comment.
|
| 32 |
+
|
| 33 |
+
OPTIONS
|
| 34 |
+
-------
|
| 35 |
+
|
| 36 |
+
--format=<fmt>::
|
| 37 |
+
Format of the resulting archive. Possible values are `tar`,
|
| 38 |
+
`zip`, `tar.gz`, `tgz`, and any format defined using the
|
| 39 |
+
configuration option `tar.<format>.command`. If `--format`
|
| 40 |
+
is not given, and the output file is specified, the format is
|
| 41 |
+
inferred from the filename if possible (e.g. writing to `foo.zip`
|
| 42 |
+
makes the output to be in the `zip` format). Otherwise the output
|
| 43 |
+
format is `tar`.
|
| 44 |
+
|
| 45 |
+
-l::
|
| 46 |
+
--list::
|
| 47 |
+
Show all available formats.
|
| 48 |
+
|
| 49 |
+
-v::
|
| 50 |
+
--verbose::
|
| 51 |
+
Report progress to stderr.
|
| 52 |
+
|
| 53 |
+
--prefix=<prefix>/::
|
| 54 |
+
Prepend <prefix>/ to paths in the archive. Can be repeated; its
|
| 55 |
+
rightmost value is used for all tracked files. See below which
|
| 56 |
+
value gets used by `--add-file`.
|
| 57 |
+
+
|
| 58 |
+
The <prefix> is used as given and is not normalized. It may
|
| 59 |
+
include leading slashes or parent directory components (e.g.,
|
| 60 |
+
`../`). Some archive consumers may treat such paths as
|
| 61 |
+
potentially unsafe and adjust or warn during extraction.
|
| 62 |
+
|
| 63 |
+
-o <file>::
|
| 64 |
+
--output=<file>::
|
| 65 |
+
Write the archive to <file> instead of stdout.
|
| 66 |
+
|
| 67 |
+
--add-file=<file>::
|
| 68 |
+
Add a non-tracked file to the archive. Can be repeated to add
|
| 69 |
+
multiple files. The path of the file in the archive is built by
|
| 70 |
+
concatenating the value of the last `--prefix` option (if any)
|
| 71 |
+
before this `--add-file` and the basename of <file>.
|
| 72 |
+
|
| 73 |
+
--add-virtual-file=<path>:<content>::
|
| 74 |
+
Add the specified contents to the archive. Can be repeated to add
|
| 75 |
+
multiple files.
|
| 76 |
+
+
|
| 77 |
+
The `<path>` argument can start and end with a literal double-quote
|
| 78 |
+
character; the contained file name is interpreted as a C-style string,
|
| 79 |
+
i.e. the backslash is interpreted as escape character. The path must
|
| 80 |
+
be quoted if it contains a colon, to avoid the colon from being
|
| 81 |
+
misinterpreted as the separator between the path and the contents, or
|
| 82 |
+
if the path begins or ends with a double-quote character.
|
| 83 |
+
+
|
| 84 |
+
The file mode is limited to a regular file, and the option may be
|
| 85 |
+
subject to platform-dependent command-line limits. For non-trivial
|
| 86 |
+
cases, write an untracked file and use `--add-file` instead.
|
| 87 |
+
+
|
| 88 |
+
Note that unlike `--add-file` the path created in the archive is not
|
| 89 |
+
affected by the `--prefix` option, as a full `<path>` can be given as
|
| 90 |
+
the value of the option.
|
| 91 |
+
|
| 92 |
+
--worktree-attributes::
|
| 93 |
+
Look for attributes in .gitattributes files in the working tree
|
| 94 |
+
as well (see <<ATTRIBUTES>>).
|
| 95 |
+
|
| 96 |
+
--mtime=<time>::
|
| 97 |
+
Set modification time of archive entries. Without this option
|
| 98 |
+
the committer time is used if `<tree-ish>` is a commit or tag,
|
| 99 |
+
and the current time if it is a tree.
|
| 100 |
+
|
| 101 |
+
<extra>::
|
| 102 |
+
This can be any options that the archiver backend understands.
|
| 103 |
+
See next section.
|
| 104 |
+
|
| 105 |
+
--remote=<repo>::
|
| 106 |
+
Instead of making a tar archive from the local repository,
|
| 107 |
+
retrieve a tar archive from a remote repository. Note that the
|
| 108 |
+
remote repository may place restrictions on which sha1
|
| 109 |
+
expressions may be allowed in `<tree-ish>`. See
|
| 110 |
+
linkgit:git-upload-archive[1] for details.
|
| 111 |
+
|
| 112 |
+
--exec=<git-upload-archive>::
|
| 113 |
+
Used with --remote to specify the path to the
|
| 114 |
+
'git-upload-archive' on the remote side.
|
| 115 |
+
|
| 116 |
+
<tree-ish>::
|
| 117 |
+
The tree or commit to produce an archive for.
|
| 118 |
+
|
| 119 |
+
<path>::
|
| 120 |
+
Without an optional path parameter, all files and subdirectories
|
| 121 |
+
of the current working directory are included in the archive.
|
| 122 |
+
If one or more paths are specified, only these are included.
|
| 123 |
+
|
| 124 |
+
BACKEND EXTRA OPTIONS
|
| 125 |
+
---------------------
|
| 126 |
+
|
| 127 |
+
zip
|
| 128 |
+
~~~
|
| 129 |
+
-<digit>::
|
| 130 |
+
Specify compression level. Larger values allow the command
|
| 131 |
+
to spend more time to compress to smaller size. Supported
|
| 132 |
+
values are from `-0` (store-only) to `-9` (best ratio).
|
| 133 |
+
Default is `-6` if not given.
|
| 134 |
+
|
| 135 |
+
tar
|
| 136 |
+
~~~
|
| 137 |
+
-<number>::
|
| 138 |
+
Specify compression level. The value will be passed to the
|
| 139 |
+
compression command configured in `tar.<format>.command`. See
|
| 140 |
+
manual page of the configured command for the list of supported
|
| 141 |
+
levels and the default level if this option isn't specified.
|
| 142 |
+
|
| 143 |
+
CONFIGURATION
|
| 144 |
+
-------------
|
| 145 |
+
|
| 146 |
+
tar.umask::
|
| 147 |
+
This variable can be used to restrict the permission bits of
|
| 148 |
+
tar archive entries. The default is 0002, which turns off the
|
| 149 |
+
world write bit. The special value "user" indicates that the
|
| 150 |
+
archiving user's umask will be used instead. See umask(2) for
|
| 151 |
+
details. If `--remote` is used then only the configuration of
|
| 152 |
+
the remote repository takes effect.
|
| 153 |
+
|
| 154 |
+
tar.<format>.command::
|
| 155 |
+
This variable specifies a shell command through which the tar
|
| 156 |
+
output generated by `git archive` should be piped. The command
|
| 157 |
+
is executed using the shell with the generated tar file on its
|
| 158 |
+
standard input, and should produce the final output on its
|
| 159 |
+
standard output. Any compression-level options will be passed
|
| 160 |
+
to the command (e.g., `-9`).
|
| 161 |
+
+
|
| 162 |
+
The `tar.gz` and `tgz` formats are defined automatically and use the
|
| 163 |
+
magic command `git archive gzip` by default, which invokes an internal
|
| 164 |
+
implementation of gzip.
|
| 165 |
+
|
| 166 |
+
tar.<format>.remote::
|
| 167 |
+
If true, enable the format for use by remote clients via
|
| 168 |
+
linkgit:git-upload-archive[1]. Defaults to false for
|
| 169 |
+
user-defined formats, but true for the `tar.gz` and `tgz`
|
| 170 |
+
formats.
|
| 171 |
+
|
| 172 |
+
[[ATTRIBUTES]]
|
| 173 |
+
ATTRIBUTES
|
| 174 |
+
----------
|
| 175 |
+
|
| 176 |
+
export-ignore::
|
| 177 |
+
Files and directories with the attribute export-ignore won't be
|
| 178 |
+
added to archive files. See linkgit:gitattributes[5] for details.
|
| 179 |
+
|
| 180 |
+
export-subst::
|
| 181 |
+
If the attribute export-subst is set for a file then Git will
|
| 182 |
+
expand several placeholders when adding this file to an archive.
|
| 183 |
+
See linkgit:gitattributes[5] for details.
|
| 184 |
+
|
| 185 |
+
Note that attributes are by default taken from the `.gitattributes` files
|
| 186 |
+
in the tree that is being archived. If you want to tweak the way the
|
| 187 |
+
output is generated after the fact (e.g. you committed without adding an
|
| 188 |
+
appropriate export-ignore in its `.gitattributes`), adjust the checked out
|
| 189 |
+
`.gitattributes` file as necessary and use `--worktree-attributes`
|
| 190 |
+
option. Alternatively you can keep necessary attributes that should apply
|
| 191 |
+
while archiving any tree in your `$GIT_DIR/info/attributes` file.
|
| 192 |
+
|
| 193 |
+
EXAMPLES
|
| 194 |
+
--------
|
| 195 |
+
`git archive --format=tar --prefix=junk/ HEAD | (cd /var/tmp/ && tar xf -)`::
|
| 196 |
+
|
| 197 |
+
Create a tar archive that contains the contents of the
|
| 198 |
+
latest commit on the current branch, and extract it in the
|
| 199 |
+
`/var/tmp/junk` directory.
|
| 200 |
+
|
| 201 |
+
`git archive --format=tar --prefix=git-1.4.0/ v1.4.0 | gzip >git-1.4.0.tar.gz`::
|
| 202 |
+
|
| 203 |
+
Create a compressed tarball for v1.4.0 release.
|
| 204 |
+
|
| 205 |
+
`git archive --format=tar.gz --prefix=git-1.4.0/ v1.4.0 >git-1.4.0.tar.gz`::
|
| 206 |
+
|
| 207 |
+
Same as above, but using the builtin tar.gz handling.
|
| 208 |
+
|
| 209 |
+
`git archive --prefix=git-1.4.0/ -o git-1.4.0.tar.gz v1.4.0`::
|
| 210 |
+
|
| 211 |
+
Same as above, but the format is inferred from the output file.
|
| 212 |
+
|
| 213 |
+
`git archive --format=tar --prefix=git-1.4.0/ v1.4.0^{tree} | gzip >git-1.4.0.tar.gz`::
|
| 214 |
+
|
| 215 |
+
Create a compressed tarball for v1.4.0 release, but without a
|
| 216 |
+
global extended pax header.
|
| 217 |
+
|
| 218 |
+
`git archive --format=zip --prefix=git-docs/ HEAD:Documentation/ > git-1.4.0-docs.zip`::
|
| 219 |
+
|
| 220 |
+
Put everything in the current head's Documentation/ directory
|
| 221 |
+
into 'git-1.4.0-docs.zip', with the prefix 'git-docs/'.
|
| 222 |
+
|
| 223 |
+
`git archive -o latest.zip HEAD`::
|
| 224 |
+
|
| 225 |
+
Create a Zip archive that contains the contents of the latest
|
| 226 |
+
commit on the current branch. Note that the output format is
|
| 227 |
+
inferred by the extension of the output file.
|
| 228 |
+
|
| 229 |
+
`git archive -o latest.tar --prefix=build/ --add-file=configure --prefix= HEAD`::
|
| 230 |
+
|
| 231 |
+
Creates a tar archive that contains the contents of the latest
|
| 232 |
+
commit on the current branch with no prefix and the untracked
|
| 233 |
+
file 'configure' with the prefix 'build/'.
|
| 234 |
+
|
| 235 |
+
`git config tar.tar.xz.command "xz -c"`::
|
| 236 |
+
|
| 237 |
+
Configure a "tar.xz" format for making LZMA-compressed tarfiles.
|
| 238 |
+
You can use it specifying `--format=tar.xz`, or by creating an
|
| 239 |
+
output file like `-o foo.tar.xz`.
|
| 240 |
+
|
| 241 |
+
|
| 242 |
+
SEE ALSO
|
| 243 |
+
--------
|
| 244 |
+
linkgit:gitattributes[5]
|
| 245 |
+
|
| 246 |
+
GIT
|
| 247 |
+
---
|
| 248 |
+
Part of the linkgit:git[1] suite
|
git/mingw64/share/doc/git-doc/git-archive.html
ADDED
|
@@ -0,0 +1,777 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-archive(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-archive(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-archive - Create an archive of files from a named tree</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content"><em>git archive</em> [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
|
| 456 |
+
[-o <file> | --output=<file>] [--worktree-attributes]
|
| 457 |
+
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
|
| 458 |
+
[<path>…​]</pre>
|
| 459 |
+
</div>
|
| 460 |
+
</div>
|
| 461 |
+
</div>
|
| 462 |
+
<div class="sect1">
|
| 463 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 464 |
+
<div class="sectionbody">
|
| 465 |
+
<div class="paragraph">
|
| 466 |
+
<p>Creates an archive of the specified format containing the tree
|
| 467 |
+
structure for the named tree, and writes it out to the standard
|
| 468 |
+
output. If <prefix> is specified it is
|
| 469 |
+
prepended to the filenames in the archive.</p>
|
| 470 |
+
</div>
|
| 471 |
+
<div class="paragraph">
|
| 472 |
+
<p><em>git archive</em> behaves differently when given a tree ID as opposed to a
|
| 473 |
+
commit ID or tag ID. When a tree ID is provided, the current time is
|
| 474 |
+
used as the modification time of each file in the archive. On the
|
| 475 |
+
other hand, when a commit ID or tag ID is provided, the commit time as
|
| 476 |
+
recorded in the referenced commit object is used instead.
|
| 477 |
+
Additionally the commit ID is stored in a global extended pax header
|
| 478 |
+
if the tar format is used; it can be extracted using <em>git
|
| 479 |
+
get-tar-commit-id</em>. In ZIP files it is stored as a file comment.</p>
|
| 480 |
+
</div>
|
| 481 |
+
</div>
|
| 482 |
+
</div>
|
| 483 |
+
<div class="sect1">
|
| 484 |
+
<h2 id="_options">OPTIONS</h2>
|
| 485 |
+
<div class="sectionbody">
|
| 486 |
+
<div class="dlist">
|
| 487 |
+
<dl>
|
| 488 |
+
<dt class="hdlist1">--format=<fmt></dt>
|
| 489 |
+
<dd>
|
| 490 |
+
<p>Format of the resulting archive. Possible values are <code>tar</code>,
|
| 491 |
+
<code>zip</code>, <code>tar.gz</code>, <code>tgz</code>, and any format defined using the
|
| 492 |
+
configuration option <code>tar.</code><em><format></em><code>.command</code>. If <code>--format</code>
|
| 493 |
+
is not given, and the output file is specified, the format is
|
| 494 |
+
inferred from the filename if possible (e.g. writing to <code>foo.zip</code>
|
| 495 |
+
makes the output to be in the <code>zip</code> format). Otherwise the output
|
| 496 |
+
format is <code>tar</code>.</p>
|
| 497 |
+
</dd>
|
| 498 |
+
<dt class="hdlist1">-l</dt>
|
| 499 |
+
<dt class="hdlist1">--list</dt>
|
| 500 |
+
<dd>
|
| 501 |
+
<p>Show all available formats.</p>
|
| 502 |
+
</dd>
|
| 503 |
+
<dt class="hdlist1">-v</dt>
|
| 504 |
+
<dt class="hdlist1">--verbose</dt>
|
| 505 |
+
<dd>
|
| 506 |
+
<p>Report progress to stderr.</p>
|
| 507 |
+
</dd>
|
| 508 |
+
<dt class="hdlist1">--prefix=<prefix>/</dt>
|
| 509 |
+
<dd>
|
| 510 |
+
<p>Prepend <prefix>/ to paths in the archive. Can be repeated; its
|
| 511 |
+
rightmost value is used for all tracked files. See below which
|
| 512 |
+
value gets used by <code>--add-file</code>.</p>
|
| 513 |
+
<div class="paragraph">
|
| 514 |
+
<p>The <prefix> is used as given and is not normalized. It may
|
| 515 |
+
include leading slashes or parent directory components (e.g.,
|
| 516 |
+
<code>..</code><code>/</code>). Some archive consumers may treat such paths as
|
| 517 |
+
potentially unsafe and adjust or warn during extraction.</p>
|
| 518 |
+
</div>
|
| 519 |
+
</dd>
|
| 520 |
+
<dt class="hdlist1">-o <file></dt>
|
| 521 |
+
<dt class="hdlist1">--output=<file></dt>
|
| 522 |
+
<dd>
|
| 523 |
+
<p>Write the archive to <file> instead of stdout.</p>
|
| 524 |
+
</dd>
|
| 525 |
+
<dt class="hdlist1">--add-file=<file></dt>
|
| 526 |
+
<dd>
|
| 527 |
+
<p>Add a non-tracked file to the archive. Can be repeated to add
|
| 528 |
+
multiple files. The path of the file in the archive is built by
|
| 529 |
+
concatenating the value of the last <code>--prefix</code> option (if any)
|
| 530 |
+
before this <code>--add-file</code> and the basename of <file>.</p>
|
| 531 |
+
</dd>
|
| 532 |
+
<dt class="hdlist1">--add-virtual-file=<path>:<content></dt>
|
| 533 |
+
<dd>
|
| 534 |
+
<p>Add the specified contents to the archive. Can be repeated to add
|
| 535 |
+
multiple files.</p>
|
| 536 |
+
<div class="paragraph">
|
| 537 |
+
<p>The <em><path></em> argument can start and end with a literal double-quote
|
| 538 |
+
character; the contained file name is interpreted as a C-style string,
|
| 539 |
+
i.e. the backslash is interpreted as escape character. The path must
|
| 540 |
+
be quoted if it contains a colon, to avoid the colon from being
|
| 541 |
+
misinterpreted as the separator between the path and the contents, or
|
| 542 |
+
if the path begins or ends with a double-quote character.</p>
|
| 543 |
+
</div>
|
| 544 |
+
<div class="paragraph">
|
| 545 |
+
<p>The file mode is limited to a regular file, and the option may be
|
| 546 |
+
subject to platform-dependent command-line limits. For non-trivial
|
| 547 |
+
cases, write an untracked file and use <code>--add-file</code> instead.</p>
|
| 548 |
+
</div>
|
| 549 |
+
<div class="paragraph">
|
| 550 |
+
<p>Note that unlike <code>--add-file</code> the path created in the archive is not
|
| 551 |
+
affected by the <code>--prefix</code> option, as a full <em><path></em> can be given as
|
| 552 |
+
the value of the option.</p>
|
| 553 |
+
</div>
|
| 554 |
+
</dd>
|
| 555 |
+
<dt class="hdlist1">--worktree-attributes</dt>
|
| 556 |
+
<dd>
|
| 557 |
+
<p>Look for attributes in .gitattributes files in the working tree
|
| 558 |
+
as well (see <a href="#ATTRIBUTES">ATTRIBUTES</a>).</p>
|
| 559 |
+
</dd>
|
| 560 |
+
<dt class="hdlist1">--mtime=<time></dt>
|
| 561 |
+
<dd>
|
| 562 |
+
<p>Set modification time of archive entries. Without this option
|
| 563 |
+
the committer time is used if <em><tree-ish></em> is a commit or tag,
|
| 564 |
+
and the current time if it is a tree.</p>
|
| 565 |
+
</dd>
|
| 566 |
+
<dt class="hdlist1"><extra></dt>
|
| 567 |
+
<dd>
|
| 568 |
+
<p>This can be any options that the archiver backend understands.
|
| 569 |
+
See next section.</p>
|
| 570 |
+
</dd>
|
| 571 |
+
<dt class="hdlist1">--remote=<repo></dt>
|
| 572 |
+
<dd>
|
| 573 |
+
<p>Instead of making a tar archive from the local repository,
|
| 574 |
+
retrieve a tar archive from a remote repository. Note that the
|
| 575 |
+
remote repository may place restrictions on which sha1
|
| 576 |
+
expressions may be allowed in <em><tree-ish></em>. See
|
| 577 |
+
<a href="git-upload-archive.html">git-upload-archive(1)</a> for details.</p>
|
| 578 |
+
</dd>
|
| 579 |
+
<dt class="hdlist1">--exec=<git-upload-archive></dt>
|
| 580 |
+
<dd>
|
| 581 |
+
<p>Used with --remote to specify the path to the
|
| 582 |
+
<em>git-upload-archive</em> on the remote side.</p>
|
| 583 |
+
</dd>
|
| 584 |
+
<dt class="hdlist1"><tree-ish></dt>
|
| 585 |
+
<dd>
|
| 586 |
+
<p>The tree or commit to produce an archive for.</p>
|
| 587 |
+
</dd>
|
| 588 |
+
<dt class="hdlist1"><path></dt>
|
| 589 |
+
<dd>
|
| 590 |
+
<p>Without an optional path parameter, all files and subdirectories
|
| 591 |
+
of the current working directory are included in the archive.
|
| 592 |
+
If one or more paths are specified, only these are included.</p>
|
| 593 |
+
</dd>
|
| 594 |
+
</dl>
|
| 595 |
+
</div>
|
| 596 |
+
</div>
|
| 597 |
+
</div>
|
| 598 |
+
<div class="sect1">
|
| 599 |
+
<h2 id="_backend_extra_options">BACKEND EXTRA OPTIONS</h2>
|
| 600 |
+
<div class="sectionbody">
|
| 601 |
+
<div class="sect2">
|
| 602 |
+
<h3 id="_zip">zip</h3>
|
| 603 |
+
<div class="dlist">
|
| 604 |
+
<dl>
|
| 605 |
+
<dt class="hdlist1">-<digit></dt>
|
| 606 |
+
<dd>
|
| 607 |
+
<p>Specify compression level. Larger values allow the command
|
| 608 |
+
to spend more time to compress to smaller size. Supported
|
| 609 |
+
values are from <code>-0</code> (store-only) to <code>-9</code> (best ratio).
|
| 610 |
+
Default is <code>-6</code> if not given.</p>
|
| 611 |
+
</dd>
|
| 612 |
+
</dl>
|
| 613 |
+
</div>
|
| 614 |
+
</div>
|
| 615 |
+
<div class="sect2">
|
| 616 |
+
<h3 id="_tar">tar</h3>
|
| 617 |
+
<div class="dlist">
|
| 618 |
+
<dl>
|
| 619 |
+
<dt class="hdlist1">-<number></dt>
|
| 620 |
+
<dd>
|
| 621 |
+
<p>Specify compression level. The value will be passed to the
|
| 622 |
+
compression command configured in <code>tar.</code><em><format></em><code>.command</code>. See
|
| 623 |
+
manual page of the configured command for the list of supported
|
| 624 |
+
levels and the default level if this option isn’t specified.</p>
|
| 625 |
+
</dd>
|
| 626 |
+
</dl>
|
| 627 |
+
</div>
|
| 628 |
+
</div>
|
| 629 |
+
</div>
|
| 630 |
+
</div>
|
| 631 |
+
<div class="sect1">
|
| 632 |
+
<h2 id="_configuration">CONFIGURATION</h2>
|
| 633 |
+
<div class="sectionbody">
|
| 634 |
+
<div class="dlist">
|
| 635 |
+
<dl>
|
| 636 |
+
<dt class="hdlist1">tar.umask</dt>
|
| 637 |
+
<dd>
|
| 638 |
+
<p>This variable can be used to restrict the permission bits of
|
| 639 |
+
tar archive entries. The default is 0002, which turns off the
|
| 640 |
+
world write bit. The special value "user" indicates that the
|
| 641 |
+
archiving user’s umask will be used instead. See umask(2) for
|
| 642 |
+
details. If <code>--remote</code> is used then only the configuration of
|
| 643 |
+
the remote repository takes effect.</p>
|
| 644 |
+
</dd>
|
| 645 |
+
<dt class="hdlist1">tar.<format>.command</dt>
|
| 646 |
+
<dd>
|
| 647 |
+
<p>This variable specifies a shell command through which the tar
|
| 648 |
+
output generated by <code>git</code> <code>archive</code> should be piped. The command
|
| 649 |
+
is executed using the shell with the generated tar file on its
|
| 650 |
+
standard input, and should produce the final output on its
|
| 651 |
+
standard output. Any compression-level options will be passed
|
| 652 |
+
to the command (e.g., <code>-9</code>).</p>
|
| 653 |
+
<div class="paragraph">
|
| 654 |
+
<p>The <code>tar.gz</code> and <code>tgz</code> formats are defined automatically and use the
|
| 655 |
+
magic command <code>git</code> <code>archive</code> <code>gzip</code> by default, which invokes an internal
|
| 656 |
+
implementation of gzip.</p>
|
| 657 |
+
</div>
|
| 658 |
+
</dd>
|
| 659 |
+
<dt class="hdlist1">tar.<format>.remote</dt>
|
| 660 |
+
<dd>
|
| 661 |
+
<p>If true, enable the format for use by remote clients via
|
| 662 |
+
<a href="git-upload-archive.html">git-upload-archive(1)</a>. Defaults to false for
|
| 663 |
+
user-defined formats, but true for the <code>tar.gz</code> and <code>tgz</code>
|
| 664 |
+
formats.</p>
|
| 665 |
+
</dd>
|
| 666 |
+
</dl>
|
| 667 |
+
</div>
|
| 668 |
+
</div>
|
| 669 |
+
</div>
|
| 670 |
+
<div class="sect1">
|
| 671 |
+
<h2 id="ATTRIBUTES">ATTRIBUTES</h2>
|
| 672 |
+
<div class="sectionbody">
|
| 673 |
+
<div class="dlist">
|
| 674 |
+
<dl>
|
| 675 |
+
<dt class="hdlist1">export-ignore</dt>
|
| 676 |
+
<dd>
|
| 677 |
+
<p>Files and directories with the attribute export-ignore won’t be
|
| 678 |
+
added to archive files. See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
|
| 679 |
+
</dd>
|
| 680 |
+
<dt class="hdlist1">export-subst</dt>
|
| 681 |
+
<dd>
|
| 682 |
+
<p>If the attribute export-subst is set for a file then Git will
|
| 683 |
+
expand several placeholders when adding this file to an archive.
|
| 684 |
+
See <a href="gitattributes.html">gitattributes(5)</a> for details.</p>
|
| 685 |
+
</dd>
|
| 686 |
+
</dl>
|
| 687 |
+
</div>
|
| 688 |
+
<div class="paragraph">
|
| 689 |
+
<p>Note that attributes are by default taken from the .<code>gitattributes</code> files
|
| 690 |
+
in the tree that is being archived. If you want to tweak the way the
|
| 691 |
+
output is generated after the fact (e.g. you committed without adding an
|
| 692 |
+
appropriate export-ignore in its .<code>gitattributes</code>), adjust the checked out
|
| 693 |
+
.<code>gitattributes</code> file as necessary and use <code>--worktree-attributes</code>
|
| 694 |
+
option. Alternatively you can keep necessary attributes that should apply
|
| 695 |
+
while archiving any tree in your <code>$GIT_DIR/info/attributes</code> file.</p>
|
| 696 |
+
</div>
|
| 697 |
+
</div>
|
| 698 |
+
</div>
|
| 699 |
+
<div class="sect1">
|
| 700 |
+
<h2 id="_examples">EXAMPLES</h2>
|
| 701 |
+
<div class="sectionbody">
|
| 702 |
+
<div class="dlist">
|
| 703 |
+
<dl>
|
| 704 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>--format=tar</code> <code>--prefix=junk/</code> <code>HEAD</code> | (<code>cd</code> <code>/var/tmp/</code> && <code>tar</code> <code>xf</code> <code>-</code>)</dt>
|
| 705 |
+
<dd>
|
| 706 |
+
<p>Create a tar archive that contains the contents of the
|
| 707 |
+
latest commit on the current branch, and extract it in the
|
| 708 |
+
<code>/var/tmp/junk</code> directory.</p>
|
| 709 |
+
</dd>
|
| 710 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>--format=tar</code> <code>--prefix=git-1.4.0/</code> <code>v1.4.0</code> | <code>gzip</code> ><code>git-1.4.0.tar.gz</code></dt>
|
| 711 |
+
<dd>
|
| 712 |
+
<p>Create a compressed tarball for v1.4.0 release.</p>
|
| 713 |
+
</dd>
|
| 714 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>--format=tar.gz</code> <code>--prefix=git-1.4.0/</code> <code>v1.4.0</code> ><code>git-1.4.0.tar.gz</code></dt>
|
| 715 |
+
<dd>
|
| 716 |
+
<p>Same as above, but using the builtin tar.gz handling.</p>
|
| 717 |
+
</dd>
|
| 718 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>--prefix=git-1.4.0/</code> <code>-o</code> <code>git-1.4.0.tar.gz</code> <code>v1.4.0</code></dt>
|
| 719 |
+
<dd>
|
| 720 |
+
<p>Same as above, but the format is inferred from the output file.</p>
|
| 721 |
+
</dd>
|
| 722 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>--format=tar</code> <code>--prefix=git-1.4.0/</code> <code>v1.4.0^</code>{tree} | <code>gzip</code> ><code>git-1.4.0.tar.gz</code></dt>
|
| 723 |
+
<dd>
|
| 724 |
+
<p>Create a compressed tarball for v1.4.0 release, but without a
|
| 725 |
+
global extended pax header.</p>
|
| 726 |
+
</dd>
|
| 727 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>--format=zip</code> <code>--prefix=git-docs/</code> <code>HEAD:Documentation/</code> > <code>git-1.4.0-docs.zip</code></dt>
|
| 728 |
+
<dd>
|
| 729 |
+
<p>Put everything in the current head’s Documentation/ directory
|
| 730 |
+
into <em>git-1.4.0-docs.zip</em>, with the prefix <em>git-docs/</em>.</p>
|
| 731 |
+
</dd>
|
| 732 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>-o</code> <code>latest.zip</code> <code>HEAD</code></dt>
|
| 733 |
+
<dd>
|
| 734 |
+
<p>Create a Zip archive that contains the contents of the latest
|
| 735 |
+
commit on the current branch. Note that the output format is
|
| 736 |
+
inferred by the extension of the output file.</p>
|
| 737 |
+
</dd>
|
| 738 |
+
<dt class="hdlist1"><code>git</code> <code>archive</code> <code>-o</code> <code>latest.tar</code> <code>--prefix=build/</code> <code>--add-file=configure</code> <code>--prefix=</code> <code>HEAD</code></dt>
|
| 739 |
+
<dd>
|
| 740 |
+
<p>Creates a tar archive that contains the contents of the latest
|
| 741 |
+
commit on the current branch with no prefix and the untracked
|
| 742 |
+
file <em>configure</em> with the prefix <em>build/</em>.</p>
|
| 743 |
+
</dd>
|
| 744 |
+
<dt class="hdlist1"><code>git</code> <code>config</code> <code>tar.tar.xz.command</code> "xz <code>-c</code>"</dt>
|
| 745 |
+
<dd>
|
| 746 |
+
<p>Configure a "tar.xz" format for making LZMA-compressed tarfiles.
|
| 747 |
+
You can use it specifying <code>--format=tar.xz</code>, or by creating an
|
| 748 |
+
output file like <code>-o</code> <code>foo.tar.xz</code>.</p>
|
| 749 |
+
</dd>
|
| 750 |
+
</dl>
|
| 751 |
+
</div>
|
| 752 |
+
</div>
|
| 753 |
+
</div>
|
| 754 |
+
<div class="sect1">
|
| 755 |
+
<h2 id="_see_also">SEE ALSO</h2>
|
| 756 |
+
<div class="sectionbody">
|
| 757 |
+
<div class="paragraph">
|
| 758 |
+
<p><a href="gitattributes.html">gitattributes(5)</a></p>
|
| 759 |
+
</div>
|
| 760 |
+
</div>
|
| 761 |
+
</div>
|
| 762 |
+
<div class="sect1">
|
| 763 |
+
<h2 id="_git">GIT</h2>
|
| 764 |
+
<div class="sectionbody">
|
| 765 |
+
<div class="paragraph">
|
| 766 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 767 |
+
</div>
|
| 768 |
+
</div>
|
| 769 |
+
</div>
|
| 770 |
+
</div>
|
| 771 |
+
<div id="footer">
|
| 772 |
+
<div id="footer-text">
|
| 773 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 774 |
+
</div>
|
| 775 |
+
</div>
|
| 776 |
+
</body>
|
| 777 |
+
</html>
|
git/mingw64/share/doc/git-doc/git-backfill.adoc
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-backfill(1)
|
| 2 |
+
===============
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-backfill - Download missing objects in a partial clone
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
SYNOPSIS
|
| 10 |
+
--------
|
| 11 |
+
[synopsis]
|
| 12 |
+
git backfill [--min-batch-size=<n>] [--[no-]sparse]
|
| 13 |
+
|
| 14 |
+
DESCRIPTION
|
| 15 |
+
-----------
|
| 16 |
+
|
| 17 |
+
Blobless partial clones are created using `git clone --filter=blob:none`
|
| 18 |
+
and then configure the local repository such that the Git client avoids
|
| 19 |
+
downloading blob objects unless they are required for a local operation.
|
| 20 |
+
This initially means that the clone and later fetches download reachable
|
| 21 |
+
commits and trees but no blobs. Later operations that change the `HEAD`
|
| 22 |
+
pointer, such as `git checkout` or `git merge`, may need to download
|
| 23 |
+
missing blobs in order to complete their operation.
|
| 24 |
+
|
| 25 |
+
In the worst cases, commands that compute blob diffs, such as `git blame`,
|
| 26 |
+
become very slow as they download the missing blobs in single-blob
|
| 27 |
+
requests to satisfy the missing object as the Git command needs it. This
|
| 28 |
+
leads to multiple download requests and no ability for the Git server to
|
| 29 |
+
provide delta compression across those objects.
|
| 30 |
+
|
| 31 |
+
The `git backfill` command provides a way for the user to request that
|
| 32 |
+
Git downloads the missing blobs (with optional filters) such that the
|
| 33 |
+
missing blobs representing historical versions of files can be downloaded
|
| 34 |
+
in batches. The `backfill` command attempts to optimize the request by
|
| 35 |
+
grouping blobs that appear at the same path, hopefully leading to good
|
| 36 |
+
delta compression in the packfile sent by the server.
|
| 37 |
+
|
| 38 |
+
In this way, `git backfill` provides a mechanism to break a large clone
|
| 39 |
+
into smaller chunks. Starting with a blobless partial clone with `git
|
| 40 |
+
clone --filter=blob:none` and then running `git backfill` in the local
|
| 41 |
+
repository provides a way to download all reachable objects in several
|
| 42 |
+
smaller network calls than downloading the entire repository at clone
|
| 43 |
+
time.
|
| 44 |
+
|
| 45 |
+
By default, `git backfill` downloads all blobs reachable from the `HEAD`
|
| 46 |
+
commit. This set can be restricted or expanded using various options.
|
| 47 |
+
|
| 48 |
+
THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR MAY CHANGE IN THE FUTURE.
|
| 49 |
+
|
| 50 |
+
|
| 51 |
+
OPTIONS
|
| 52 |
+
-------
|
| 53 |
+
|
| 54 |
+
`--min-batch-size=<n>`::
|
| 55 |
+
Specify a minimum size for a batch of missing objects to request
|
| 56 |
+
from the server. This size may be exceeded by the last set of
|
| 57 |
+
blobs seen at a given path. The default minimum batch size is
|
| 58 |
+
50,000.
|
| 59 |
+
|
| 60 |
+
`--sparse`::
|
| 61 |
+
`--no-sparse`::
|
| 62 |
+
Only download objects if they appear at a path that matches the
|
| 63 |
+
current sparse-checkout. If the sparse-checkout feature is enabled,
|
| 64 |
+
then `--sparse` is assumed and can be disabled with `--no-sparse`.
|
| 65 |
+
|
| 66 |
+
You may also specify the commit limiting options from linkgit:git-rev-list[1].
|
| 67 |
+
|
| 68 |
+
SEE ALSO
|
| 69 |
+
--------
|
| 70 |
+
linkgit:git-clone[1],
|
| 71 |
+
linkgit:git-rev-list[1]
|
| 72 |
+
|
| 73 |
+
GIT
|
| 74 |
+
---
|
| 75 |
+
Part of the linkgit:git[1] suite
|
git/mingw64/share/doc/git-doc/git-backfill.html
ADDED
|
@@ -0,0 +1,553 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-backfill(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-backfill(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-backfill - Download missing objects in a partial clone</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content"><code>git</code> <code>backfill</code> [<code>--min-batch-size=</code><em><n></em>] [<code>--</code>[<code>no-</code>]<code>sparse</code>]</pre>
|
| 456 |
+
</div>
|
| 457 |
+
</div>
|
| 458 |
+
</div>
|
| 459 |
+
<div class="sect1">
|
| 460 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 461 |
+
<div class="sectionbody">
|
| 462 |
+
<div class="paragraph">
|
| 463 |
+
<p>Blobless partial clones are created using <code>git</code> <code>clone</code> <code>--filter=blob:none</code>
|
| 464 |
+
and then configure the local repository such that the Git client avoids
|
| 465 |
+
downloading blob objects unless they are required for a local operation.
|
| 466 |
+
This initially means that the clone and later fetches download reachable
|
| 467 |
+
commits and trees but no blobs. Later operations that change the <code>HEAD</code>
|
| 468 |
+
pointer, such as <code>git</code> <code>checkout</code> or <code>git</code> <code>merge</code>, may need to download
|
| 469 |
+
missing blobs in order to complete their operation.</p>
|
| 470 |
+
</div>
|
| 471 |
+
<div class="paragraph">
|
| 472 |
+
<p>In the worst cases, commands that compute blob diffs, such as <code>git</code> <code>blame</code>,
|
| 473 |
+
become very slow as they download the missing blobs in single-blob
|
| 474 |
+
requests to satisfy the missing object as the Git command needs it. This
|
| 475 |
+
leads to multiple download requests and no ability for the Git server to
|
| 476 |
+
provide delta compression across those objects.</p>
|
| 477 |
+
</div>
|
| 478 |
+
<div class="paragraph">
|
| 479 |
+
<p>The <code>git</code> <code>backfill</code> command provides a way for the user to request that
|
| 480 |
+
Git downloads the missing blobs (with optional filters) such that the
|
| 481 |
+
missing blobs representing historical versions of files can be downloaded
|
| 482 |
+
in batches. The <code>backfill</code> command attempts to optimize the request by
|
| 483 |
+
grouping blobs that appear at the same path, hopefully leading to good
|
| 484 |
+
delta compression in the packfile sent by the server.</p>
|
| 485 |
+
</div>
|
| 486 |
+
<div class="paragraph">
|
| 487 |
+
<p>In this way, <code>git</code> <code>backfill</code> provides a mechanism to break a large clone
|
| 488 |
+
into smaller chunks. Starting with a blobless partial clone with <code>git</code>
|
| 489 |
+
<code>clone</code> <code>--filter=blob:none</code> and then running <code>git</code> <code>backfill</code> in the local
|
| 490 |
+
repository provides a way to download all reachable objects in several
|
| 491 |
+
smaller network calls than downloading the entire repository at clone
|
| 492 |
+
time.</p>
|
| 493 |
+
</div>
|
| 494 |
+
<div class="paragraph">
|
| 495 |
+
<p>By default, <code>git</code> <code>backfill</code> downloads all blobs reachable from the <code>HEAD</code>
|
| 496 |
+
commit. This set can be restricted or expanded using various options.</p>
|
| 497 |
+
</div>
|
| 498 |
+
<div class="paragraph">
|
| 499 |
+
<p>THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR MAY CHANGE IN THE FUTURE.</p>
|
| 500 |
+
</div>
|
| 501 |
+
</div>
|
| 502 |
+
</div>
|
| 503 |
+
<div class="sect1">
|
| 504 |
+
<h2 id="_options">OPTIONS</h2>
|
| 505 |
+
<div class="sectionbody">
|
| 506 |
+
<div class="dlist">
|
| 507 |
+
<dl>
|
| 508 |
+
<dt class="hdlist1"><code>--min-batch-size=</code><em><n></em></dt>
|
| 509 |
+
<dd>
|
| 510 |
+
<p>Specify a minimum size for a batch of missing objects to request
|
| 511 |
+
from the server. This size may be exceeded by the last set of
|
| 512 |
+
blobs seen at a given path. The default minimum batch size is
|
| 513 |
+
50,000.</p>
|
| 514 |
+
</dd>
|
| 515 |
+
<dt class="hdlist1"><code>--sparse</code></dt>
|
| 516 |
+
<dt class="hdlist1"><code>--no-sparse</code></dt>
|
| 517 |
+
<dd>
|
| 518 |
+
<p>Only download objects if they appear at a path that matches the
|
| 519 |
+
current sparse-checkout. If the sparse-checkout feature is enabled,
|
| 520 |
+
then <code>--sparse</code> is assumed and can be disabled with <code>--no-sparse</code>.</p>
|
| 521 |
+
</dd>
|
| 522 |
+
</dl>
|
| 523 |
+
</div>
|
| 524 |
+
<div class="paragraph">
|
| 525 |
+
<p>You may also specify the commit limiting options from <a href="git-rev-list.html">git-rev-list(1)</a>.</p>
|
| 526 |
+
</div>
|
| 527 |
+
</div>
|
| 528 |
+
</div>
|
| 529 |
+
<div class="sect1">
|
| 530 |
+
<h2 id="_see_also">SEE ALSO</h2>
|
| 531 |
+
<div class="sectionbody">
|
| 532 |
+
<div class="paragraph">
|
| 533 |
+
<p><a href="git-clone.html">git-clone(1)</a>,
|
| 534 |
+
<a href="git-rev-list.html">git-rev-list(1)</a></p>
|
| 535 |
+
</div>
|
| 536 |
+
</div>
|
| 537 |
+
</div>
|
| 538 |
+
<div class="sect1">
|
| 539 |
+
<h2 id="_git">GIT</h2>
|
| 540 |
+
<div class="sectionbody">
|
| 541 |
+
<div class="paragraph">
|
| 542 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 543 |
+
</div>
|
| 544 |
+
</div>
|
| 545 |
+
</div>
|
| 546 |
+
</div>
|
| 547 |
+
<div id="footer">
|
| 548 |
+
<div id="footer-text">
|
| 549 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 550 |
+
</div>
|
| 551 |
+
</div>
|
| 552 |
+
</body>
|
| 553 |
+
</html>
|
git/mingw64/share/doc/git-doc/git-bash.adoc
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
git-bash(1)
|
| 2 |
+
===========
|
| 3 |
+
|
| 4 |
+
NAME
|
| 5 |
+
----
|
| 6 |
+
git-bash - A Windows-specific wrapper to open a Git Bash window
|
| 7 |
+
|
| 8 |
+
SYNOPSIS
|
| 9 |
+
--------
|
| 10 |
+
[verse]
|
| 11 |
+
git-bash [--cd-to-home] [--cd=<directory>] [--minimal-search-path]
|
| 12 |
+
[--command=<path>] [--app-id=<id>] [<args>...]
|
| 13 |
+
|
| 14 |
+
DESCRIPTION
|
| 15 |
+
-----------
|
| 16 |
+
|
| 17 |
+
This command opens a window with an interactive Git Bash. It is specific to the
|
| 18 |
+
Git for Windows project.
|
| 19 |
+
|
| 20 |
+
By default, this will open a MinTTY window, but it can be configured in Git for
|
| 21 |
+
Windows' installer to use Windows' default Console window instead.
|
| 22 |
+
|
| 23 |
+
Before starting the interactive Bash session, the environment is adjusted a
|
| 24 |
+
bit. For example, the `PATH` is adjusted to find the `git` executable, and
|
| 25 |
+
`git-bash` will ensure that `HOME` is set (because it is expected to be present
|
| 26 |
+
by Git, and to point to the current user's home directory). See the
|
| 27 |
+
<<ENVIRONMENT-VARIABLES>> section below for more information.
|
| 28 |
+
|
| 29 |
+
|
| 30 |
+
OPTIONS
|
| 31 |
+
-------
|
| 32 |
+
|
| 33 |
+
--cd-to-home::
|
| 34 |
+
--no-cd::
|
| 35 |
+
--cd=<directory>::
|
| 36 |
+
By default, Git Bash will not change the current directory; To allow
|
| 37 |
+
e.g. for Windows Explorer integration ("Git Bash Here"), the
|
| 38 |
+
`--cd=<directory>` option can be used to change the current directory
|
| 39 |
+
before running the interactive Bash.
|
| 40 |
+
+
|
| 41 |
+
The `--cd-to-home` option can be used to change the current directory to the
|
| 42 |
+
user's home directory (as determined by the environment variable `HOME`). The
|
| 43 |
+
`--no-cd` option can be used to override `--cd` options that precede it.
|
| 44 |
+
|
| 45 |
+
--minimal-search-path::
|
| 46 |
+
--no-minimal-search-path::
|
| 47 |
+
By default, Git Bash will adjust the `PATH` not only to include the
|
| 48 |
+
`git` executable, but also all of the Unix-y tools (such as `sed`,
|
| 49 |
+
`awk`, etc). With `--minimal-search-path`, it will be adjusted so that
|
| 50 |
+
*only* the `git`, `git-gui` and `gitk` executables are found, as well
|
| 51 |
+
as the scripts `start-ssh-agent.cmd` and `start-ssh-pageant.cmd`.
|
| 52 |
+
|
| 53 |
+
--command=<command>::
|
| 54 |
+
Allows the user to ask for a different command to be specified.
|
| 55 |
+
Defaults to `usr\\bin\\mintty.exe`. If the specified command is not an
|
| 56 |
+
absolute path, it is interpreted relative to `git-bash.exe`.
|
| 57 |
+
|
| 58 |
+
--app-id=<command>::
|
| 59 |
+
Allows the user to override the ID used e.g. in Windows' Task Bar.
|
| 60 |
+
Defaults to `GitForWindows.Bash`.
|
| 61 |
+
|
| 62 |
+
--needs-console::
|
| 63 |
+
--no-needs-console::
|
| 64 |
+
--hide::
|
| 65 |
+
--no-hide::
|
| 66 |
+
--append-quote::
|
| 67 |
+
--no-append-quote::
|
| 68 |
+
These options do not make sense in the context of `git-bash`; They are
|
| 69 |
+
merely inherited from the Git Wrapper (see the <<GIT-WRAPPER>> section
|
| 70 |
+
below).
|
| 71 |
+
|
| 72 |
+
[[ENVIRONMENT-VARIABLES]]
|
| 73 |
+
ENVIRONMENT VARIABLES
|
| 74 |
+
~~~~~~~~~~~~~~~~~~~~~
|
| 75 |
+
|
| 76 |
+
Upon startup, `git-bash` will ensure that a couple of environment variables are
|
| 77 |
+
set/adjusted.
|
| 78 |
+
|
| 79 |
+
The most important variable to adjust is `PATH`: Git Bash does want to make
|
| 80 |
+
sure that the `git` executable is in the search path.
|
| 81 |
+
|
| 82 |
+
If `HOME` is unset, `git-bash` will first look whether `%HOMEDRIVE%%HOMEPATH%`
|
| 83 |
+
points to a valid directory and if it does, use it as value for `HOME`. If
|
| 84 |
+
either `HOMEDRIVE` or `HOMEPATH` are unset, or if they do not point to a valid
|
| 85 |
+
directory, `%USERPROFILE%` is used instead.
|
| 86 |
+
|
| 87 |
+
[[GIT-WRAPPER]]
|
| 88 |
+
GIT WRAPPER
|
| 89 |
+
~~~~~~~~~~~
|
| 90 |
+
|
| 91 |
+
In the Git for Windows project, the source code of `git-bash` is called the
|
| 92 |
+
"Git Wrapper", as it merely parses the command-line parameters, sets up a few
|
| 93 |
+
environment variables, then spawns the actual command, and waits for the
|
| 94 |
+
spawned command to exit. The Git Wrapper is not only used for `git-bash` but
|
| 95 |
+
also for `git-cmd` and for certain placeholders internal to Git (the so-called
|
| 96 |
+
"built-ins").
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
Authors
|
| 100 |
+
-------
|
| 101 |
+
The "Git Wrapper" was written by Johannes Schindelin and other Git for Windows
|
| 102 |
+
contributors.
|
| 103 |
+
|
| 104 |
+
GIT
|
| 105 |
+
---
|
| 106 |
+
Part of the linkgit:git[1] suite
|
| 107 |
+
|
git/mingw64/share/doc/git-doc/git-bash.html
ADDED
|
@@ -0,0 +1,586 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
<!DOCTYPE html>
|
| 2 |
+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
| 3 |
+
<head>
|
| 4 |
+
<meta charset="UTF-8"/>
|
| 5 |
+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
| 6 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
| 7 |
+
<meta name="generator" content="Asciidoctor 2.0.23"/>
|
| 8 |
+
<title>git-bash(1)</title>
|
| 9 |
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
|
| 10 |
+
<style>
|
| 11 |
+
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
| 12 |
+
/* Uncomment the following line when using as a custom stylesheet */
|
| 13 |
+
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
| 14 |
+
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
| 15 |
+
a{background:none}
|
| 16 |
+
a:focus{outline:thin dotted}
|
| 17 |
+
a:active,a:hover{outline:0}
|
| 18 |
+
h1{font-size:2em;margin:.67em 0}
|
| 19 |
+
b,strong{font-weight:bold}
|
| 20 |
+
abbr{font-size:.9em}
|
| 21 |
+
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
| 22 |
+
dfn{font-style:italic}
|
| 23 |
+
hr{height:0}
|
| 24 |
+
mark{background:#ff0;color:#000}
|
| 25 |
+
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
| 26 |
+
pre{white-space:pre-wrap}
|
| 27 |
+
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
| 28 |
+
small{font-size:80%}
|
| 29 |
+
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
| 30 |
+
sup{top:-.5em}
|
| 31 |
+
sub{bottom:-.25em}
|
| 32 |
+
img{border:0}
|
| 33 |
+
svg:not(:root){overflow:hidden}
|
| 34 |
+
figure{margin:0}
|
| 35 |
+
audio,video{display:inline-block}
|
| 36 |
+
audio:not([controls]){display:none;height:0}
|
| 37 |
+
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
| 38 |
+
legend{border:0;padding:0}
|
| 39 |
+
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
| 40 |
+
button,input{line-height:normal}
|
| 41 |
+
button,select{text-transform:none}
|
| 42 |
+
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
| 43 |
+
button[disabled],html input[disabled]{cursor:default}
|
| 44 |
+
input[type=checkbox],input[type=radio]{padding:0}
|
| 45 |
+
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
| 46 |
+
textarea{overflow:auto;vertical-align:top}
|
| 47 |
+
table{border-collapse:collapse;border-spacing:0}
|
| 48 |
+
*,::before,::after{box-sizing:border-box}
|
| 49 |
+
html,body{font-size:100%}
|
| 50 |
+
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
| 51 |
+
a:hover{cursor:pointer}
|
| 52 |
+
img,object,embed{max-width:100%;height:auto}
|
| 53 |
+
object,embed{height:100%}
|
| 54 |
+
img{-ms-interpolation-mode:bicubic}
|
| 55 |
+
.left{float:left!important}
|
| 56 |
+
.right{float:right!important}
|
| 57 |
+
.text-left{text-align:left!important}
|
| 58 |
+
.text-right{text-align:right!important}
|
| 59 |
+
.text-center{text-align:center!important}
|
| 60 |
+
.text-justify{text-align:justify!important}
|
| 61 |
+
.hide{display:none}
|
| 62 |
+
img,object,svg{display:inline-block;vertical-align:middle}
|
| 63 |
+
textarea{height:auto;min-height:50px}
|
| 64 |
+
select{width:100%}
|
| 65 |
+
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
| 66 |
+
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
| 67 |
+
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
| 68 |
+
a:hover,a:focus{color:#1d4b8f}
|
| 69 |
+
a img{border:0}
|
| 70 |
+
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
| 71 |
+
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
| 72 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
| 73 |
+
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
| 74 |
+
h1{font-size:2.125em}
|
| 75 |
+
h2{font-size:1.6875em}
|
| 76 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
| 77 |
+
h4,h5{font-size:1.125em}
|
| 78 |
+
h6{font-size:1em}
|
| 79 |
+
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
| 80 |
+
em,i{font-style:italic;line-height:inherit}
|
| 81 |
+
strong,b{font-weight:bold;line-height:inherit}
|
| 82 |
+
small{font-size:60%;line-height:inherit}
|
| 83 |
+
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
| 84 |
+
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
| 85 |
+
ul,ol{margin-left:1.5em}
|
| 86 |
+
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
| 87 |
+
ul.circle{list-style-type:circle}
|
| 88 |
+
ul.disc{list-style-type:disc}
|
| 89 |
+
ul.square{list-style-type:square}
|
| 90 |
+
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
| 91 |
+
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
| 92 |
+
dl dt{margin-bottom:.3125em;font-weight:bold}
|
| 93 |
+
dl dd{margin-bottom:1.25em}
|
| 94 |
+
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
| 95 |
+
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
| 96 |
+
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
| 97 |
+
h1{font-size:2.75em}
|
| 98 |
+
h2{font-size:2.3125em}
|
| 99 |
+
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
| 100 |
+
h4{font-size:1.4375em}}
|
| 101 |
+
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
| 102 |
+
table thead,table tfoot{background:#f7f8f7}
|
| 103 |
+
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
| 104 |
+
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
| 105 |
+
table tr.even,table tr.alt{background:#f8f8f7}
|
| 106 |
+
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
| 107 |
+
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
| 108 |
+
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
| 109 |
+
.center{margin-left:auto;margin-right:auto}
|
| 110 |
+
.stretch{width:100%}
|
| 111 |
+
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
| 112 |
+
.clearfix::after,.float-group::after{clear:both}
|
| 113 |
+
:not(pre).nobreak{word-wrap:normal}
|
| 114 |
+
:not(pre).nowrap{white-space:nowrap}
|
| 115 |
+
:not(pre).pre-wrap{white-space:pre-wrap}
|
| 116 |
+
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
| 117 |
+
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
| 118 |
+
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
| 119 |
+
pre>code{display:block}
|
| 120 |
+
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
| 121 |
+
em em{font-style:normal}
|
| 122 |
+
strong strong{font-weight:400}
|
| 123 |
+
.keyseq{color:rgba(51,51,51,.8)}
|
| 124 |
+
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
| 125 |
+
.keyseq kbd:first-child{margin-left:0}
|
| 126 |
+
.keyseq kbd:last-child{margin-right:0}
|
| 127 |
+
.menuseq,.menuref{color:#000}
|
| 128 |
+
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
| 129 |
+
.menuseq{word-spacing:-.02em}
|
| 130 |
+
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
| 131 |
+
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
| 132 |
+
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
| 133 |
+
b.button::before{content:"[";padding:0 3px 0 2px}
|
| 134 |
+
b.button::after{content:"]";padding:0 2px 0 3px}
|
| 135 |
+
p a>code:hover{color:rgba(0,0,0,.9)}
|
| 136 |
+
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
| 137 |
+
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
| 138 |
+
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
| 139 |
+
#content{margin-top:1.25em}
|
| 140 |
+
#content::before{content:none}
|
| 141 |
+
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
| 142 |
+
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
| 143 |
+
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 144 |
+
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
| 145 |
+
#header .details span:first-child{margin-left:-.125em}
|
| 146 |
+
#header .details span.email a{color:rgba(0,0,0,.85)}
|
| 147 |
+
#header .details br{display:none}
|
| 148 |
+
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
| 149 |
+
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
| 150 |
+
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
| 151 |
+
#header #revnumber{text-transform:capitalize}
|
| 152 |
+
#header #revnumber::after{content:"\00a0"}
|
| 153 |
+
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
| 154 |
+
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
| 155 |
+
#toc>ul{margin-left:.125em}
|
| 156 |
+
#toc ul.sectlevel0>li>a{font-style:italic}
|
| 157 |
+
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
| 158 |
+
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
| 159 |
+
#toc li{line-height:1.3334;margin-top:.3334em}
|
| 160 |
+
#toc a{text-decoration:none}
|
| 161 |
+
#toc a:active{text-decoration:underline}
|
| 162 |
+
#toctitle{color:#7a2518;font-size:1.2em}
|
| 163 |
+
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
| 164 |
+
body.toc2{padding-left:15em;padding-right:0}
|
| 165 |
+
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
| 166 |
+
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
| 167 |
+
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
| 168 |
+
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
| 169 |
+
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
| 170 |
+
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
| 171 |
+
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
| 172 |
+
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
| 173 |
+
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
| 174 |
+
#toc.toc2{width:20em}
|
| 175 |
+
#toc.toc2 #toctitle{font-size:1.375em}
|
| 176 |
+
#toc.toc2>ul{font-size:.95em}
|
| 177 |
+
#toc.toc2 ul ul{padding-left:1.25em}
|
| 178 |
+
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
| 179 |
+
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
| 180 |
+
#content #toc>:first-child{margin-top:0}
|
| 181 |
+
#content #toc>:last-child{margin-bottom:0}
|
| 182 |
+
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
| 183 |
+
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
| 184 |
+
#content{margin-bottom:.625em}
|
| 185 |
+
.sect1{padding-bottom:.625em}
|
| 186 |
+
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
| 187 |
+
.sect1{padding-bottom:1.25em}}
|
| 188 |
+
.sect1:last-child{padding-bottom:0}
|
| 189 |
+
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
| 190 |
+
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
| 191 |
+
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
| 192 |
+
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
| 193 |
+
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
| 194 |
+
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
| 195 |
+
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
| 196 |
+
details{margin-left:1.25rem}
|
| 197 |
+
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
| 198 |
+
details>summary::-webkit-details-marker{display:none}
|
| 199 |
+
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
| 200 |
+
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
| 201 |
+
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
| 202 |
+
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
| 203 |
+
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
| 204 |
+
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
| 205 |
+
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
| 206 |
+
.admonitionblock>table td.icon{text-align:center;width:80px}
|
| 207 |
+
.admonitionblock>table td.icon img{max-width:none}
|
| 208 |
+
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
| 209 |
+
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
| 210 |
+
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
| 211 |
+
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
| 212 |
+
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
| 213 |
+
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
| 214 |
+
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
| 215 |
+
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
| 216 |
+
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
| 217 |
+
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
| 218 |
+
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
| 219 |
+
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
| 220 |
+
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
| 221 |
+
.listingblock>.content{position:relative}
|
| 222 |
+
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
| 223 |
+
.listingblock:hover code[data-lang]::before{display:block}
|
| 224 |
+
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
| 225 |
+
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
| 226 |
+
.listingblock pre.highlightjs{padding:0}
|
| 227 |
+
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
| 228 |
+
.listingblock pre.prettyprint{border-width:0}
|
| 229 |
+
.prettyprint{background:#f7f7f8}
|
| 230 |
+
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
| 231 |
+
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
| 232 |
+
pre.prettyprint li code[data-lang]::before{opacity:1}
|
| 233 |
+
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
| 234 |
+
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
| 235 |
+
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
| 236 |
+
table.linenotable td.code{padding-left:.75em}
|
| 237 |
+
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
| 238 |
+
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
| 239 |
+
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
| 240 |
+
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
| 241 |
+
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
| 242 |
+
.quoteblock blockquote{margin:0;padding:0;border:0}
|
| 243 |
+
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
| 244 |
+
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
| 245 |
+
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
| 246 |
+
.verseblock{margin:0 1em 1.25em}
|
| 247 |
+
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
| 248 |
+
.verseblock pre strong{font-weight:400}
|
| 249 |
+
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
| 250 |
+
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
| 251 |
+
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
| 252 |
+
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
| 253 |
+
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
| 254 |
+
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
| 255 |
+
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
| 256 |
+
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
| 257 |
+
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
| 258 |
+
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
| 259 |
+
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
| 260 |
+
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
| 261 |
+
p.tableblock:last-child{margin-bottom:0}
|
| 262 |
+
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
| 263 |
+
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
| 264 |
+
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
| 265 |
+
table.grid-all>*>tr>*{border-width:1px}
|
| 266 |
+
table.grid-cols>*>tr>*{border-width:0 1px}
|
| 267 |
+
table.grid-rows>*>tr>*{border-width:1px 0}
|
| 268 |
+
table.frame-all{border-width:1px}
|
| 269 |
+
table.frame-ends{border-width:1px 0}
|
| 270 |
+
table.frame-sides{border-width:0 1px}
|
| 271 |
+
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
| 272 |
+
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
| 273 |
+
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
| 274 |
+
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
| 275 |
+
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
| 276 |
+
th.halign-left,td.halign-left{text-align:left}
|
| 277 |
+
th.halign-right,td.halign-right{text-align:right}
|
| 278 |
+
th.halign-center,td.halign-center{text-align:center}
|
| 279 |
+
th.valign-top,td.valign-top{vertical-align:top}
|
| 280 |
+
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
| 281 |
+
th.valign-middle,td.valign-middle{vertical-align:middle}
|
| 282 |
+
table thead th,table tfoot th{font-weight:bold}
|
| 283 |
+
tbody tr th{background:#f7f8f7}
|
| 284 |
+
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
| 285 |
+
p.tableblock>code:only-child{background:none;padding:0}
|
| 286 |
+
p.tableblock{font-size:1em}
|
| 287 |
+
ol{margin-left:1.75em}
|
| 288 |
+
ul li ol{margin-left:1.5em}
|
| 289 |
+
dl dd{margin-left:1.125em}
|
| 290 |
+
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
| 291 |
+
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
| 292 |
+
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
| 293 |
+
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
| 294 |
+
ul.unstyled,ol.unstyled{margin-left:0}
|
| 295 |
+
li>p:empty:only-child::before{content:"";display:inline-block}
|
| 296 |
+
ul.checklist>li>p:first-child{margin-left:-1em}
|
| 297 |
+
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
| 298 |
+
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
| 299 |
+
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
| 300 |
+
ul.inline>li{margin-left:1.25em}
|
| 301 |
+
.unstyled dl dt{font-weight:400;font-style:normal}
|
| 302 |
+
ol.arabic{list-style-type:decimal}
|
| 303 |
+
ol.decimal{list-style-type:decimal-leading-zero}
|
| 304 |
+
ol.loweralpha{list-style-type:lower-alpha}
|
| 305 |
+
ol.upperalpha{list-style-type:upper-alpha}
|
| 306 |
+
ol.lowerroman{list-style-type:lower-roman}
|
| 307 |
+
ol.upperroman{list-style-type:upper-roman}
|
| 308 |
+
ol.lowergreek{list-style-type:lower-greek}
|
| 309 |
+
.hdlist>table,.colist>table{border:0;background:none}
|
| 310 |
+
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
| 311 |
+
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
| 312 |
+
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
| 313 |
+
td.hdlist2{word-wrap:anywhere}
|
| 314 |
+
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
| 315 |
+
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
| 316 |
+
.colist td:not([class]):first-child img{max-width:none}
|
| 317 |
+
.colist td:not([class]):last-child{padding:.25em 0}
|
| 318 |
+
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
| 319 |
+
.imageblock.left{margin:.25em .625em 1.25em 0}
|
| 320 |
+
.imageblock.right{margin:.25em 0 1.25em .625em}
|
| 321 |
+
.imageblock>.title{margin-bottom:0}
|
| 322 |
+
.imageblock.thumb,.imageblock.th{border-width:6px}
|
| 323 |
+
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
| 324 |
+
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
| 325 |
+
.image.left{margin-right:.625em}
|
| 326 |
+
.image.right{margin-left:.625em}
|
| 327 |
+
a.image{text-decoration:none;display:inline-block}
|
| 328 |
+
a.image object{pointer-events:none}
|
| 329 |
+
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
| 330 |
+
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
| 331 |
+
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
| 332 |
+
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
| 333 |
+
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
| 334 |
+
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
| 335 |
+
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
| 336 |
+
#footnotes .footnote:last-of-type{margin-bottom:0}
|
| 337 |
+
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
| 338 |
+
div.unbreakable{page-break-inside:avoid}
|
| 339 |
+
.big{font-size:larger}
|
| 340 |
+
.small{font-size:smaller}
|
| 341 |
+
.underline{text-decoration:underline}
|
| 342 |
+
.overline{text-decoration:overline}
|
| 343 |
+
.line-through{text-decoration:line-through}
|
| 344 |
+
.aqua{color:#00bfbf}
|
| 345 |
+
.aqua-background{background:#00fafa}
|
| 346 |
+
.black{color:#000}
|
| 347 |
+
.black-background{background:#000}
|
| 348 |
+
.blue{color:#0000bf}
|
| 349 |
+
.blue-background{background:#0000fa}
|
| 350 |
+
.fuchsia{color:#bf00bf}
|
| 351 |
+
.fuchsia-background{background:#fa00fa}
|
| 352 |
+
.gray{color:#606060}
|
| 353 |
+
.gray-background{background:#7d7d7d}
|
| 354 |
+
.green{color:#006000}
|
| 355 |
+
.green-background{background:#007d00}
|
| 356 |
+
.lime{color:#00bf00}
|
| 357 |
+
.lime-background{background:#00fa00}
|
| 358 |
+
.maroon{color:#600000}
|
| 359 |
+
.maroon-background{background:#7d0000}
|
| 360 |
+
.navy{color:#000060}
|
| 361 |
+
.navy-background{background:#00007d}
|
| 362 |
+
.olive{color:#606000}
|
| 363 |
+
.olive-background{background:#7d7d00}
|
| 364 |
+
.purple{color:#600060}
|
| 365 |
+
.purple-background{background:#7d007d}
|
| 366 |
+
.red{color:#bf0000}
|
| 367 |
+
.red-background{background:#fa0000}
|
| 368 |
+
.silver{color:#909090}
|
| 369 |
+
.silver-background{background:#bcbcbc}
|
| 370 |
+
.teal{color:#006060}
|
| 371 |
+
.teal-background{background:#007d7d}
|
| 372 |
+
.white{color:#bfbfbf}
|
| 373 |
+
.white-background{background:#fafafa}
|
| 374 |
+
.yellow{color:#bfbf00}
|
| 375 |
+
.yellow-background{background:#fafa00}
|
| 376 |
+
span.icon>.fa{cursor:default}
|
| 377 |
+
a span.icon>.fa{cursor:inherit}
|
| 378 |
+
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
| 379 |
+
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
| 380 |
+
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
| 381 |
+
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
| 382 |
+
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
| 383 |
+
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
| 384 |
+
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
| 385 |
+
.conum[data-value] *{color:#fff!important}
|
| 386 |
+
.conum[data-value]+b{display:none}
|
| 387 |
+
.conum[data-value]::after{content:attr(data-value)}
|
| 388 |
+
pre .conum[data-value]{position:relative;top:-.125em}
|
| 389 |
+
b.conum *{color:inherit!important}
|
| 390 |
+
.conum:not([data-value]):empty{display:none}
|
| 391 |
+
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
| 392 |
+
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
| 393 |
+
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
| 394 |
+
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
| 395 |
+
p{margin-bottom:1.25rem}
|
| 396 |
+
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
| 397 |
+
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
| 398 |
+
.print-only{display:none!important}
|
| 399 |
+
@page{margin:1.25cm .75cm}
|
| 400 |
+
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
| 401 |
+
html{font-size:80%}
|
| 402 |
+
a{color:inherit!important;text-decoration:underline!important}
|
| 403 |
+
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
| 404 |
+
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
| 405 |
+
abbr[title]{border-bottom:1px dotted}
|
| 406 |
+
abbr[title]::after{content:" (" attr(title) ")"}
|
| 407 |
+
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
| 408 |
+
thead{display:table-header-group}
|
| 409 |
+
svg{max-width:100%}
|
| 410 |
+
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
| 411 |
+
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
| 412 |
+
#header,#content,#footnotes,#footer{max-width:none}
|
| 413 |
+
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
| 414 |
+
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
| 415 |
+
body.book #header{text-align:center}
|
| 416 |
+
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
| 417 |
+
body.book #header .details{border:0!important;display:block;padding:0!important}
|
| 418 |
+
body.book #header .details span:first-child{margin-left:0!important}
|
| 419 |
+
body.book #header .details br{display:block}
|
| 420 |
+
body.book #header .details br+span::before{content:none!important}
|
| 421 |
+
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
| 422 |
+
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
| 423 |
+
.listingblock code[data-lang]::before{display:block}
|
| 424 |
+
#footer{padding:0 .9375em}
|
| 425 |
+
.hide-on-print{display:none!important}
|
| 426 |
+
.print-only{display:block!important}
|
| 427 |
+
.hide-for-print{display:none!important}
|
| 428 |
+
.show-for-print{display:inherit!important}}
|
| 429 |
+
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
| 430 |
+
.sect1{padding:0!important}
|
| 431 |
+
.sect1+.sect1{border:0}
|
| 432 |
+
#footer{background:none}
|
| 433 |
+
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
| 434 |
+
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
| 435 |
+
</style>
|
| 436 |
+
<style>
|
| 437 |
+
pre>code {
|
| 438 |
+
display: inline;
|
| 439 |
+
}
|
| 440 |
+
</style>
|
| 441 |
+
</head>
|
| 442 |
+
<body class="manpage">
|
| 443 |
+
<div id="header">
|
| 444 |
+
<h1>git-bash(1) Manual Page</h1>
|
| 445 |
+
<h2 id="_name">NAME</h2>
|
| 446 |
+
<div class="sectionbody">
|
| 447 |
+
<p>git-bash - A Windows-specific wrapper to open a Git Bash window</p>
|
| 448 |
+
</div>
|
| 449 |
+
</div>
|
| 450 |
+
<div id="content">
|
| 451 |
+
<div class="sect1">
|
| 452 |
+
<h2 id="_synopsis">SYNOPSIS</h2>
|
| 453 |
+
<div class="sectionbody">
|
| 454 |
+
<div class="verseblock">
|
| 455 |
+
<pre class="content">git-bash [--cd-to-home] [--cd=<directory>] [--minimal-search-path]
|
| 456 |
+
[--command=<path>] [--app-id=<id>] [<args>…​]</pre>
|
| 457 |
+
</div>
|
| 458 |
+
</div>
|
| 459 |
+
</div>
|
| 460 |
+
<div class="sect1">
|
| 461 |
+
<h2 id="_description">DESCRIPTION</h2>
|
| 462 |
+
<div class="sectionbody">
|
| 463 |
+
<div class="paragraph">
|
| 464 |
+
<p>This command opens a window with an interactive Git Bash. It is specific to the
|
| 465 |
+
Git for Windows project.</p>
|
| 466 |
+
</div>
|
| 467 |
+
<div class="paragraph">
|
| 468 |
+
<p>By default, this will open a MinTTY window, but it can be configured in Git for
|
| 469 |
+
Windows' installer to use Windows' default Console window instead.</p>
|
| 470 |
+
</div>
|
| 471 |
+
<div class="paragraph">
|
| 472 |
+
<p>Before starting the interactive Bash session, the environment is adjusted a
|
| 473 |
+
bit. For example, the <code>PATH</code> is adjusted to find the <code>git</code> executable, and
|
| 474 |
+
<code>git-bash</code> will ensure that <code>HOME</code> is set (because it is expected to be present
|
| 475 |
+
by Git, and to point to the current user’s home directory). See the
|
| 476 |
+
<a href="#ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a> section below for more information.</p>
|
| 477 |
+
</div>
|
| 478 |
+
</div>
|
| 479 |
+
</div>
|
| 480 |
+
<div class="sect1">
|
| 481 |
+
<h2 id="_options">OPTIONS</h2>
|
| 482 |
+
<div class="sectionbody">
|
| 483 |
+
<div class="dlist">
|
| 484 |
+
<dl>
|
| 485 |
+
<dt class="hdlist1">--cd-to-home</dt>
|
| 486 |
+
<dt class="hdlist1">--no-cd</dt>
|
| 487 |
+
<dt class="hdlist1">--cd=<directory></dt>
|
| 488 |
+
<dd>
|
| 489 |
+
<p>By default, Git Bash will not change the current directory; To allow
|
| 490 |
+
e.g. for Windows Explorer integration ("Git Bash Here"), the
|
| 491 |
+
<code>--cd=</code><em><directory></em> option can be used to change the current directory
|
| 492 |
+
before running the interactive Bash.</p>
|
| 493 |
+
<div class="paragraph">
|
| 494 |
+
<p>The <code>--cd-to-home</code> option can be used to change the current directory to the
|
| 495 |
+
user’s home directory (as determined by the environment variable <code>HOME</code>). The
|
| 496 |
+
<code>--no-cd</code> option can be used to override <code>--cd</code> options that precede it.</p>
|
| 497 |
+
</div>
|
| 498 |
+
</dd>
|
| 499 |
+
<dt class="hdlist1">--minimal-search-path</dt>
|
| 500 |
+
<dt class="hdlist1">--no-minimal-search-path</dt>
|
| 501 |
+
<dd>
|
| 502 |
+
<p>By default, Git Bash will adjust the <code>PATH</code> not only to include the
|
| 503 |
+
<code>git</code> executable, but also all of the Unix-y tools (such as <code>sed</code>,
|
| 504 |
+
<code>awk</code>, etc). With <code>--minimal-search-path</code>, it will be adjusted so that
|
| 505 |
+
<strong>only</strong> the <code>git</code>, <code>git-gui</code> and <code>gitk</code> executables are found, as well
|
| 506 |
+
as the scripts <code>start-ssh-agent.cmd</code> and <code>start-ssh-pageant.cmd</code>.</p>
|
| 507 |
+
</dd>
|
| 508 |
+
<dt class="hdlist1">--command=<command></dt>
|
| 509 |
+
<dd>
|
| 510 |
+
<p>Allows the user to ask for a different command to be specified.
|
| 511 |
+
Defaults to <code>usr\\bin\\mintty.exe</code>. If the specified command is not an
|
| 512 |
+
absolute path, it is interpreted relative to <code>git-bash.exe</code>.</p>
|
| 513 |
+
</dd>
|
| 514 |
+
<dt class="hdlist1">--app-id=<command></dt>
|
| 515 |
+
<dd>
|
| 516 |
+
<p>Allows the user to override the ID used e.g. in Windows' Task Bar.
|
| 517 |
+
Defaults to <code>GitForWindows.Bash</code>.</p>
|
| 518 |
+
</dd>
|
| 519 |
+
<dt class="hdlist1">--needs-console</dt>
|
| 520 |
+
<dt class="hdlist1">--no-needs-console</dt>
|
| 521 |
+
<dt class="hdlist1">--hide</dt>
|
| 522 |
+
<dt class="hdlist1">--no-hide</dt>
|
| 523 |
+
<dt class="hdlist1">--append-quote</dt>
|
| 524 |
+
<dt class="hdlist1">--no-append-quote</dt>
|
| 525 |
+
<dd>
|
| 526 |
+
<p>These options do not make sense in the context of <code>git-bash</code>; They are
|
| 527 |
+
merely inherited from the Git Wrapper (see the <a href="#GIT-WRAPPER">GIT WRAPPER</a> section
|
| 528 |
+
below).</p>
|
| 529 |
+
</dd>
|
| 530 |
+
</dl>
|
| 531 |
+
</div>
|
| 532 |
+
<div class="sect2">
|
| 533 |
+
<h3 id="ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</h3>
|
| 534 |
+
<div class="paragraph">
|
| 535 |
+
<p>Upon startup, <code>git-bash</code> will ensure that a couple of environment variables are
|
| 536 |
+
set/adjusted.</p>
|
| 537 |
+
</div>
|
| 538 |
+
<div class="paragraph">
|
| 539 |
+
<p>The most important variable to adjust is <code>PATH</code>: Git Bash does want to make
|
| 540 |
+
sure that the <code>git</code> executable is in the search path.</p>
|
| 541 |
+
</div>
|
| 542 |
+
<div class="paragraph">
|
| 543 |
+
<p>If <code>HOME</code> is unset, <code>git-bash</code> will first look whether <code>%HOMEDRIVE%%HOMEPATH%</code>
|
| 544 |
+
points to a valid directory and if it does, use it as value for <code>HOME</code>. If
|
| 545 |
+
either <code>HOMEDRIVE</code> or <code>HOMEPATH</code> are unset, or if they do not point to a valid
|
| 546 |
+
directory, <code>%USERPROFILE%</code> is used instead.</p>
|
| 547 |
+
</div>
|
| 548 |
+
</div>
|
| 549 |
+
<div class="sect2">
|
| 550 |
+
<h3 id="GIT-WRAPPER">GIT WRAPPER</h3>
|
| 551 |
+
<div class="paragraph">
|
| 552 |
+
<p>In the Git for Windows project, the source code of <code>git-bash</code> is called the
|
| 553 |
+
"Git Wrapper", as it merely parses the command-line parameters, sets up a few
|
| 554 |
+
environment variables, then spawns the actual command, and waits for the
|
| 555 |
+
spawned command to exit. The Git Wrapper is not only used for <code>git-bash</code> but
|
| 556 |
+
also for <code>git-cmd</code> and for certain placeholders internal to Git (the so-called
|
| 557 |
+
"built-ins").</p>
|
| 558 |
+
</div>
|
| 559 |
+
</div>
|
| 560 |
+
</div>
|
| 561 |
+
</div>
|
| 562 |
+
<div class="sect1">
|
| 563 |
+
<h2 id="_authors">Authors</h2>
|
| 564 |
+
<div class="sectionbody">
|
| 565 |
+
<div class="paragraph">
|
| 566 |
+
<p>The "Git Wrapper" was written by Johannes Schindelin and other Git for Windows
|
| 567 |
+
contributors.</p>
|
| 568 |
+
</div>
|
| 569 |
+
</div>
|
| 570 |
+
</div>
|
| 571 |
+
<div class="sect1">
|
| 572 |
+
<h2 id="_git">GIT</h2>
|
| 573 |
+
<div class="sectionbody">
|
| 574 |
+
<div class="paragraph">
|
| 575 |
+
<p>Part of the <a href="git.html">git(1)</a> suite</p>
|
| 576 |
+
</div>
|
| 577 |
+
</div>
|
| 578 |
+
</div>
|
| 579 |
+
</div>
|
| 580 |
+
<div id="footer">
|
| 581 |
+
<div id="footer-text">
|
| 582 |
+
Last updated 2026-04-20 17:51:23 UTC
|
| 583 |
+
</div>
|
| 584 |
+
</div>
|
| 585 |
+
</body>
|
| 586 |
+
</html>
|