Compare commits
13 Commits
v2.33.0-rc
...
v2.31.3
Author | SHA1 | Date | |
---|---|---|---|
09f66d65f8 | |||
17083c79ae | |||
0f85c4a30b | |||
bb50ec3cc3 | |||
e47363e5a8 | |||
44de39c45c | |||
6a2381a3e5 | |||
cb95038137 | |||
fdcad5a53e | |||
8959555cee | |||
bdc77d1d68 | |||
2a9a5862e5 | |||
6e7ad1e4c2 |
26
.github/workflows/check-whitespace.yml
vendored
26
.github/workflows/check-whitespace.yml
vendored
@ -12,9 +12,15 @@ jobs:
|
||||
check-whitespace:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Set commit count
|
||||
shell: bash
|
||||
run: echo "COMMIT_DEPTH=$((1+$COMMITS))" >>$GITHUB_ENV
|
||||
env:
|
||||
COMMITS: ${{ github.event.pull_request.commits }}
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
fetch-depth: ${{ env.COMMIT_DEPTH }}
|
||||
|
||||
- name: git log --check
|
||||
id: check_out
|
||||
@ -41,9 +47,25 @@ jobs:
|
||||
echo "${dash} ${etc}"
|
||||
;;
|
||||
esac
|
||||
done <<< $(git log --check --pretty=format:"---% h% s" ${{github.event.pull_request.base.sha}}..)
|
||||
done <<< $(git log --check --pretty=format:"---% h% s" -${{github.event.pull_request.commits}})
|
||||
|
||||
if test -n "${log}"
|
||||
then
|
||||
echo "::set-output name=checkout::"${log}""
|
||||
exit 2
|
||||
fi
|
||||
|
||||
- name: Add Check Output as Comment
|
||||
uses: actions/github-script@v3
|
||||
id: add-comment
|
||||
env:
|
||||
log: ${{ steps.check_out.outputs.checkout }}
|
||||
with:
|
||||
script: |
|
||||
await github.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: `Whitespace errors found in workflow ${{ github.workflow }}:\n\n\`\`\`\n${process.env.log.replace(/\\n/g, "\n")}\n\`\`\``
|
||||
})
|
||||
if: ${{ failure() }}
|
||||
|
182
.github/workflows/main.yml
vendored
182
.github/workflows/main.yml
vendored
@ -81,21 +81,44 @@ jobs:
|
||||
if: needs.ci-config.outputs.enabled == 'yes'
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: git-for-windows/setup-git-for-windows-sdk@v1
|
||||
- name: build
|
||||
- uses: actions/checkout@v1
|
||||
- name: download git-sdk-64-minimal
|
||||
shell: bash
|
||||
run: |
|
||||
## Get artifact
|
||||
urlbase=https://dev.azure.com/git-for-windows/git/_apis/build/builds
|
||||
id=$(curl "$urlbase?definitions=22&statusFilter=completed&resultFilter=succeeded&\$top=1" |
|
||||
jq -r ".value[] | .id")
|
||||
download_url="$(curl "$urlbase/$id/artifacts" |
|
||||
jq -r '.value[] | select(.name == "git-sdk-64-minimal").resource.downloadUrl')"
|
||||
curl --connect-timeout 10 --retry 5 --retry-delay 0 --retry-max-time 240 \
|
||||
-o artifacts.zip "$download_url"
|
||||
|
||||
## Unzip and remove the artifact
|
||||
unzip artifacts.zip
|
||||
rm artifacts.zip
|
||||
- name: build
|
||||
shell: powershell
|
||||
env:
|
||||
HOME: ${{runner.workspace}}
|
||||
MSYSTEM: MINGW64
|
||||
NO_PERL: 1
|
||||
run: ci/make-test-artifacts.sh artifacts
|
||||
- name: zip up tracked files
|
||||
run: git archive -o artifacts/tracked.tar.gz HEAD
|
||||
- name: upload tracked files and build artifacts
|
||||
uses: actions/upload-artifact@v2
|
||||
run: |
|
||||
& .\git-sdk-64-minimal\usr\bin\bash.exe -lc @"
|
||||
printf '%s\n' /git-sdk-64-minimal/ >>.git/info/exclude
|
||||
|
||||
ci/make-test-artifacts.sh artifacts
|
||||
"@
|
||||
- name: upload build artifacts
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: windows-artifacts
|
||||
path: artifacts
|
||||
- name: upload git-sdk-64-minimal
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: git-sdk-64-minimal
|
||||
path: git-sdk-64-minimal
|
||||
windows-test:
|
||||
runs-on: windows-latest
|
||||
needs: [windows-build]
|
||||
@ -104,25 +127,37 @@ jobs:
|
||||
matrix:
|
||||
nr: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
|
||||
steps:
|
||||
- name: download tracked files and build artifacts
|
||||
uses: actions/download-artifact@v2
|
||||
- uses: actions/checkout@v1
|
||||
- name: download build artifacts
|
||||
uses: actions/download-artifact@v1
|
||||
with:
|
||||
name: windows-artifacts
|
||||
path: ${{github.workspace}}
|
||||
- name: extract tracked files and build artifacts
|
||||
- name: extract build artifacts
|
||||
shell: bash
|
||||
run: tar xf artifacts.tar.gz && tar xf tracked.tar.gz
|
||||
- uses: git-for-windows/setup-git-for-windows-sdk@v1
|
||||
run: tar xf artifacts.tar.gz
|
||||
- name: download git-sdk-64-minimal
|
||||
uses: actions/download-artifact@v1
|
||||
with:
|
||||
name: git-sdk-64-minimal
|
||||
path: ${{github.workspace}}/git-sdk-64-minimal/
|
||||
- name: test
|
||||
shell: bash
|
||||
run: ci/run-test-slice.sh ${{matrix.nr}} 10
|
||||
shell: powershell
|
||||
run: |
|
||||
& .\git-sdk-64-minimal\usr\bin\bash.exe -lc @"
|
||||
# Let Git ignore the SDK
|
||||
printf '%s\n' /git-sdk-64-minimal/ >>.git/info/exclude
|
||||
|
||||
ci/run-test-slice.sh ${{matrix.nr}} 10
|
||||
"@
|
||||
- name: ci/print-test-failures.sh
|
||||
if: failure()
|
||||
shell: bash
|
||||
run: ci/print-test-failures.sh
|
||||
shell: powershell
|
||||
run: |
|
||||
& .\git-sdk-64-minimal\usr\bin\bash.exe -lc ci/print-test-failures.sh
|
||||
- name: Upload failed tests' directories
|
||||
if: failure() && env.FAILED_TEST_ARTIFACTS != ''
|
||||
uses: actions/upload-artifact@v2
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: failed-tests-windows
|
||||
path: ${{env.FAILED_TEST_ARTIFACTS}}
|
||||
@ -130,17 +165,27 @@ jobs:
|
||||
needs: ci-config
|
||||
if: needs.ci-config.outputs.enabled == 'yes'
|
||||
env:
|
||||
MSYSTEM: MINGW64
|
||||
NO_PERL: 1
|
||||
GIT_CONFIG_PARAMETERS: "'user.name=CI' 'user.email=ci@git'"
|
||||
runs-on: windows-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: git-for-windows/setup-git-for-windows-sdk@v1
|
||||
- name: initialize vcpkg
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
repository: 'microsoft/vcpkg'
|
||||
path: 'compat/vcbuild/vcpkg'
|
||||
- uses: actions/checkout@v1
|
||||
- name: download git-sdk-64-minimal
|
||||
shell: bash
|
||||
run: |
|
||||
## Get artifact
|
||||
urlbase=https://dev.azure.com/git-for-windows/git/_apis/build/builds
|
||||
id=$(curl "$urlbase?definitions=22&statusFilter=completed&resultFilter=succeeded&\$top=1" |
|
||||
jq -r ".value[] | .id")
|
||||
download_url="$(curl "$urlbase/$id/artifacts" |
|
||||
jq -r '.value[] | select(.name == "git-sdk-64-minimal").resource.downloadUrl')"
|
||||
curl --connect-timeout 10 --retry 5 --retry-delay 0 --retry-max-time 240 \
|
||||
-o artifacts.zip "$download_url"
|
||||
|
||||
## Unzip and remove the artifact
|
||||
unzip artifacts.zip
|
||||
rm artifacts.zip
|
||||
- name: download vcpkg artifacts
|
||||
shell: powershell
|
||||
run: |
|
||||
@ -153,60 +198,75 @@ jobs:
|
||||
- name: add msbuild to PATH
|
||||
uses: microsoft/setup-msbuild@v1
|
||||
- name: copy dlls to root
|
||||
shell: cmd
|
||||
run: compat\vcbuild\vcpkg_copy_dlls.bat release
|
||||
shell: powershell
|
||||
run: |
|
||||
& compat\vcbuild\vcpkg_copy_dlls.bat release
|
||||
if (!$?) { exit(1) }
|
||||
- name: generate Visual Studio solution
|
||||
shell: bash
|
||||
run: |
|
||||
cmake `pwd`/contrib/buildsystems/ -DCMAKE_PREFIX_PATH=`pwd`/compat/vcbuild/vcpkg/installed/x64-windows \
|
||||
-DNO_GETTEXT=YesPlease -DPERL_TESTS=OFF -DPYTHON_TESTS=OFF -DCURL_NO_CURL_CMAKE=ON
|
||||
-DMSGFMT_EXE=`pwd`/git-sdk-64-minimal/mingw64/bin/msgfmt.exe -DPERL_TESTS=OFF -DPYTHON_TESTS=OFF -DCURL_NO_CURL_CMAKE=ON
|
||||
- name: MSBuild
|
||||
run: msbuild git.sln -property:Configuration=Release -property:Platform=x64 -maxCpuCount:4 -property:PlatformToolset=v142
|
||||
- name: bundle artifact tar
|
||||
shell: bash
|
||||
shell: powershell
|
||||
env:
|
||||
MSVC: 1
|
||||
VCPKG_ROOT: ${{github.workspace}}\compat\vcbuild\vcpkg
|
||||
run: |
|
||||
mkdir -p artifacts &&
|
||||
eval "$(make -n artifacts-tar INCLUDE_DLLS_IN_ARTIFACTS=YesPlease ARTIFACTS_DIRECTORY=artifacts NO_GETTEXT=YesPlease 2>&1 | grep ^tar)"
|
||||
- name: zip up tracked files
|
||||
run: git archive -o artifacts/tracked.tar.gz HEAD
|
||||
- name: upload tracked files and build artifacts
|
||||
uses: actions/upload-artifact@v2
|
||||
& git-sdk-64-minimal\usr\bin\bash.exe -lc @"
|
||||
mkdir -p artifacts &&
|
||||
eval \"`$(make -n artifacts-tar INCLUDE_DLLS_IN_ARTIFACTS=YesPlease ARTIFACTS_DIRECTORY=artifacts 2>&1 | grep ^tar)\"
|
||||
"@
|
||||
- name: upload build artifacts
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: vs-artifacts
|
||||
path: artifacts
|
||||
vs-test:
|
||||
runs-on: windows-latest
|
||||
needs: vs-build
|
||||
needs: [vs-build, windows-build]
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
nr: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
|
||||
steps:
|
||||
- uses: git-for-windows/setup-git-for-windows-sdk@v1
|
||||
- name: download tracked files and build artifacts
|
||||
uses: actions/download-artifact@v2
|
||||
- uses: actions/checkout@v1
|
||||
- name: download git-sdk-64-minimal
|
||||
uses: actions/download-artifact@v1
|
||||
with:
|
||||
name: git-sdk-64-minimal
|
||||
path: ${{github.workspace}}/git-sdk-64-minimal/
|
||||
- name: download build artifacts
|
||||
uses: actions/download-artifact@v1
|
||||
with:
|
||||
name: vs-artifacts
|
||||
path: ${{github.workspace}}
|
||||
- name: extract tracked files and build artifacts
|
||||
- name: extract build artifacts
|
||||
shell: bash
|
||||
run: tar xf artifacts.tar.gz && tar xf tracked.tar.gz
|
||||
run: tar xf artifacts.tar.gz
|
||||
- name: test
|
||||
shell: bash
|
||||
shell: powershell
|
||||
env:
|
||||
MSYSTEM: MINGW64
|
||||
NO_SVN_TESTS: 1
|
||||
GIT_TEST_SKIP_REBASE_P: 1
|
||||
run: ci/run-test-slice.sh ${{matrix.nr}} 10
|
||||
run: |
|
||||
& .\git-sdk-64-minimal\usr\bin\bash.exe -lc @"
|
||||
# Let Git ignore the SDK and the test-cache
|
||||
printf '%s\n' /git-sdk-64-minimal/ /test-cache/ >>.git/info/exclude
|
||||
|
||||
ci/run-test-slice.sh ${{matrix.nr}} 10
|
||||
"@
|
||||
- name: ci/print-test-failures.sh
|
||||
if: failure()
|
||||
shell: bash
|
||||
run: ci/print-test-failures.sh
|
||||
shell: powershell
|
||||
run: |
|
||||
& .\git-sdk-64-minimal\usr\bin\bash.exe -lc ci/print-test-failures.sh
|
||||
- name: Upload failed tests' directories
|
||||
if: failure() && env.FAILED_TEST_ARTIFACTS != ''
|
||||
uses: actions/upload-artifact@v2
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: failed-tests-windows
|
||||
path: ${{env.FAILED_TEST_ARTIFACTS}}
|
||||
@ -237,14 +297,14 @@ jobs:
|
||||
jobname: ${{matrix.vector.jobname}}
|
||||
runs-on: ${{matrix.vector.pool}}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v1
|
||||
- run: ci/install-dependencies.sh
|
||||
- run: ci/run-build-and-tests.sh
|
||||
- run: ci/print-test-failures.sh
|
||||
if: failure()
|
||||
- name: Upload failed tests' directories
|
||||
if: failure() && env.FAILED_TEST_ARTIFACTS != ''
|
||||
uses: actions/upload-artifact@v2
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: failed-tests-${{matrix.vector.jobname}}
|
||||
path: ${{env.FAILED_TEST_ARTIFACTS}}
|
||||
@ -271,7 +331,7 @@ jobs:
|
||||
if: failure()
|
||||
- name: Upload failed tests' directories
|
||||
if: failure() && env.FAILED_TEST_ARTIFACTS != ''
|
||||
uses: actions/upload-artifact@v2
|
||||
uses: actions/upload-artifact@v1
|
||||
with:
|
||||
name: failed-tests-${{matrix.vector.jobname}}
|
||||
path: ${{env.FAILED_TEST_ARTIFACTS}}
|
||||
@ -282,29 +342,9 @@ jobs:
|
||||
jobname: StaticAnalysis
|
||||
runs-on: ubuntu-18.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v1
|
||||
- run: ci/install-dependencies.sh
|
||||
- run: ci/run-static-analysis.sh
|
||||
sparse:
|
||||
needs: ci-config
|
||||
if: needs.ci-config.outputs.enabled == 'yes'
|
||||
env:
|
||||
jobname: sparse
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Download a current `sparse` package
|
||||
# Ubuntu's `sparse` version is too old for us
|
||||
uses: git-for-windows/get-azure-pipelines-artifact@v0
|
||||
with:
|
||||
repository: git/git
|
||||
definitionId: 10
|
||||
artifact: sparse-20.04
|
||||
- name: Install the current `sparse` package
|
||||
run: sudo dpkg -i sparse-20.04/sparse_*.deb
|
||||
- uses: actions/checkout@v2
|
||||
- name: Install other dependencies
|
||||
run: ci/install-dependencies.sh
|
||||
- run: make sparse
|
||||
documentation:
|
||||
needs: ci-config
|
||||
if: needs.ci-config.outputs.enabled == 'yes'
|
||||
@ -312,6 +352,6 @@ jobs:
|
||||
jobname: Documentation
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v1
|
||||
- run: ci/install-dependencies.sh
|
||||
- run: ci/test-documentation.sh
|
||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -33,7 +33,6 @@
|
||||
/git-check-mailmap
|
||||
/git-check-ref-format
|
||||
/git-checkout
|
||||
/git-checkout--worker
|
||||
/git-checkout-index
|
||||
/git-cherry
|
||||
/git-cherry-pick
|
||||
@ -163,7 +162,6 @@
|
||||
/git-stripspace
|
||||
/git-submodule
|
||||
/git-submodule--helper
|
||||
/git-subtree
|
||||
/git-svn
|
||||
/git-switch
|
||||
/git-symbolic-ref
|
||||
|
1
.mailmap
1
.mailmap
@ -220,7 +220,6 @@ Philipp A. Hartmann <pah@qo.cx> <ph@sorgh.de>
|
||||
Philippe Bruhat <book@cpan.org>
|
||||
Ralf Thielow <ralf.thielow@gmail.com> <ralf.thielow@googlemail.com>
|
||||
Ramsay Jones <ramsay@ramsayjones.plus.com> <ramsay@ramsay1.demon.co.uk>
|
||||
Ramkumar Ramachandra <r@artagnon.com> <artagnon@gmail.com>
|
||||
Randall S. Becker <randall.becker@nexbridge.ca> <rsbecker@nexbridge.com>
|
||||
René Scharfe <l.s.r@web.de> <rene.scharfe@lsrfire.ath.cx>
|
||||
René Scharfe <l.s.r@web.de> Rene Scharfe
|
||||
|
@ -175,11 +175,6 @@ For shell scripts specifically (not exhaustive):
|
||||
|
||||
does not have such a problem.
|
||||
|
||||
- Even though "local" is not part of POSIX, we make heavy use of it
|
||||
in our test suite. We do not use it in scripted Porcelains, and
|
||||
hopefully nobody starts using "local" before they are reimplemented
|
||||
in C ;-)
|
||||
|
||||
|
||||
For C programs:
|
||||
|
||||
@ -503,12 +498,7 @@ Error Messages
|
||||
|
||||
- Do not end error messages with a full stop.
|
||||
|
||||
- Do not capitalize the first word, only because it is the first word
|
||||
in the message ("unable to open %s", not "Unable to open %s"). But
|
||||
"SHA-3 not supported" is fine, because the reason the first word is
|
||||
capitalized is not because it is at the beginning of the sentence,
|
||||
but because the word would be spelled in capital letters even when
|
||||
it appeared in the middle of the sentence.
|
||||
- Do not capitalize ("unable to open %s", not "Unable to open %s")
|
||||
|
||||
- Say what the error is first ("cannot open %s", not "%s: cannot open")
|
||||
|
||||
@ -551,51 +541,6 @@ Writing Documentation:
|
||||
documentation, please see the documentation-related advice in the
|
||||
Documentation/SubmittingPatches file).
|
||||
|
||||
In order to ensure the documentation is inclusive, avoid assuming
|
||||
that an unspecified example person is male or female, and think
|
||||
twice before using "he", "him", "she", or "her". Here are some
|
||||
tips to avoid use of gendered pronouns:
|
||||
|
||||
- Prefer succinctness and matter-of-factly describing functionality
|
||||
in the abstract. E.g.
|
||||
|
||||
--short:: Emit output in the short-format.
|
||||
|
||||
and avoid something like these overly verbose alternatives:
|
||||
|
||||
--short:: Use this to emit output in the short-format.
|
||||
--short:: You can use this to get output in the short-format.
|
||||
--short:: A user who prefers shorter output could....
|
||||
--short:: Should a person and/or program want shorter output, he
|
||||
she/they/it can...
|
||||
|
||||
This practice often eliminates the need to involve human actors in
|
||||
your description, but it is a good practice regardless of the
|
||||
avoidance of gendered pronouns.
|
||||
|
||||
- When it becomes awkward to stick to this style, prefer "you" when
|
||||
addressing the the hypothetical user, and possibly "we" when
|
||||
discussing how the program might react to the user. E.g.
|
||||
|
||||
You can use this option instead of --xyz, but we might remove
|
||||
support for it in future versions.
|
||||
|
||||
while keeping in mind that you can probably be less verbose, e.g.
|
||||
|
||||
Use this instead of --xyz. This option might be removed in future
|
||||
versions.
|
||||
|
||||
- If you still need to refer to an example person that is
|
||||
third-person singular, you may resort to "singular they" to avoid
|
||||
"he/she/him/her", e.g.
|
||||
|
||||
A contributor asks their upstream to pull from them.
|
||||
|
||||
Note that this sounds ungrammatical and unnatural to those who
|
||||
learned that "they" is only used for third-person plural, e.g.
|
||||
those who learn English as a second language in some parts of the
|
||||
world.
|
||||
|
||||
Every user-visible change should be reflected in the documentation.
|
||||
The same general rule as for code applies -- imitate the existing
|
||||
conventions.
|
||||
|
@ -2,8 +2,6 @@
|
||||
MAN1_TXT =
|
||||
MAN5_TXT =
|
||||
MAN7_TXT =
|
||||
HOWTO_TXT =
|
||||
DOC_DEP_TXT =
|
||||
TECH_DOCS =
|
||||
ARTICLES =
|
||||
SP_ARTICLES =
|
||||
@ -44,11 +42,6 @@ MAN7_TXT += gittutorial-2.txt
|
||||
MAN7_TXT += gittutorial.txt
|
||||
MAN7_TXT += gitworkflows.txt
|
||||
|
||||
HOWTO_TXT += $(wildcard howto/*.txt)
|
||||
|
||||
DOC_DEP_TXT += $(wildcard *.txt)
|
||||
DOC_DEP_TXT += $(wildcard config/*.txt)
|
||||
|
||||
ifdef MAN_FILTER
|
||||
MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))
|
||||
else
|
||||
@ -83,7 +76,6 @@ SP_ARTICLES += howto/rebuild-from-update-hook
|
||||
SP_ARTICLES += howto/rebase-from-internal-branch
|
||||
SP_ARTICLES += howto/keep-canonical-history-correct
|
||||
SP_ARTICLES += howto/maintain-git
|
||||
SP_ARTICLES += howto/coordinate-embargoed-releases
|
||||
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
|
||||
SP_ARTICLES += $(API_DOCS)
|
||||
|
||||
@ -98,7 +90,6 @@ TECH_DOCS += technical/multi-pack-index
|
||||
TECH_DOCS += technical/pack-format
|
||||
TECH_DOCS += technical/pack-heuristics
|
||||
TECH_DOCS += technical/pack-protocol
|
||||
TECH_DOCS += technical/parallel-checkout
|
||||
TECH_DOCS += technical/partial-clone
|
||||
TECH_DOCS += technical/protocol-capabilities
|
||||
TECH_DOCS += technical/protocol-common
|
||||
@ -139,7 +130,6 @@ ASCIIDOC_CONF = -f asciidoc.conf
|
||||
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \
|
||||
-amanversion=$(GIT_VERSION) \
|
||||
-amanmanual='Git Manual' -amansource='Git'
|
||||
ASCIIDOC_DEPS = asciidoc.conf GIT-ASCIIDOCFLAGS
|
||||
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
|
||||
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
|
||||
MANPAGE_XSL = manpage-normal.xsl
|
||||
@ -194,7 +184,6 @@ ASCIIDOC_DOCBOOK = docbook5
|
||||
ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
|
||||
ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
|
||||
ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
|
||||
ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
|
||||
DBLATEX_COMMON =
|
||||
XMLTO_EXTRA += --skip-validation
|
||||
XMLTO_EXTRA += -x manpage.xsl
|
||||
@ -295,8 +284,10 @@ docdep_prereqs = \
|
||||
mergetools-list.made $(mergetools_txt) \
|
||||
cmd-list.made $(cmds_txt)
|
||||
|
||||
doc.dep : $(docdep_prereqs) $(DOC_DEP_TXT) build-docdep.perl
|
||||
$(QUIET_GEN)$(PERL_PATH) ./build-docdep.perl >$@ $(QUIET_STDERR)
|
||||
doc.dep : $(docdep_prereqs) $(wildcard *.txt) $(wildcard config/*.txt) build-docdep.perl
|
||||
$(QUIET_GEN)$(RM) $@+ $@ && \
|
||||
$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \
|
||||
mv $@+ $@
|
||||
|
||||
ifneq ($(MAKECMDGOALS),clean)
|
||||
-include doc.dep
|
||||
@ -316,7 +307,8 @@ cmds_txt = cmds-ancillaryinterrogators.txt \
|
||||
$(cmds_txt): cmd-list.made
|
||||
|
||||
cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)
|
||||
$(QUIET_GEN)$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(cmds_txt) $(QUIET_STDERR) && \
|
||||
$(QUIET_GEN)$(RM) $@ && \
|
||||
$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(cmds_txt) $(QUIET_STDERR) && \
|
||||
date >$@
|
||||
|
||||
mergetools_txt = mergetools-diff.txt mergetools-merge.txt
|
||||
@ -324,7 +316,7 @@ mergetools_txt = mergetools-diff.txt mergetools-merge.txt
|
||||
$(mergetools_txt): mergetools-list.made
|
||||
|
||||
mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*)
|
||||
$(QUIET_GEN) \
|
||||
$(QUIET_GEN)$(RM) $@ && \
|
||||
$(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && \
|
||||
. ../git-mergetool--lib.sh && \
|
||||
show_tool_names can_diff "* " || :' >mergetools-diff.txt && \
|
||||
@ -353,23 +345,32 @@ clean:
|
||||
$(RM) manpage-base-url.xsl
|
||||
$(RM) GIT-ASCIIDOCFLAGS
|
||||
|
||||
$(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS)
|
||||
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) -d manpage -o $@ $<
|
||||
$(MAN_HTML): %.html : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
|
||||
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
|
||||
$(TXT_TO_HTML) -d manpage -o $@+ $< && \
|
||||
mv $@+ $@
|
||||
|
||||
$(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS)
|
||||
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) -o $@ $<
|
||||
$(OBSOLETE_HTML): %.html : %.txto asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
|
||||
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
|
||||
$(TXT_TO_HTML) -o $@+ $< && \
|
||||
mv $@+ $@
|
||||
|
||||
manpage-base-url.xsl: manpage-base-url.xsl.in
|
||||
$(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
|
||||
|
||||
%.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl)
|
||||
$(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
|
||||
$(QUIET_XMLTO)$(RM) $@ && \
|
||||
$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
|
||||
|
||||
%.xml : %.txt $(ASCIIDOC_DEPS)
|
||||
$(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $@ $<
|
||||
%.xml : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
|
||||
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
|
||||
$(TXT_TO_XML) -d manpage -o $@+ $< && \
|
||||
mv $@+ $@
|
||||
|
||||
user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
|
||||
$(QUIET_ASCIIDOC)$(TXT_TO_XML) -d book -o $@ $<
|
||||
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
|
||||
$(TXT_TO_XML) -d book -o $@+ $< && \
|
||||
mv $@+ $@
|
||||
|
||||
technical/api-index.txt: technical/api-index-skel.txt \
|
||||
technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS))
|
||||
@ -390,35 +391,46 @@ XSLTOPTS += --stringparam html.stylesheet docbook-xsl.css
|
||||
XSLTOPTS += --param generate.consistent.ids 1
|
||||
|
||||
user-manual.html: user-manual.xml $(XSLT)
|
||||
$(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
|
||||
$(QUIET_XSLTPROC)$(RM) $@+ $@ && \
|
||||
xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
|
||||
mv $@+ $@
|
||||
|
||||
git.info: user-manual.texi
|
||||
$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi
|
||||
|
||||
user-manual.texi: user-manual.xml
|
||||
$(QUIET_DB2TEXI)$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@+ && \
|
||||
$(PERL_PATH) fix-texi.perl <$@+ >$@ && \
|
||||
$(RM) $@+
|
||||
$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
|
||||
$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \
|
||||
$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \
|
||||
rm $@++ && \
|
||||
mv $@+ $@
|
||||
|
||||
user-manual.pdf: user-manual.xml
|
||||
$(QUIET_DBLATEX)$(DBLATEX) -o $@ $(DBLATEX_COMMON) $<
|
||||
$(QUIET_DBLATEX)$(RM) $@+ $@ && \
|
||||
$(DBLATEX) -o $@+ $(DBLATEX_COMMON) $< && \
|
||||
mv $@+ $@
|
||||
|
||||
gitman.texi: $(MAN_XML) cat-texi.perl texi.xsl
|
||||
$(QUIET_DB2TEXI) \
|
||||
$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
|
||||
($(foreach xml,$(sort $(MAN_XML)),xsltproc -o $(xml)+ texi.xsl $(xml) && \
|
||||
$(DOCBOOK2X_TEXI) --encoding=UTF-8 --to-stdout $(xml)+ && \
|
||||
$(RM) $(xml)+ &&) true) > $@+ && \
|
||||
$(PERL_PATH) cat-texi.perl $@ <$@+ >$@ && \
|
||||
$(RM) $@+
|
||||
rm $(xml)+ &&) true) > $@++ && \
|
||||
$(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \
|
||||
rm $@++ && \
|
||||
mv $@+ $@
|
||||
|
||||
gitman.info: gitman.texi
|
||||
$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi
|
||||
|
||||
$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
|
||||
$(QUIET_DB2TEXI)$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@
|
||||
$(QUIET_DB2TEXI)$(RM) $@+ $@ && \
|
||||
$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \
|
||||
mv $@+ $@
|
||||
|
||||
howto-index.txt: howto-index.sh $(HOWTO_TXT)
|
||||
$(QUIET_GEN)'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(HOWTO_TXT)) >$@
|
||||
howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
|
||||
$(QUIET_GEN)$(RM) $@+ $@ && \
|
||||
'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \
|
||||
mv $@+ $@
|
||||
|
||||
$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
|
||||
$(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt
|
||||
@ -426,10 +438,11 @@ $(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt
|
||||
WEBDOC_DEST = /pub/software/scm/git/docs
|
||||
|
||||
howto/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../
|
||||
$(patsubst %.txt,%.html,$(HOWTO_TXT)): %.html : %.txt GIT-ASCIIDOCFLAGS
|
||||
$(QUIET_ASCIIDOC) \
|
||||
$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt GIT-ASCIIDOCFLAGS
|
||||
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
|
||||
sed -e '1,/^$$/d' $< | \
|
||||
$(TXT_TO_HTML) - >$@
|
||||
$(TXT_TO_HTML) - >$@+ && \
|
||||
mv $@+ $@
|
||||
|
||||
install-webdoc : html
|
||||
'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST)
|
||||
@ -457,20 +470,11 @@ print-man1:
|
||||
@for i in $(MAN1_TXT); do echo $$i; done
|
||||
|
||||
lint-docs::
|
||||
$(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl \
|
||||
$(HOWTO_TXT) $(DOC_DEP_TXT) \
|
||||
--section=1 $(MAN1_TXT) \
|
||||
--section=5 $(MAN5_TXT) \
|
||||
--section=7 $(MAN7_TXT); \
|
||||
$(PERL_PATH) lint-man-end-blurb.perl $(MAN_TXT); \
|
||||
$(PERL_PATH) lint-man-section-order.perl $(MAN_TXT);
|
||||
$(QUIET_LINT)$(PERL_PATH) lint-gitlink.perl
|
||||
|
||||
ifeq ($(wildcard po/Makefile),po/Makefile)
|
||||
doc-l10n install-l10n::
|
||||
$(MAKE) -C po $@
|
||||
endif
|
||||
|
||||
# Delete the target file on error
|
||||
.DELETE_ON_ERROR:
|
||||
|
||||
.PHONY: FORCE
|
||||
|
@ -47,7 +47,7 @@ Veteran contributors who are especially interested in helping mentor newcomers
|
||||
are present on the list. In order to avoid search indexers, group membership is
|
||||
required to view messages; anyone can join and no approval is required.
|
||||
|
||||
==== https://web.libera.chat/#git-devel[#git-devel] on Libera Chat
|
||||
==== https://webchat.freenode.net/#git-devel[#git-devel] on Freenode
|
||||
|
||||
This IRC channel is for conversations between Git contributors. If someone is
|
||||
currently online and knows the answer to your question, you can receive help
|
||||
@ -827,7 +827,7 @@ either examining recent pull requests where someone has been granted `/allow`
|
||||
(https://github.com/gitgitgadget/git/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+%22%2Fallow%22[Search:
|
||||
is:pr is:open "/allow"]), in which case both the author and the person who
|
||||
granted the `/allow` can now `/allow` you, or by inquiring on the
|
||||
https://web.libera.chat/#git-devel[#git-devel] IRC channel on Libera Chat
|
||||
https://webchat.freenode.net/#git-devel[#git-devel] IRC channel on Freenode
|
||||
linking your pull request and asking for someone to `/allow` you.
|
||||
|
||||
If the CI fails, you can update your changes with `git rebase -i` and push your
|
||||
|
@ -50,7 +50,7 @@ Fixes since v1.6.0.2
|
||||
if the working tree is currently dirty.
|
||||
|
||||
* "git for-each-ref --format=%(subject)" fixed for commits with no
|
||||
newline in the message body.
|
||||
no newline in the message body.
|
||||
|
||||
* "git remote" fixed to protect printf from user input.
|
||||
|
||||
|
@ -365,7 +365,7 @@ details).
|
||||
(merge 2fbd4f9 mh/maint-lockfile-overflow later to maint).
|
||||
|
||||
* Invocations of "git checkout" used internally by "git rebase" were
|
||||
counted as "checkout", and affected later "git checkout -", which took
|
||||
counted as "checkout", and affected later "git checkout -" to the
|
||||
the user to an unexpected place.
|
||||
(merge 3bed291 rr/rebase-checkout-reflog later to maint).
|
||||
|
||||
|
@ -184,8 +184,8 @@ Performance, Internal Implementation, Development Support etc.
|
||||
the ref backend in use, as its format is much richer than the
|
||||
normal refs, and written directly by "git fetch" as a plain file..
|
||||
|
||||
* An unused binary has been discarded, and a bunch of commands
|
||||
have been turned into built-in.
|
||||
* An unused binary has been discarded, and and a bunch of commands
|
||||
have been turned into into built-in.
|
||||
|
||||
* A handful of places in in-tree code still relied on being able to
|
||||
execute the git subcommands, especially built-ins, in "git-foo"
|
||||
|
24
Documentation/RelNotes/2.30.3.txt
Normal file
24
Documentation/RelNotes/2.30.3.txt
Normal file
@ -0,0 +1,24 @@
|
||||
Git v2.30.2 Release Notes
|
||||
=========================
|
||||
|
||||
This release addresses the security issue CVE-2022-24765.
|
||||
|
||||
Fixes since v2.30.2
|
||||
-------------------
|
||||
|
||||
* Build fix on Windows.
|
||||
|
||||
* Fix `GIT_CEILING_DIRECTORIES` with Windows-style root directories.
|
||||
|
||||
* CVE-2022-24765:
|
||||
On multi-user machines, Git users might find themselves
|
||||
unexpectedly in a Git worktree, e.g. when another user created a
|
||||
repository in `C:\.git`, in a mounted network drive or in a
|
||||
scratch space. Merely having a Git-aware prompt that runs `git
|
||||
status` (or `git diff`) and navigating to a directory which is
|
||||
supposedly not a Git worktree, or opening such a directory in an
|
||||
editor or IDE such as VS Code or Atom, will potentially run
|
||||
commands defined by that other user.
|
||||
|
||||
Credit for finding this vulnerability goes to 俞晨东; The fix was
|
||||
authored by Johannes Schindelin.
|
21
Documentation/RelNotes/2.30.4.txt
Normal file
21
Documentation/RelNotes/2.30.4.txt
Normal file
@ -0,0 +1,21 @@
|
||||
Git v2.30.4 Release Notes
|
||||
=========================
|
||||
|
||||
This release contains minor fix-ups for the changes that went into
|
||||
Git 2.30.3, which was made to address CVE-2022-24765.
|
||||
|
||||
* The code that was meant to parse the new `safe.directory`
|
||||
configuration variable was not checking what configuration
|
||||
variable was being fed to it, which has been corrected.
|
||||
|
||||
* '*' can be used as the value for the `safe.directory` variable to
|
||||
signal that the user considers that any directory is safe.
|
||||
|
||||
|
||||
|
||||
Derrick Stolee (2):
|
||||
t0033: add tests for safe.directory
|
||||
setup: opt-out of check with safe.directory=*
|
||||
|
||||
Matheus Valadares (1):
|
||||
setup: fix safe.directory key not being checked
|
6
Documentation/RelNotes/2.31.2.txt
Normal file
6
Documentation/RelNotes/2.31.2.txt
Normal file
@ -0,0 +1,6 @@
|
||||
Git v2.31.2 Release Notes
|
||||
=========================
|
||||
|
||||
This release merges up the fixes that appear in v2.30.3 to address
|
||||
the security issue CVE-2022-24765; see the release notes for that
|
||||
version for details.
|
4
Documentation/RelNotes/2.31.3.txt
Normal file
4
Documentation/RelNotes/2.31.3.txt
Normal file
@ -0,0 +1,4 @@
|
||||
Git Documentation/RelNotes/2.31.3.txt Release Notes
|
||||
=========================
|
||||
|
||||
This release merges up the fixes that appear in v2.31.3.
|
@ -1,416 +0,0 @@
|
||||
Git 2.32 Release Notes
|
||||
======================
|
||||
|
||||
Backward compatibility notes
|
||||
----------------------------
|
||||
|
||||
* ".gitattributes", ".gitignore", and ".mailmap" files that are
|
||||
symbolic links are ignored.
|
||||
|
||||
* "git apply --3way" used to first attempt a straight application,
|
||||
and only fell back to the 3-way merge algorithm when the stright
|
||||
application failed. Starting with this version, the command will
|
||||
first try the 3-way merge algorithm and only when it fails (either
|
||||
resulting with conflict or the base versions of blobs are missing),
|
||||
falls back to the usual patch application.
|
||||
|
||||
|
||||
Updates since v2.31
|
||||
-------------------
|
||||
|
||||
UI, Workflows & Features
|
||||
|
||||
* It does not make sense to make ".gitattributes", ".gitignore" and
|
||||
".mailmap" symlinks, as they are supposed to be usable from the
|
||||
object store (think: bare repositories where HEAD:.mailmap etc. are
|
||||
used). When these files are symbolic links, we used to read the
|
||||
contents of the files pointed by them by mistake, which has been
|
||||
corrected.
|
||||
|
||||
* "git stash show" learned to optionally show untracked part of the
|
||||
stash.
|
||||
|
||||
* "git log --format='...'" learned "%(describe)" placeholder.
|
||||
|
||||
* "git repack" so far has been only capable of repacking everything
|
||||
under the sun into a single pack (or split by size). A cleverer
|
||||
strategy to reduce the cost of repacking a repository has been
|
||||
introduced.
|
||||
|
||||
* The http codepath learned to let the credential layer to cache the
|
||||
password used to unlock a certificate that has successfully been
|
||||
used.
|
||||
|
||||
* "git commit --fixup=<commit>", which was to tweak the changes made
|
||||
to the contents while keeping the original log message intact,
|
||||
learned "--fixup=(amend|reword):<commit>", that can be used to
|
||||
tweak both the message and the contents, and only the message,
|
||||
respectively.
|
||||
|
||||
* "git send-email" learned to honor the core.hooksPath configuration.
|
||||
|
||||
* "git format-patch -v<n>" learned to allow a reroll count that is
|
||||
not an integer.
|
||||
|
||||
* "git commit" learned "--trailer <key>[=<value>]" option; together
|
||||
with the interpret-trailers command, this will make it easier to
|
||||
support custom trailers.
|
||||
|
||||
* "git clone --reject-shallow" option fails the clone as soon as we
|
||||
notice that we are cloning from a shallow repository.
|
||||
|
||||
* A configuration variable has been added to force tips of certain
|
||||
refs to be given a reachability bitmap.
|
||||
|
||||
* "gitweb" learned "e-mail privacy" feature to redact strings that
|
||||
look like e-mail addresses on various pages.
|
||||
|
||||
* "git apply --3way" has always been "to fall back to 3-way merge
|
||||
only when straight application fails". Swap the order of falling
|
||||
back so that 3-way is always attempted first (only when the option
|
||||
is given, of course) and then straight patch application is used as
|
||||
a fallback when it fails.
|
||||
|
||||
* "git apply" now takes "--3way" and "--cached" at the same time, and
|
||||
work and record results only in the index.
|
||||
|
||||
* The command line completion (in contrib/) has learned that
|
||||
CHERRY_PICK_HEAD is a possible pseudo-ref.
|
||||
|
||||
* Userdiff patterns for "Scheme" has been added.
|
||||
|
||||
* "git log" learned "--diff-merges=<style>" option, with an
|
||||
associated configuration variable log.diffMerges.
|
||||
|
||||
* "git log --format=..." placeholders learned %ah/%ch placeholders to
|
||||
request the --date=human output.
|
||||
|
||||
* Replace GIT_CONFIG_NOSYSTEM mechanism to decline from reading the
|
||||
system-wide configuration file with GIT_CONFIG_SYSTEM that lets
|
||||
users specify from which file to read the system-wide configuration
|
||||
(setting it to an empty file would essentially be the same as
|
||||
setting NOSYSTEM), and introduce GIT_CONFIG_GLOBAL to override the
|
||||
per-user configuration in $HOME/.gitconfig.
|
||||
|
||||
* "git add" and "git rm" learned not to touch those paths that are
|
||||
outside of sparse checkout.
|
||||
|
||||
* "git rev-list" learns the "--filter=object:type=<type>" option,
|
||||
which can be used to exclude objects of the given kind from the
|
||||
packfile generated by pack-objects.
|
||||
|
||||
* The command line completion (in contrib/) for "git stash" has been
|
||||
updated.
|
||||
|
||||
* "git subtree" updates.
|
||||
|
||||
* It is now documented that "format-patch" skips merges.
|
||||
|
||||
* Options to "git pack-objects" that take numeric values like
|
||||
--window and --depth should not accept negative values; the input
|
||||
validation has been tightened.
|
||||
|
||||
* The way the command line specified by the trailer.<token>.command
|
||||
configuration variable receives the end-user supplied value was
|
||||
both error prone and misleading. An alternative to achieve the
|
||||
same goal in a safer and more intuitive way has been added, as
|
||||
the trailer.<token>.cmd configuration variable, to replace it.
|
||||
|
||||
* "git add -i --dry-run" does not dry-run, which was surprising. The
|
||||
combination of options has taught to error out.
|
||||
|
||||
* "git push" learns to discover common ancestor with the receiving
|
||||
end over protocol v2. This will hopefully make "git push" as
|
||||
efficient as "git fetch" in avoiding objects from getting
|
||||
transferred unnecessarily.
|
||||
|
||||
* "git mailinfo" (hence "git am") learned the "--quoted-cr" option to
|
||||
control how lines ending with CRLF wrapped in base64 or qp are
|
||||
handled.
|
||||
|
||||
|
||||
Performance, Internal Implementation, Development Support etc.
|
||||
|
||||
* Rename detection rework continues.
|
||||
|
||||
* GIT_TEST_FAIL_PREREQS is a mechanism to skip test pieces with
|
||||
prerequisites to catch broken tests that depend on the side effects
|
||||
of optional pieces, but did not work at all when negative
|
||||
prerequisites were involved.
|
||||
(merge 27d578d904 jk/fail-prereq-testfix later to maint).
|
||||
|
||||
* "git diff-index" codepath has been taught to trust fsmonitor status
|
||||
to reduce number of lstat() calls.
|
||||
(merge 7e5aa13d2c nk/diff-index-fsmonitor later to maint).
|
||||
|
||||
* Reorganize Makefile to allow building git.o and other essential
|
||||
objects without extra stuff needed only for testing.
|
||||
|
||||
* Preparatory API changes for parallel checkout.
|
||||
|
||||
* A simple IPC interface gets introduced to build services like
|
||||
fsmonitor on top.
|
||||
|
||||
* Fsck API clean-up.
|
||||
|
||||
* SECURITY.md that is facing individual contributors and end users
|
||||
has been introduced. Also a procedure to follow when preparing
|
||||
embargoed releases has been spelled out.
|
||||
(merge 09420b7648 js/security-md later to maint).
|
||||
|
||||
* Optimize "rev-list --use-bitmap-index --objects" corner case that
|
||||
uses negative tags as the stopping points.
|
||||
|
||||
* CMake update for vsbuild.
|
||||
|
||||
* An on-disk reverse-index to map the in-pack location of an object
|
||||
back to its object name across multiple packfiles is introduced.
|
||||
|
||||
* Generate [ec]tags under $(QUIET_GEN).
|
||||
|
||||
* Clean-up codepaths that implements "git send-email --validate"
|
||||
option and improves the message from it.
|
||||
|
||||
* The last remnant of gettext-poison has been removed.
|
||||
|
||||
* The test framework has been taught to optionally turn the default
|
||||
merge strategy to "ort" throughout the system where we use
|
||||
three-way merges internally, like cherry-pick, rebase etc.,
|
||||
primarily to enhance its test coverage (the strategy has been
|
||||
available as an explicit "-s ort" choice).
|
||||
|
||||
* A bit of code clean-up and a lot of test clean-up around userdiff
|
||||
area.
|
||||
|
||||
* Handling of "promisor packs" that allows certain objects to be
|
||||
missing and lazily retrievable has been optimized (a bit).
|
||||
|
||||
* When packet_write() fails, we gave an extra error message
|
||||
unnecessarily, which has been corrected.
|
||||
|
||||
* The checkout machinery has been taught to perform the actual
|
||||
write-out of the files in parallel when able.
|
||||
|
||||
* Show errno in the trace output in the error codepath that calls
|
||||
read_raw_ref method.
|
||||
|
||||
* Effort to make the command line completion (in contrib/) safe with
|
||||
"set -u" continues.
|
||||
|
||||
* Tweak a few tests for "log --format=..." that show timestamps in
|
||||
various formats.
|
||||
|
||||
* The reflog expiry machinery has been taught to emit trace events.
|
||||
|
||||
* Over-the-wire protocol learns a new request type to ask for object
|
||||
sizes given a list of object names.
|
||||
|
||||
|
||||
Fixes since v2.31
|
||||
-----------------
|
||||
|
||||
* The fsmonitor interface read from its input without making sure
|
||||
there is something to read from. This bug is new in 2.31
|
||||
timeframe.
|
||||
|
||||
* The data structure used by fsmonitor interface was not properly
|
||||
duplicated during an in-core merge, leading to use-after-free etc.
|
||||
|
||||
* "git bisect" reimplemented more in C during 2.30 timeframe did not
|
||||
take an annotated tag as a good/bad endpoint well. This regression
|
||||
has been corrected.
|
||||
|
||||
* Fix macros that can silently inject unintended null-statements.
|
||||
|
||||
* CALLOC_ARRAY() macro replaces many uses of xcalloc().
|
||||
|
||||
* Update insn in Makefile comments to run fuzz-all target.
|
||||
|
||||
* Fix a corner case bug in "git mv" on case insensitive systems,
|
||||
which was introduced in 2.29 timeframe.
|
||||
|
||||
* We had a code to diagnose and die cleanly when a required
|
||||
clean/smudge filter is missing, but an assert before that
|
||||
unnecessarily fired, hiding the end-user facing die() message.
|
||||
(merge 6fab35f748 mt/cleanly-die-upon-missing-required-filter later to maint).
|
||||
|
||||
* Update C code that sets a few configuration variables when a remote
|
||||
is configured so that it spells configuration variable names in the
|
||||
canonical camelCase.
|
||||
(merge 0f1da600e6 ab/remote-write-config-in-camel-case later to maint).
|
||||
|
||||
* A new configuration variable has been introduced to allow choosing
|
||||
which version of the generation number gets used in the
|
||||
commit-graph file.
|
||||
(merge 702110aac6 ds/commit-graph-generation-config later to maint).
|
||||
|
||||
* Perf test update to work better in secondary worktrees.
|
||||
(merge 36e834abc1 jk/perf-in-worktrees later to maint).
|
||||
|
||||
* Updates to memory allocation code around the use of pcre2 library.
|
||||
(merge c1760352e0 ab/grep-pcre2-allocfix later to maint).
|
||||
|
||||
* "git -c core.bare=false clone --bare ..." would have segfaulted,
|
||||
which has been corrected.
|
||||
(merge 75555676ad bc/clone-bare-with-conflicting-config later to maint).
|
||||
|
||||
* When "git checkout" removes a path that does not exist in the
|
||||
commit it is checking out, it wasn't careful enough not to follow
|
||||
symbolic links, which has been corrected.
|
||||
(merge fab78a0c3d mt/checkout-remove-nofollow later to maint).
|
||||
|
||||
* A few option description strings started with capital letters,
|
||||
which were corrected.
|
||||
(merge 5ee90326dc cc/downcase-opt-help later to maint).
|
||||
|
||||
* Plug or annotate remaining leaks that trigger while running the
|
||||
very basic set of tests.
|
||||
(merge 68ffe095a2 ah/plugleaks later to maint).
|
||||
|
||||
* The hashwrite() API uses a buffering mechanism to avoid calling
|
||||
write(2) too frequently. This logic has been refactored to be
|
||||
easier to understand.
|
||||
(merge ddaf1f62e3 ds/clarify-hashwrite later to maint).
|
||||
|
||||
* "git cherry-pick/revert" with or without "--[no-]edit" did not spawn
|
||||
the editor as expected (e.g. "revert --no-edit" after a conflict
|
||||
still asked to edit the message), which has been corrected.
|
||||
(merge 39edfd5cbc en/sequencer-edit-upon-conflict-fix later to maint).
|
||||
|
||||
* "git daemon" has been tightened against systems that take backslash
|
||||
as directory separator.
|
||||
(merge 9a7f1ce8b7 rs/daemon-sanitize-dir-sep later to maint).
|
||||
|
||||
* A NULL-dereference bug has been corrected in an error codepath in
|
||||
"git for-each-ref", "git branch --list" etc.
|
||||
(merge c685450880 jk/ref-filter-segfault-fix later to maint).
|
||||
|
||||
* Streamline the codepath to fix the UTF-8 encoding issues in the
|
||||
argv[] and the prefix on macOS.
|
||||
(merge c7d0e61016 tb/precompose-prefix-simplify later to maint).
|
||||
|
||||
* The command-line completion script (in contrib/) had a couple of
|
||||
references that would have given a warning under the "-u" (nounset)
|
||||
option.
|
||||
(merge c5c0548d79 vs/completion-with-set-u later to maint).
|
||||
|
||||
* When "git pack-objects" makes a literal copy of a part of existing
|
||||
packfile using the reachability bitmaps, its update to the progress
|
||||
meter was broken.
|
||||
(merge 8e118e8490 jk/pack-objects-bitmap-progress-fix later to maint).
|
||||
|
||||
* The dependencies for config-list.h and command-list.h were broken
|
||||
when the former was split out of the latter, which has been
|
||||
corrected.
|
||||
(merge 56550ea718 sg/bugreport-fixes later to maint).
|
||||
|
||||
* "git push --quiet --set-upstream" was not quiet when setting the
|
||||
upstream branch configuration, which has been corrected.
|
||||
(merge f3cce896a8 ow/push-quiet-set-upstream later to maint).
|
||||
|
||||
* The prefetch task in "git maintenance" assumed that "git fetch"
|
||||
from any remote would fetch all its local branches, which would
|
||||
fetch too much if the user is interested in only a subset of
|
||||
branches there.
|
||||
(merge 32f67888d8 ds/maintenance-prefetch-fix later to maint).
|
||||
|
||||
* Clarify that pathnames recorded in Git trees are most often (but
|
||||
not necessarily) encoded in UTF-8.
|
||||
(merge 9364bf465d ab/pathname-encoding-doc later to maint).
|
||||
|
||||
* "git --config-env var=val cmd" weren't accepted (only
|
||||
--config-env=var=val was).
|
||||
(merge c331551ccf ps/config-env-option-with-separate-value later to maint).
|
||||
|
||||
* When the reachability bitmap is in effect, the "do not lose
|
||||
recently created objects and those that are reachable from them"
|
||||
safety to protect us from races were disabled by mistake, which has
|
||||
been corrected.
|
||||
(merge 2ba582ba4c jk/prune-with-bitmap-fix later to maint).
|
||||
|
||||
* Cygwin pathname handling fix.
|
||||
(merge bccc37fdc7 ad/cygwin-no-backslashes-in-paths later to maint).
|
||||
|
||||
* "git rebase --[no-]reschedule-failed-exec" did not work well with
|
||||
its configuration variable, which has been corrected.
|
||||
(merge e5b32bffd1 ab/rebase-no-reschedule-failed-exec later to maint).
|
||||
|
||||
* Portability fix for command line completion script (in contrib/).
|
||||
(merge f2acf763e2 si/zsh-complete-comment-fix later to maint).
|
||||
|
||||
* "git repack -A -d" in a partial clone unnecessarily loosened
|
||||
objects in promisor pack.
|
||||
|
||||
* "git bisect skip" when custom words are used for new/old did not
|
||||
work, which has been corrected.
|
||||
|
||||
* A few variants of informational message "Already up-to-date" has
|
||||
been rephrased.
|
||||
(merge ad9322da03 js/merge-already-up-to-date-message-reword later to maint).
|
||||
|
||||
* "git submodule update --quiet" did not propagate the quiet option
|
||||
down to underlying "git fetch", which has been corrected.
|
||||
(merge 62af4bdd42 nc/submodule-update-quiet later to maint).
|
||||
|
||||
* Document that our test can use "local" keyword.
|
||||
(merge a84fd3bcc6 jc/test-allows-local later to maint).
|
||||
|
||||
* The word-diff mode has been taught to work better with a word
|
||||
regexp that can match an empty string.
|
||||
(merge 0324e8fc6b pw/word-diff-zero-width-matches later to maint).
|
||||
|
||||
* "git p4" learned to find branch points more efficiently.
|
||||
(merge 6b79818bfb jk/p4-locate-branch-point-optim later to maint).
|
||||
|
||||
* When "git update-ref -d" removes a ref that is packed, it left
|
||||
empty directories under $GIT_DIR/refs/ for
|
||||
(merge 5f03e5126d wc/packed-ref-removal-cleanup later to maint).
|
||||
|
||||
* "git clean" and "git ls-files -i" had confusion around working on
|
||||
or showing ignored paths inside an ignored directory, which has
|
||||
been corrected.
|
||||
(merge b548f0f156 en/dir-traversal later to maint).
|
||||
|
||||
* The handling of "%(push)" formatting element of "for-each-ref" and
|
||||
friends was broken when the same codepath started handling
|
||||
"%(push:<what>)", which has been corrected.
|
||||
(merge 1e1c4c5eac zh/ref-filter-push-remote-fix later to maint).
|
||||
|
||||
* The bash prompt script (in contrib/) did not work under "set -u".
|
||||
(merge 5c0cbdb107 en/prompt-under-set-u later to maint).
|
||||
|
||||
* The "chainlint" feature in the test framework is a handy way to
|
||||
catch common mistakes in writing new tests, but tends to get
|
||||
expensive. An knob to selectively disable it has been introduced
|
||||
to help running tests that the developer has not modified.
|
||||
(merge 2d86a96220 jk/test-chainlint-softer later to maint).
|
||||
|
||||
* The "rev-parse" command did not diagnose the lack of argument to
|
||||
"--path-format" option, which was introduced in v2.31 era, which
|
||||
has been corrected.
|
||||
(merge 99fc555188 wm/rev-parse-path-format-wo-arg later to maint).
|
||||
|
||||
* Other code cleanup, docfix, build fix, etc.
|
||||
(merge f451960708 dl/cat-file-doc-cleanup later to maint).
|
||||
(merge 12604a8d0c sv/t9801-test-path-is-file-cleanup later to maint).
|
||||
(merge ea7e63921c jr/doc-ignore-typofix later to maint).
|
||||
(merge 23c781f173 ps/update-ref-trans-hook-doc later to maint).
|
||||
(merge 42efa1231a jk/filter-branch-sha256 later to maint).
|
||||
(merge 4c8e3dca6e tb/push-simple-uses-branch-merge-config later to maint).
|
||||
(merge 6534d436a2 bs/asciidoctor-installation-hints later to maint).
|
||||
(merge 47957485b3 ab/read-tree later to maint).
|
||||
(merge 2be927f3d1 ab/diff-no-index-tests later to maint).
|
||||
(merge 76593c09bb ab/detox-gettext-tests later to maint).
|
||||
(merge 28e29ee38b jc/doc-format-patch-clarify later to maint).
|
||||
(merge fc12b6fdde fm/user-manual-use-preface later to maint).
|
||||
(merge dba94e3a85 cc/test-helper-bloom-usage-fix later to maint).
|
||||
(merge 61a7660516 hn/reftable-tables-doc-update later to maint).
|
||||
(merge 81ed96a9b2 jt/fetch-pack-request-fix later to maint).
|
||||
(merge 151b6c2dd7 jc/doc-do-not-capitalize-clarification later to maint).
|
||||
(merge 9160068ac6 js/access-nul-emulation-on-windows later to maint).
|
||||
(merge 7a14acdbe6 po/diff-patch-doc later to maint).
|
||||
(merge f91371b948 pw/patience-diff-clean-up later to maint).
|
||||
(merge 3a7f0908b6 mt/clean-clean later to maint).
|
||||
(merge d4e2d15a8b ab/streaming-simplify later to maint).
|
||||
(merge 0e59f7ad67 ah/merge-ort-i18n later to maint).
|
||||
(merge e6f68f62e0 ls/typofix later to maint).
|
@ -1,280 +0,0 @@
|
||||
Git 2.33 Release Notes
|
||||
======================
|
||||
|
||||
Backward compatibility notes
|
||||
----------------------------
|
||||
|
||||
* The "-m" option in "git log -m" that does not specify which format,
|
||||
if any, of diff is desired did not have any visible effect; it now
|
||||
implies some form of diff (by default "--patch") is produced.
|
||||
|
||||
You can disable the diff output with "git log -m --no-patch", but
|
||||
then there probably isn't much point in passing "-m" in the first
|
||||
place ;-).
|
||||
|
||||
|
||||
Updates since Git 2.32
|
||||
----------------------
|
||||
|
||||
UI, Workflows & Features
|
||||
|
||||
* "git send-email" learned the "--sendmail-cmd" command line option
|
||||
and the "sendemail.sendmailCmd" configuration variable, which is a
|
||||
more sensible approach than the current way of repurposing the
|
||||
"smtp-server" that is meant to name the server to instead name the
|
||||
command to talk to the server.
|
||||
|
||||
* The "-m" option in "git log -m" that does not specify which format,
|
||||
if any, of diff is desired did not have any visible effect; it now
|
||||
implies some form of diff (by default "--patch") is produced.
|
||||
|
||||
* The userdiff pattern for C# learned the token "record".
|
||||
|
||||
* "git rev-list" learns to omit the "commit <object-name>" header
|
||||
lines from the output with the `--no-commit-header` option.
|
||||
|
||||
* "git worktree add --lock" learned to record why the worktree is
|
||||
locked with a custom message.
|
||||
|
||||
|
||||
Performance, Internal Implementation, Development Support etc.
|
||||
|
||||
* The code to handle the "--format" option in "for-each-ref" and
|
||||
friends made too many string comparisons on %(atom)s used in the
|
||||
format string, which has been corrected by converting them into
|
||||
enum when the format string is parsed.
|
||||
|
||||
* Use the hashfile API in the codepath that writes the index file to
|
||||
reduce code duplication.
|
||||
|
||||
* Repeated rename detections in a sequence of mergy operations have
|
||||
been optimize out.
|
||||
|
||||
* Preliminary clean-up of tests before the main reftable changes
|
||||
hits the codebase.
|
||||
|
||||
* The backend for "diff -G/-S" has been updated to use pcre2 engine
|
||||
when available.
|
||||
|
||||
* Use ".DELETE_ON_ERROR" pseudo target to simplify our Makefile.
|
||||
|
||||
* Code cleanup around struct_type_init() functions.
|
||||
|
||||
* "git send-email" optimization.
|
||||
|
||||
* GitHub Actions / CI update.
|
||||
(merge 0dc787a9f2 js/ci-windows-update later to maint).
|
||||
|
||||
* Object accesses in repositories with many alternate object store
|
||||
have been optimized.
|
||||
|
||||
* "git log" has been optimized not to waste cycles to load ref
|
||||
decoration data that may not be needed.
|
||||
|
||||
* Many "printf"-like helper functions we have have been annotated
|
||||
with __attribute__() to catch placeholder/parameter mismatches.
|
||||
|
||||
* Tests that cover protocol bits have been updated and helpers
|
||||
used there have been consolidated.
|
||||
|
||||
* The CI gained a new job to run "make sparse" check.
|
||||
|
||||
* "git status" codepath learned to work with sparsely populated index
|
||||
without hydrating it fully.
|
||||
|
||||
* A guideline for gender neutral documentation has been added.
|
||||
|
||||
* Documentation on "git diff -l<n>" and diff.renameLimit have been
|
||||
updated, and the defaults for these limits have been raised.
|
||||
|
||||
* The completion support used to offer alternate spelling of options
|
||||
that exist only for compatibility, which has been corrected.
|
||||
|
||||
* "TEST_OUTPUT_DIRECTORY=there make test" failed to work, which has
|
||||
been corrected.
|
||||
|
||||
* "git bundle" gained more test coverage.
|
||||
|
||||
* "git read-tree" had a codepath where blobs are fetched one-by-one
|
||||
from the promisor remote, which has been corrected to fetch in bulk.
|
||||
|
||||
|
||||
Fixes since v2.32
|
||||
-----------------
|
||||
|
||||
* We historically rejected a very short string as an author name
|
||||
while accepting a patch e-mail, which has been loosened.
|
||||
(merge 72ee47ceeb ef/mailinfo-short-name later to maint).
|
||||
|
||||
* The parallel checkout codepath did not initialize object ID field
|
||||
used to talk to the worker processes in a futureproof way.
|
||||
|
||||
* Rewrite code that triggers undefined behaviour warning.
|
||||
(merge aafa5df0df jn/size-t-casted-to-off-t-fix later to maint).
|
||||
|
||||
* The description of "fast-forward" in the glossary has been updated.
|
||||
(merge e22f2daed0 ry/clarify-fast-forward-in-glossary later to maint).
|
||||
|
||||
* Recent "git clone" left a temporary directory behind when the
|
||||
transport layer returned an failure.
|
||||
(merge 6aacb7d861 jk/clone-clean-upon-transport-error later to maint).
|
||||
|
||||
* "git fetch" over protocol v2 left its side of the socket open after
|
||||
it finished speaking, which unnecessarily wasted the resource on
|
||||
the other side.
|
||||
(merge ae1a7eefff jk/fetch-pack-v2-half-close-early later to maint).
|
||||
|
||||
* The command line completion (in contrib/) learned that "git diff"
|
||||
takes the "--anchored" option.
|
||||
(merge d1e7c2cac9 tb/complete-diff-anchored later to maint).
|
||||
|
||||
* "git-svn" tests assumed that "locale -a", which is used to pick an
|
||||
available UTF-8 locale, is available everywhere. A knob has been
|
||||
introduced to allow testers to specify a suitable locale to use.
|
||||
(merge 482c962de4 dd/svn-test-wo-locale-a later to maint).
|
||||
|
||||
* Update "git subtree" to work better on Windows.
|
||||
(merge 77f37de39f js/subtree-on-windows-fix later to maint).
|
||||
|
||||
* Remove multimail from contrib/
|
||||
(merge f74d11471f js/no-more-multimail later to maint).
|
||||
|
||||
* Make the codebase MSAN clean.
|
||||
(merge 4dbc55e87d ah/uninitialized-reads-fix later to maint).
|
||||
|
||||
* Work around inefficient glob substitution in older versions of bash
|
||||
by rewriting parts of a test.
|
||||
(merge eb87c6f559 jx/t6020-with-older-bash later to maint).
|
||||
|
||||
* Avoid duplicated work while building reachability bitmaps.
|
||||
(merge aa9ad6fee5 jk/bitmap-tree-optim later to maint).
|
||||
|
||||
* We broke "GIT_SKIP_TESTS=t?000" to skip certain tests in recent
|
||||
update, which got fixed.
|
||||
|
||||
* The side-band demultiplexer that is used to display progress output
|
||||
from the remote end did not clear the line properly when the end of
|
||||
line hits at a packet boundary, which has been corrected.
|
||||
|
||||
* Some test scripts assumed that readlink(1) was universally
|
||||
installed and available, which is not the case.
|
||||
(merge 7c0afdf23c jk/test-without-readlink-1 later to maint).
|
||||
|
||||
* Recent update to completion script (in contrib/) broke those who
|
||||
use the __git_complete helper to define completion to their custom
|
||||
command.
|
||||
(merge cea232194d fw/complete-cmd-idx-fix later to maint).
|
||||
|
||||
* Output from some of our tests were affected by the width of the
|
||||
terminal that they were run in, which has been corrected by
|
||||
exporting a fixed value in the COLUMNS environment.
|
||||
(merge c49a177bec ab/fix-columns-to-80-during-tests later to maint).
|
||||
|
||||
* On Windows, mergetool has been taught to find kdiff3.exe just like
|
||||
it finds winmerge.exe.
|
||||
(merge 47eb4c6890 ms/mergetools-kdiff3-on-windows later to maint).
|
||||
|
||||
* When we cannot figure out how wide the terminal is, we use a
|
||||
fallback value of 80 ourselves (which cannot be avoided), but when
|
||||
we run the pager, we export it in COLUMNS, which forces the pager
|
||||
to use the hardcoded value, even when the pager is perfectly
|
||||
capable to figure it out itself. Stop exporting COLUMNS when we
|
||||
fall back on the hardcoded default value for our own use.
|
||||
(merge 9b6e2c8b98 js/stop-exporting-bogus-columns later to maint).
|
||||
|
||||
* "git cat-file --batch-all-objects"" misbehaved when "--batch" is in
|
||||
use and did not ask for certain object traits.
|
||||
(merge ee02ac6164 zh/cat-file-batch-fix later to maint).
|
||||
|
||||
* Some code and doc clarification around "git push".
|
||||
|
||||
* The "union" conflict resultion variant misbehaved when used with
|
||||
binary merge driver.
|
||||
(merge 382b601acd jk/union-merge-binary later to maint).
|
||||
|
||||
* Prevent "git p4" from failing to submit changes to binary file.
|
||||
(merge 54662d5958 dc/p4-binary-submit-fix later to maint).
|
||||
|
||||
* "git grep --and -e foo" ought to have been diagnosed as an error
|
||||
but instead segfaulted, which has been corrected.
|
||||
(merge fe7fe62d8d rs/grep-parser-fix later to maint).
|
||||
|
||||
* The merge code had funny interactions between content based rename
|
||||
detection and directory rename detection.
|
||||
(merge 3585d0ea23 en/merge-dir-rename-corner-case-fix later to maint).
|
||||
|
||||
* When rebuilding the multi-pack index file reusing an existing one,
|
||||
we used to blindly trust the existing file and ended up carrying
|
||||
corrupted data into the updated file, which has been corrected.
|
||||
(merge f89ecf7988 tb/midx-use-checksum later to maint).
|
||||
|
||||
* Update the location of system-side configuration file on Windows.
|
||||
(merge e355307692 js/gfw-system-config-loc-fix later to maint).
|
||||
|
||||
* Code recently added to support common ancestry negotiation during
|
||||
"git push" did not sanity check its arguments carefully enough.
|
||||
(merge eff40457a4 ab/fetch-negotiate-segv-fix later to maint).
|
||||
|
||||
* Update the documentation not to assume users are of certain gender
|
||||
and adds to guidelines to do so.
|
||||
(merge 46a237f42f ds/gender-neutral-doc later to maint).
|
||||
|
||||
* "git commit --allow-empty-message" won't abort the operation upon
|
||||
an empty message, but the hint shown in the editor said otherwise.
|
||||
(merge 6f70f00b4f hj/commit-allow-empty-message later to maint).
|
||||
|
||||
* The code that gives an error message in "git multi-pack-index" when
|
||||
no subcommand is given tried to print a NULL pointer as a strong,
|
||||
which has been corrected.
|
||||
(merge 88617d11f9 tb/reverse-midx later to maint).
|
||||
|
||||
* CI update.
|
||||
(merge a066a90db6 js/ci-check-whitespace-updates later to maint).
|
||||
|
||||
* Documentation fix for "git pull --rebase=no".
|
||||
(merge d3236becec fc/pull-no-rebase-merges-theirs-into-ours later to maint).
|
||||
|
||||
* A race between repacking and using pack bitmaps has been corrected.
|
||||
(merge dc1daacdcc jk/check-pack-valid-before-opening-bitmap later to maint).
|
||||
|
||||
* Other code cleanup, docfix, build fix, etc.
|
||||
(merge bfe35a6165 ah/doc-describe later to maint).
|
||||
(merge f302c1e4aa jc/clarify-revision-range later to maint).
|
||||
(merge 3127ff90ea tl/fix-packfile-uri-doc later to maint).
|
||||
(merge a84216c684 jk/doc-color-pager later to maint).
|
||||
(merge 4e0a64a713 ab/trace2-squelch-gcc-warning later to maint).
|
||||
(merge 225f7fa847 ps/rev-list-object-type-filter later to maint).
|
||||
(merge 5317dfeaed dd/honor-users-tar-in-tests later to maint).
|
||||
(merge ace6d8e3d6 tk/partial-clone-repack-doc later to maint).
|
||||
(merge 7ba68e0cf1 js/trace2-discard-event-docfix later to maint).
|
||||
(merge 8603c419d3 fc/doc-default-to-upstream-config later to maint).
|
||||
(merge 1d72b604ef jk/revision-squelch-gcc-warning later to maint).
|
||||
(merge abcb66c614 ar/typofix later to maint).
|
||||
(merge 9853830787 ah/graph-typofix later to maint).
|
||||
(merge aac578492d ab/config-hooks-path-testfix later to maint).
|
||||
(merge 98c7656a18 ar/more-typofix later to maint).
|
||||
(merge 6fb9195f6c jk/doc-max-pack-size later to maint).
|
||||
(merge 4184cbd635 ar/mailinfo-memcmp-to-skip-prefix later to maint).
|
||||
(merge 91d2347033 ar/doc-libera-chat-in-my-first-contrib later to maint).
|
||||
(merge 338abb0f04 ab/cmd-foo-should-return later to maint).
|
||||
(merge 546096a5cb ab/xdiff-bug-cleanup later to maint).
|
||||
(merge b7b793d1e7 ab/progress-cleanup later to maint).
|
||||
(merge d94f9b8e90 ba/object-info later to maint).
|
||||
(merge 52ff891c03 ar/test-code-cleanup later to maint).
|
||||
(merge a0538e5c8b dd/document-log-decorate-default later to maint).
|
||||
(merge ce24797d38 mr/cmake later to maint).
|
||||
(merge 9eb542f2ee ab/pre-auto-gc-hook-test later to maint).
|
||||
(merge 9fffc38583 bk/doc-commit-typofix later to maint).
|
||||
(merge 1cf823d8f0 ks/submodule-cleanup later to maint).
|
||||
(merge ebbf5d2b70 js/config-mak-windows-pcre-fix later to maint).
|
||||
(merge 617480d75b hn/refs-iterator-peel-returns-boolean later to maint).
|
||||
(merge 6a24cc71ed ar/submodule-helper-include-cleanup later to maint).
|
||||
(merge 5632e838f8 rs/khash-alloc-cleanup later to maint).
|
||||
(merge b1d87fbaf1 jk/typofix later to maint).
|
||||
(merge e04170697a ab/gitignore-discovery-doc later to maint).
|
||||
(merge 8232a0ff48 dl/packet-read-response-end-fix later to maint).
|
||||
(merge eb448631fb dl/diff-merge-base later to maint).
|
||||
(merge c510928a25 hn/refs-debug-empty-prefix later to maint).
|
||||
(merge ddcb189d9d tb/bitmap-type-filter-comment-fix later to maint).
|
||||
(merge 878b399734 pb/submodule-recurse-doc later to maint).
|
||||
(merge 734283855f jk/config-env-doc later to maint).
|
@ -377,7 +377,7 @@ notes for details).
|
||||
on that order.
|
||||
|
||||
* "git show 'HEAD:Foo[BAR]Baz'" did not interpret the argument as a
|
||||
rev, i.e. the object named by the pathname with wildcard
|
||||
rev, i.e. the object named by the the pathname with wildcard
|
||||
characters in a tree object.
|
||||
(merge aac4fac nd/dwim-wildcards-as-pathspecs later to maint).
|
||||
|
||||
|
@ -117,13 +117,10 @@ If in doubt which identifier to use, run `git log --no-merges` on the
|
||||
files you are modifying to see the current conventions.
|
||||
|
||||
[[summary-section]]
|
||||
The title sentence after the "area:" prefix omits the full stop at the
|
||||
end, and its first word is not capitalized unless there is a reason to
|
||||
capitalize it other than because it is the first word in the sentence.
|
||||
E.g. "doc: clarify...", not "doc: Clarify...", or "githooks.txt:
|
||||
improve...", not "githooks.txt: Improve...". But "refs: HEAD is also
|
||||
treated as a ref" is correct, as we spell `HEAD` in all caps even when
|
||||
it appears in the middle of a sentence.
|
||||
It's customary to start the remainder of the first line after "area: "
|
||||
with a lower-case letter. E.g. "doc: clarify...", not "doc:
|
||||
Clarify...", or "githooks.txt: improve...", not "githooks.txt:
|
||||
Improve...".
|
||||
|
||||
[[meaningful-message]]
|
||||
The body should provide a meaningful commit message, which:
|
||||
@ -373,8 +370,9 @@ If you like, you can put extra tags at the end:
|
||||
. `Acked-by:` says that the person who is more familiar with the area
|
||||
the patch attempts to modify liked the patch.
|
||||
. `Reviewed-by:`, unlike the other tags, can only be offered by the
|
||||
reviewers themselves when they are completely satisfied with the
|
||||
patch after a detailed analysis.
|
||||
reviewer and means that she is completely satisfied that the patch
|
||||
is ready for application. It is usually offered only after a
|
||||
detailed review.
|
||||
. `Tested-by:` is used to indicate that the person applied the patch
|
||||
and found it to have the desired effect.
|
||||
|
||||
|
@ -440,6 +440,8 @@ include::config/rerere.txt[]
|
||||
|
||||
include::config/reset.txt[]
|
||||
|
||||
include::config/safe.txt[]
|
||||
|
||||
include::config/sendemail.txt[]
|
||||
|
||||
include::config/sequencer.txt[]
|
||||
|
@ -119,8 +119,4 @@ advice.*::
|
||||
addEmptyPathspec::
|
||||
Advice shown if a user runs the add command without providing
|
||||
the pathspec parameter.
|
||||
updateSparsePath::
|
||||
Advice shown when either linkgit:git-add[1] or linkgit:git-rm[1]
|
||||
is asked to update index entries outside the current sparse
|
||||
checkout.
|
||||
--
|
||||
|
@ -27,7 +27,7 @@ blame.ignoreRevsFile::
|
||||
file names will reset the list of ignored revisions. This option will
|
||||
be handled before the command line option `--ignore-revs-file`.
|
||||
|
||||
blame.markUnblamableLines::
|
||||
blame.markUnblamables::
|
||||
Mark lines that were changed by an ignored revision that we could not
|
||||
attribute to another commit with a '*' in the output of
|
||||
linkgit:git-blame[1].
|
||||
|
@ -21,24 +21,3 @@ checkout.guess::
|
||||
Provides the default value for the `--guess` or `--no-guess`
|
||||
option in `git checkout` and `git switch`. See
|
||||
linkgit:git-switch[1] and linkgit:git-checkout[1].
|
||||
|
||||
checkout.workers::
|
||||
The number of parallel workers to use when updating the working tree.
|
||||
The default is one, i.e. sequential execution. If set to a value less
|
||||
than one, Git will use as many workers as the number of logical cores
|
||||
available. This setting and `checkout.thresholdForParallelism` affect
|
||||
all commands that perform checkout. E.g. checkout, clone, reset,
|
||||
sparse-checkout, etc.
|
||||
+
|
||||
Note: parallel checkout usually delivers better performance for repositories
|
||||
located on SSDs or over NFS. For repositories on spinning disks and/or machines
|
||||
with a small number of cores, the default sequential checkout often performs
|
||||
better. The size and compression level of a repository might also influence how
|
||||
well the parallel version performs.
|
||||
|
||||
checkout.thresholdForParallelism::
|
||||
When running parallel checkout with a small number of files, the cost
|
||||
of subprocess spawning and inter-process communication might outweigh
|
||||
the parallelization gains. This setting allows to define the minimum
|
||||
number of files for which parallel checkout should be attempted. The
|
||||
default is 100.
|
||||
|
@ -2,7 +2,3 @@ clone.defaultRemoteName::
|
||||
The name of the remote to create when cloning a repository. Defaults to
|
||||
`origin`, and can be overridden by passing the `--origin` command-line
|
||||
option to linkgit:git-clone[1].
|
||||
|
||||
clone.rejectShallow::
|
||||
Reject to clone a repository if it is a shallow one, can be overridden by
|
||||
passing option `--reject-shallow` in command line. See linkgit:git-clone[1]
|
||||
|
@ -127,9 +127,8 @@ color.interactive.<slot>::
|
||||
interactive commands.
|
||||
|
||||
color.pager::
|
||||
A boolean to specify whether `auto` color modes should colorize
|
||||
output going to the pager. Defaults to true; set this to false
|
||||
if your pager does not understand ANSI color codes.
|
||||
A boolean to enable/disable colored output when the pager is in
|
||||
use (default is true).
|
||||
|
||||
color.push::
|
||||
A boolean to enable/disable color in push errors. May be set to
|
||||
|
@ -1,9 +1,3 @@
|
||||
commitGraph.generationVersion::
|
||||
Specifies the type of generation number version to use when writing
|
||||
or reading the commit-graph file. If version 1 is specified, then
|
||||
the corrected commit dates will not be written or read. Defaults to
|
||||
2.
|
||||
|
||||
commitGraph.maxNewFilters::
|
||||
Specifies the default value for the `--max-new-filters` option of `git
|
||||
commit-graph write` (c.f., linkgit:git-commit-graph[1]).
|
||||
|
@ -118,10 +118,9 @@ diff.orderFile::
|
||||
relative to the top of the working tree.
|
||||
|
||||
diff.renameLimit::
|
||||
The number of files to consider in the exhaustive portion of
|
||||
copy/rename detection; equivalent to the 'git diff' option
|
||||
`-l`. If not set, the default value is currently 1000. This
|
||||
setting has no effect if rename detection is turned off.
|
||||
The number of files to consider when performing the copy/rename
|
||||
detection; equivalent to the 'git diff' option `-l`. This setting
|
||||
has no effect if rename detection is turned off.
|
||||
|
||||
diff.renames::
|
||||
Whether and how Git detects renames. If set to "false",
|
||||
|
@ -69,8 +69,7 @@ fetch.negotiationAlgorithm::
|
||||
setting defaults to "skipping".
|
||||
Unknown values will cause 'git fetch' to error out.
|
||||
+
|
||||
See also the `--negotiate-only` and `--negotiation-tip` options to
|
||||
linkgit:git-fetch[1].
|
||||
See also the `--negotiation-tip` option for linkgit:git-fetch[1].
|
||||
|
||||
fetch.showForcedUpdates::
|
||||
Set to false to enable `--no-show-forced-updates` in
|
||||
|
@ -14,11 +14,6 @@ index.recordOffsetTable::
|
||||
Defaults to 'true' if index.threads has been explicitly enabled,
|
||||
'false' otherwise.
|
||||
|
||||
index.sparse::
|
||||
When enabled, write the index using sparse-directory entries. This
|
||||
has no effect unless `core.sparseCheckout` and
|
||||
`core.sparseCheckoutCone` are both enabled. Defaults to 'false'.
|
||||
|
||||
index.threads::
|
||||
Specifies the number of threads to spawn when loading the index.
|
||||
This is meant to reduce index load time on multiprocessor machines.
|
||||
|
@ -24,11 +24,6 @@ log.excludeDecoration::
|
||||
the config option can be overridden by the `--decorate-refs`
|
||||
option.
|
||||
|
||||
log.diffMerges::
|
||||
Set default diff format to be used for merge commits. See
|
||||
`--diff-merges` in linkgit:git-log[1] for details.
|
||||
Defaults to `separate`.
|
||||
|
||||
log.follow::
|
||||
If `true`, `git log` will act as if the `--follow` option was used when
|
||||
a single <path> is given. This has the same limitations as `--follow`,
|
||||
|
@ -14,7 +14,7 @@ merge.defaultToUpstream::
|
||||
branches at the remote named by `branch.<current branch>.remote`
|
||||
are consulted, and then they are mapped via `remote.<remote>.fetch`
|
||||
to their corresponding remote-tracking branches, and the tips of
|
||||
these tracking branches are merged. Defaults to true.
|
||||
these tracking branches are merged.
|
||||
|
||||
merge.ff::
|
||||
By default, Git does not create an extra merge commit when merging
|
||||
@ -33,12 +33,10 @@ merge.verifySignatures::
|
||||
include::fmt-merge-msg.txt[]
|
||||
|
||||
merge.renameLimit::
|
||||
The number of files to consider in the exhaustive portion of
|
||||
rename detection during a merge. If not specified, defaults
|
||||
to the value of diff.renameLimit. If neither
|
||||
merge.renameLimit nor diff.renameLimit are specified,
|
||||
currently defaults to 7000. This setting has no effect if
|
||||
rename detection is turned off.
|
||||
The number of files to consider when performing rename detection
|
||||
during a merge; if not specified, defaults to the value of
|
||||
diff.renameLimit. This setting has no effect if rename detection
|
||||
is turned off.
|
||||
|
||||
merge.renames::
|
||||
Whether Git detects renames. If set to "false", rename detection
|
||||
|
@ -99,23 +99,12 @@ pack.packSizeLimit::
|
||||
packing to a file when repacking, i.e. the git:// protocol
|
||||
is unaffected. It can be overridden by the `--max-pack-size`
|
||||
option of linkgit:git-repack[1]. Reaching this limit results
|
||||
in the creation of multiple packfiles.
|
||||
+
|
||||
Note that this option is rarely useful, and may result in a larger total
|
||||
on-disk size (because Git will not store deltas between packs), as well
|
||||
as worse runtime performance (object lookup within multiple packs is
|
||||
slower than a single pack, and optimizations like reachability bitmaps
|
||||
cannot cope with multiple packs).
|
||||
+
|
||||
If you need to actively run Git using smaller packfiles (e.g., because your
|
||||
filesystem does not support large files), this option may help. But if
|
||||
your goal is to transmit a packfile over a medium that supports limited
|
||||
sizes (e.g., removable media that cannot store the whole repository),
|
||||
you are likely better off creating a single large packfile and splitting
|
||||
it using a generic multi-volume archive tool (e.g., Unix `split`).
|
||||
+
|
||||
The minimum size allowed is limited to 1 MiB. The default is unlimited.
|
||||
Common unit suffixes of 'k', 'm', or 'g' are supported.
|
||||
in the creation of multiple packfiles; which in turn prevents
|
||||
bitmaps from being created.
|
||||
The minimum size allowed is limited to 1 MiB.
|
||||
The default is unlimited.
|
||||
Common unit suffixes of 'k', 'm', or 'g' are
|
||||
supported.
|
||||
|
||||
pack.useBitmaps::
|
||||
When true, git will use pack bitmaps (if available) when packing
|
||||
@ -133,21 +122,6 @@ pack.useSparse::
|
||||
commits contain certain types of direct renames. Default is
|
||||
`true`.
|
||||
|
||||
pack.preferBitmapTips::
|
||||
When selecting which commits will receive bitmaps, prefer a
|
||||
commit at the tip of any reference that is a suffix of any value
|
||||
of this configuration over any other commits in the "selection
|
||||
window".
|
||||
+
|
||||
Note that setting this configuration to `refs/foo` does not mean that
|
||||
the commits at the tips of `refs/foo/bar` and `refs/foo/baz` will
|
||||
necessarily be selected. This is because commits are selected for
|
||||
bitmaps from within a series of windows of variable length.
|
||||
+
|
||||
If a commit at the tip of any reference which is a suffix of any value
|
||||
of this configuration is seen in a window, it is immediately given
|
||||
preference over any other commit in that window.
|
||||
|
||||
pack.writeBitmaps (deprecated)::
|
||||
This is a deprecated synonym for `repack.writeBitmaps`.
|
||||
|
||||
|
@ -24,14 +24,15 @@ push.default::
|
||||
|
||||
* `tracking` - This is a deprecated synonym for `upstream`.
|
||||
|
||||
* `simple` - pushes the current branch with the same name on the remote.
|
||||
* `simple` - in centralized workflow, work like `upstream` with an
|
||||
added safety to refuse to push if the upstream branch's name is
|
||||
different from the local one.
|
||||
+
|
||||
If you are working on a centralized workflow (pushing to the same repository you
|
||||
pull from, which is typically `origin`), then you need to configure an upstream
|
||||
branch with the same name.
|
||||
When pushing to a remote that is different from the remote you normally
|
||||
pull from, work as `current`. This is the safest option and is suited
|
||||
for beginners.
|
||||
+
|
||||
This mode is the default since Git 2.0, and is the safest option suited for
|
||||
beginners.
|
||||
This mode has become the default in Git 2.0.
|
||||
|
||||
* `matching` - push all branches having the same name on both ends.
|
||||
This makes the repository you are pushing to remember the set of
|
||||
@ -119,10 +120,3 @@ push.useForceIfIncludes::
|
||||
`--force-if-includes` as an option to linkgit:git-push[1]
|
||||
in the command line. Adding `--no-force-if-includes` at the
|
||||
time of push overrides this configuration setting.
|
||||
|
||||
push.negotiate::
|
||||
If set to "true", attempt to reduce the size of the packfile
|
||||
sent by rounds of negotiation in which the client and the
|
||||
server attempt to find commits in common. If "false", Git will
|
||||
rely solely on the server's ref advertisement to find commits
|
||||
in common.
|
||||
|
@ -1,3 +1,10 @@
|
||||
rebase.useBuiltin::
|
||||
Unused configuration variable. Used in Git versions 2.20 and
|
||||
2.21 as an escape hatch to enable the legacy shellscript
|
||||
implementation of rebase. Now the built-in rewrite of it in C
|
||||
is always used. Setting this will emit a warning, to alert any
|
||||
remaining users that setting this now does nothing.
|
||||
|
||||
rebase.backend::
|
||||
Default backend to use for rebasing. Possible choices are
|
||||
'apply' or 'merge'. In the future, if the merge backend gains
|
||||
|
28
Documentation/config/safe.txt
Normal file
28
Documentation/config/safe.txt
Normal file
@ -0,0 +1,28 @@
|
||||
safe.directory::
|
||||
These config entries specify Git-tracked directories that are
|
||||
considered safe even if they are owned by someone other than the
|
||||
current user. By default, Git will refuse to even parse a Git
|
||||
config of a repository owned by someone else, let alone run its
|
||||
hooks, and this config setting allows users to specify exceptions,
|
||||
e.g. for intentionally shared repositories (see the `--shared`
|
||||
option in linkgit:git-init[1]).
|
||||
+
|
||||
This is a multi-valued setting, i.e. you can add more than one directory
|
||||
via `git config --add`. To reset the list of safe directories (e.g. to
|
||||
override any such directories specified in the system config), add a
|
||||
`safe.directory` entry with an empty value.
|
||||
+
|
||||
This config setting is only respected when specified in a system or global
|
||||
config, not when it is specified in a repository config or via the command
|
||||
line option `-c safe.directory=<path>`.
|
||||
+
|
||||
The value of this setting is interpolated, i.e. `~/<path>` expands to a
|
||||
path relative to the home directory and `%(prefix)/<path>` expands to a
|
||||
path relative to Git's (runtime) prefix.
|
||||
+
|
||||
To completely opt-out of this security check, set `safe.directory` to the
|
||||
string `*`. This will allow all repositories to be treated as if their
|
||||
directory was listed in the `safe.directory` list. If `safe.directory=*`
|
||||
is set in system config and you want to re-enable this protection, then
|
||||
initialize your list with an empty value before listing the repositories
|
||||
that you deem safe.
|
@ -8,6 +8,9 @@ sendemail.smtpEncryption::
|
||||
See linkgit:git-send-email[1] for description. Note that this
|
||||
setting is not subject to the 'identity' mechanism.
|
||||
|
||||
sendemail.smtpssl (deprecated)::
|
||||
Deprecated alias for 'sendemail.smtpEncryption = ssl'.
|
||||
|
||||
sendemail.smtpsslcertpath::
|
||||
Path to ca-certificates (either a directory or a single file).
|
||||
Set it to an empty string to disable certificate verification.
|
||||
|
@ -5,11 +5,6 @@ stash.useBuiltin::
|
||||
is always used. Setting this will emit a warning, to alert any
|
||||
remaining users that setting this now does nothing.
|
||||
|
||||
stash.showIncludeUntracked::
|
||||
If this is set to true, the `git stash show` command will show
|
||||
the untracked files of a stash entry. Defaults to false. See
|
||||
description of 'show' command in linkgit:git-stash[1].
|
||||
|
||||
stash.showPatch::
|
||||
If this is set to true, the `git stash show` command without an
|
||||
option will show the stash entry in patch form. Defaults to false.
|
||||
|
@ -58,9 +58,8 @@ submodule.active::
|
||||
commands. See linkgit:gitsubmodules[7] for details.
|
||||
|
||||
submodule.recurse::
|
||||
A boolean indicating if commands should enable the `--recurse-submodules`
|
||||
option by default.
|
||||
Applies to all commands that support this option
|
||||
Specifies if commands recurse into submodules by default. This
|
||||
applies to all commands that have a `--recurse-submodules` option
|
||||
(`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
|
||||
`restore` and `switch`) except `clone` and `ls-files`.
|
||||
Defaults to false.
|
||||
|
@ -59,16 +59,15 @@ uploadpack.allowFilter::
|
||||
|
||||
uploadpackfilter.allow::
|
||||
Provides a default value for unspecified object filters (see: the
|
||||
below configuration variable). If set to `true`, this will also
|
||||
enable all filters which get added in the future.
|
||||
below configuration variable).
|
||||
Defaults to `true`.
|
||||
|
||||
uploadpackfilter.<filter>.allow::
|
||||
Explicitly allow or ban the object filter corresponding to
|
||||
`<filter>`, where `<filter>` may be one of: `blob:none`,
|
||||
`blob:limit`, `object:type`, `tree`, `sparse:oid`, or `combine`.
|
||||
If using combined filters, both `combine` and all of the nested
|
||||
filter kinds must be allowed. Defaults to `uploadpackfilter.allow`.
|
||||
`blob:limit`, `tree`, `sparse:oid`, or `combine`. If using
|
||||
combined filters, both `combine` and all of the nested filter
|
||||
kinds must be allowed. Defaults to `uploadpackfilter.allow`.
|
||||
|
||||
uploadpackfilter.tree.maxDepth::
|
||||
Only allow `--filter=tree:<n>` when `<n>` is no more than the value of
|
||||
|
@ -11,7 +11,7 @@ linkgit:git-diff-files[1]
|
||||
with the `-p` option produces patch text.
|
||||
You can customize the creation of patch text via the
|
||||
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables
|
||||
(see linkgit:git[1]), and the `diff` attribute (see linkgit:gitattributes[5]).
|
||||
(see linkgit:git[1]).
|
||||
|
||||
What the -p option produces is slightly different from the traditional
|
||||
diff format:
|
||||
@ -74,11 +74,6 @@ separate lines indicate the old and the new mode.
|
||||
rename from b
|
||||
rename to a
|
||||
|
||||
5. Hunk headers mention the name of the function to which the hunk
|
||||
applies. See "Defining a custom hunk-header" in
|
||||
linkgit:gitattributes[5] for details of how to tailor to this to
|
||||
specific languages.
|
||||
|
||||
|
||||
Combined diff format
|
||||
--------------------
|
||||
|
@ -34,7 +34,7 @@ endif::git-diff[]
|
||||
endif::git-format-patch[]
|
||||
|
||||
ifdef::git-log[]
|
||||
--diff-merges=(off|none|on|first-parent|1|separate|m|combined|c|dense-combined|cc)::
|
||||
--diff-merges=(off|none|first-parent|1|separate|m|combined|c|dense-combined|cc)::
|
||||
--no-diff-merges::
|
||||
Specify diff format to be used for merge commits. Default is
|
||||
{diff-merges-default} unless `--first-parent` is in use, in which case
|
||||
@ -45,24 +45,17 @@ ifdef::git-log[]
|
||||
Disable output of diffs for merge commits. Useful to override
|
||||
implied value.
|
||||
+
|
||||
--diff-merges=on:::
|
||||
--diff-merges=m:::
|
||||
-m:::
|
||||
This option makes diff output for merge commits to be shown in
|
||||
the default format. The default format could be changed using
|
||||
`log.diffMerges` configuration parameter, which default value
|
||||
is `separate`. `-m` implies `-p`.
|
||||
+
|
||||
--diff-merges=first-parent:::
|
||||
--diff-merges=1:::
|
||||
This option makes merge commits show the full diff with
|
||||
respect to the first parent only.
|
||||
+
|
||||
--diff-merges=separate:::
|
||||
--diff-merges=m:::
|
||||
-m:::
|
||||
This makes merge commits show the full diff with respect to
|
||||
each of the parents. Separate log entry and diff is generated
|
||||
for each parent. This is the format that `-m` produced
|
||||
historically.
|
||||
for each parent. `-m` doesn't produce any output without `-p`.
|
||||
+
|
||||
--diff-merges=combined:::
|
||||
--diff-merges=c:::
|
||||
@ -300,14 +293,11 @@ explained for the configuration variable `core.quotePath` (see
|
||||
linkgit:git-config[1]).
|
||||
|
||||
--name-only::
|
||||
Show only names of changed files. The file names are often encoded in UTF-8.
|
||||
For more information see the discussion about encoding in the linkgit:git-log[1]
|
||||
manual page.
|
||||
Show only names of changed files.
|
||||
|
||||
--name-status::
|
||||
Show only names and status of changed files. See the description
|
||||
of the `--diff-filter` option on what the status letters mean.
|
||||
Just like `--name-only` the file names are often encoded in UTF-8.
|
||||
|
||||
--submodule[=<format>]::
|
||||
Specify how differences in submodules are shown. When specifying
|
||||
@ -588,17 +578,11 @@ When used together with `-B`, omit also the preimage in the deletion part
|
||||
of a delete/create pair.
|
||||
|
||||
-l<num>::
|
||||
The `-M` and `-C` options involve some preliminary steps that
|
||||
can detect subsets of renames/copies cheaply, followed by an
|
||||
exhaustive fallback portion that compares all remaining
|
||||
unpaired destinations to all relevant sources. (For renames,
|
||||
only remaining unpaired sources are relevant; for copies, all
|
||||
original sources are relevant.) For N sources and
|
||||
destinations, this exhaustive check is O(N^2). This option
|
||||
prevents the exhaustive portion of rename/copy detection from
|
||||
running if the number of source/destination files involved
|
||||
exceeds the specified number. Defaults to diff.renameLimit.
|
||||
Note that a value of 0 is treated as unlimited.
|
||||
The `-M` and `-C` options require O(n^2) processing time where n
|
||||
is the number of potential rename/copy targets. This
|
||||
option prevents rename/copy detection from running if
|
||||
the number of rename/copy targets exceeds the specified
|
||||
number.
|
||||
|
||||
ifndef::git-format-patch[]
|
||||
--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
|
||||
|
@ -62,17 +62,8 @@ The argument to this option may be a glob on ref names, a ref, or the (possibly
|
||||
abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying
|
||||
this option multiple times, one for each matching ref name.
|
||||
+
|
||||
See also the `fetch.negotiationAlgorithm` and `push.negotiate`
|
||||
configuration variables documented in linkgit:git-config[1], and the
|
||||
`--negotiate-only` option below.
|
||||
|
||||
--negotiate-only::
|
||||
Do not fetch anything from the server, and instead print the
|
||||
ancestors of the provided `--negotiation-tip=*` arguments,
|
||||
which we have in common with the server.
|
||||
+
|
||||
Internally this is used to implement the `push.negotiate` option, see
|
||||
linkgit:git-config[1].
|
||||
See also the `fetch.negotiationAlgorithm` configuration variable
|
||||
documented in linkgit:git-config[1].
|
||||
|
||||
--dry-run::
|
||||
Show what would be done, without making any changes.
|
||||
@ -119,11 +110,6 @@ ifndef::git-pull[]
|
||||
setting `fetch.writeCommitGraph`.
|
||||
endif::git-pull[]
|
||||
|
||||
--prefetch::
|
||||
Modify the configured refspec to place all refs into the
|
||||
`refs/prefetch/` namespace. See the `prefetch` task in
|
||||
linkgit:git-maintenance[1].
|
||||
|
||||
-p::
|
||||
--prune::
|
||||
Before fetching, remove any remote-tracking references that no
|
||||
|
@ -15,7 +15,6 @@ SYNOPSIS
|
||||
[--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
|
||||
[--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
|
||||
[--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>]
|
||||
[--quoted-cr=<action>]
|
||||
[(<mbox> | <Maildir>)...]
|
||||
'git am' (--continue | --skip | --abort | --quit | --show-current-patch[=(diff|raw)])
|
||||
|
||||
@ -60,9 +59,6 @@ OPTIONS
|
||||
--no-scissors::
|
||||
Ignore scissors lines (see linkgit:git-mailinfo[1]).
|
||||
|
||||
--quoted-cr=<action>::
|
||||
This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]).
|
||||
|
||||
-m::
|
||||
--message-id::
|
||||
Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
|
||||
|
@ -84,13 +84,12 @@ OPTIONS
|
||||
|
||||
-3::
|
||||
--3way::
|
||||
Attempt 3-way merge if the patch records the identity of blobs it is supposed
|
||||
to apply to and we have those blobs available locally, possibly leaving the
|
||||
When the patch does not apply cleanly, fall back on 3-way merge if
|
||||
the patch records the identity of blobs it is supposed to apply to,
|
||||
and we have those blobs available locally, possibly leaving the
|
||||
conflict markers in the files in the working tree for the user to
|
||||
resolve. This option implies the `--index` option unless the
|
||||
`--cached` option is used, and is incompatible with the `--reject` option.
|
||||
When used with the `--cached` option, any conflicts are left at higher stages
|
||||
in the cache.
|
||||
resolve. This option implies the `--index` option, and is incompatible
|
||||
with the `--reject` and the `--cached` options.
|
||||
|
||||
--build-fake-ancestor=<file>::
|
||||
Newer 'git diff' output has embedded 'index information'
|
||||
|
@ -35,42 +35,42 @@ OPTIONS
|
||||
|
||||
-t::
|
||||
Instead of the content, show the object type identified by
|
||||
`<object>`.
|
||||
<object>.
|
||||
|
||||
-s::
|
||||
Instead of the content, show the object size identified by
|
||||
`<object>`.
|
||||
<object>.
|
||||
|
||||
-e::
|
||||
Exit with zero status if `<object>` exists and is a valid
|
||||
object. If `<object>` is of an invalid format exit with non-zero and
|
||||
Exit with zero status if <object> exists and is a valid
|
||||
object. If <object> is of an invalid format exit with non-zero and
|
||||
emits an error on stderr.
|
||||
|
||||
-p::
|
||||
Pretty-print the contents of `<object>` based on its type.
|
||||
Pretty-print the contents of <object> based on its type.
|
||||
|
||||
<type>::
|
||||
Typically this matches the real type of `<object>` but asking
|
||||
Typically this matches the real type of <object> but asking
|
||||
for a type that can trivially be dereferenced from the given
|
||||
`<object>` is also permitted. An example is to ask for a
|
||||
"tree" with `<object>` being a commit object that contains it,
|
||||
or to ask for a "blob" with `<object>` being a tag object that
|
||||
<object> is also permitted. An example is to ask for a
|
||||
"tree" with <object> being a commit object that contains it,
|
||||
or to ask for a "blob" with <object> being a tag object that
|
||||
points at it.
|
||||
|
||||
--textconv::
|
||||
Show the content as transformed by a textconv filter. In this case,
|
||||
`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in
|
||||
<object> has to be of the form <tree-ish>:<path>, or :<path> in
|
||||
order to apply the filter to the content recorded in the index at
|
||||
`<path>`.
|
||||
<path>.
|
||||
|
||||
--filters::
|
||||
Show the content as converted by the filters configured in
|
||||
the current working tree for the given `<path>` (i.e. smudge filters,
|
||||
end-of-line conversion, etc). In this case, `<object>` has to be of
|
||||
the form `<tree-ish>:<path>`, or `:<path>`.
|
||||
the current working tree for the given <path> (i.e. smudge filters,
|
||||
end-of-line conversion, etc). In this case, <object> has to be of
|
||||
the form <tree-ish>:<path>, or :<path>.
|
||||
|
||||
--path=<path>::
|
||||
For use with `--textconv` or `--filters`, to allow specifying an object
|
||||
For use with --textconv or --filters, to allow specifying an object
|
||||
name and a path separately, e.g. when it is difficult to figure out
|
||||
the revision from which the blob came.
|
||||
|
||||
@ -115,15 +115,15 @@ OPTIONS
|
||||
repository.
|
||||
|
||||
--allow-unknown-type::
|
||||
Allow `-s` or `-t` to query broken/corrupt objects of unknown type.
|
||||
Allow -s or -t to query broken/corrupt objects of unknown type.
|
||||
|
||||
--follow-symlinks::
|
||||
With `--batch` or `--batch-check`, follow symlinks inside the
|
||||
With --batch or --batch-check, follow symlinks inside the
|
||||
repository when requesting objects with extended SHA-1
|
||||
expressions of the form tree-ish:path-in-tree. Instead of
|
||||
providing output about the link itself, provide output about
|
||||
the linked-to object. If a symlink points outside the
|
||||
tree-ish (e.g. a link to `/foo` or a root-level link to `../foo`),
|
||||
tree-ish (e.g. a link to /foo or a root-level link to ../foo),
|
||||
the portion of the link which is outside the tree will be
|
||||
printed.
|
||||
+
|
||||
@ -175,15 +175,15 @@ respectively print:
|
||||
|
||||
OUTPUT
|
||||
------
|
||||
If `-t` is specified, one of the `<type>`.
|
||||
If `-t` is specified, one of the <type>.
|
||||
|
||||
If `-s` is specified, the size of the `<object>` in bytes.
|
||||
If `-s` is specified, the size of the <object> in bytes.
|
||||
|
||||
If `-e` is specified, no output, unless the `<object>` is malformed.
|
||||
If `-e` is specified, no output, unless the <object> is malformed.
|
||||
|
||||
If `-p` is specified, the contents of `<object>` are pretty-printed.
|
||||
If `-p` is specified, the contents of <object> are pretty-printed.
|
||||
|
||||
If `<type>` is specified, the raw (though uncompressed) contents of the `<object>`
|
||||
If <type> is specified, the raw (though uncompressed) contents of the <object>
|
||||
will be returned.
|
||||
|
||||
BATCH OUTPUT
|
||||
@ -200,7 +200,7 @@ object, with placeholders of the form `%(atom)` expanded, followed by a
|
||||
newline. The available atoms are:
|
||||
|
||||
`objectname`::
|
||||
The full hex representation of the object name.
|
||||
The 40-hex object name of the object.
|
||||
|
||||
`objecttype`::
|
||||
The type of the object (the same as `cat-file -t` reports).
|
||||
@ -215,9 +215,8 @@ newline. The available atoms are:
|
||||
|
||||
`deltabase`::
|
||||
If the object is stored as a delta on-disk, this expands to the
|
||||
full hex representation of the delta base object name.
|
||||
Otherwise, expands to the null OID (all zeroes). See `CAVEATS`
|
||||
below.
|
||||
40-hex sha1 of the delta base object. Otherwise, expands to the
|
||||
null sha1 (40 zeroes). See `CAVEATS` below.
|
||||
|
||||
`rest`::
|
||||
If this atom is used in the output string, input lines are split
|
||||
@ -236,14 +235,14 @@ newline.
|
||||
For example, `--batch` without a custom format would produce:
|
||||
|
||||
------------
|
||||
<oid> SP <type> SP <size> LF
|
||||
<sha1> SP <type> SP <size> LF
|
||||
<contents> LF
|
||||
------------
|
||||
|
||||
Whereas `--batch-check='%(objectname) %(objecttype)'` would produce:
|
||||
|
||||
------------
|
||||
<oid> SP <type> LF
|
||||
<sha1> SP <type> LF
|
||||
------------
|
||||
|
||||
If a name is specified on stdin that cannot be resolved to an object in
|
||||
@ -259,7 +258,7 @@ If a name is specified that might refer to more than one object (an ambiguous sh
|
||||
<object> SP ambiguous LF
|
||||
------------
|
||||
|
||||
If `--follow-symlinks` is used, and a symlink in the repository points
|
||||
If --follow-symlinks is used, and a symlink in the repository points
|
||||
outside the repository, then `cat-file` will ignore any custom format
|
||||
and print:
|
||||
|
||||
@ -268,11 +267,11 @@ symlink SP <size> LF
|
||||
<symlink> LF
|
||||
------------
|
||||
|
||||
The symlink will either be absolute (beginning with a `/`), or relative
|
||||
to the tree root. For instance, if dir/link points to `../../foo`, then
|
||||
`<symlink>` will be `../foo`. `<size>` is the size of the symlink in bytes.
|
||||
The symlink will either be absolute (beginning with a /), or relative
|
||||
to the tree root. For instance, if dir/link points to ../../foo, then
|
||||
<symlink> will be ../foo. <size> is the size of the symlink in bytes.
|
||||
|
||||
If `--follow-symlinks` is used, the following error messages will be
|
||||
If --follow-symlinks is used, the following error messages will be
|
||||
displayed:
|
||||
|
||||
------------
|
||||
|
@ -15,7 +15,7 @@ SYNOPSIS
|
||||
[--dissociate] [--separate-git-dir <git dir>]
|
||||
[--depth <depth>] [--[no-]single-branch] [--no-tags]
|
||||
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
|
||||
[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
|
||||
[--[no-]remote-submodules] [--jobs <n>] [--sparse]
|
||||
[--filter=<filter>] [--] <repository>
|
||||
[<directory>]
|
||||
|
||||
@ -149,11 +149,6 @@ objects from the source repository into a pack in the cloned repository.
|
||||
--no-checkout::
|
||||
No checkout of HEAD is performed after the clone is complete.
|
||||
|
||||
--[no-]reject-shallow::
|
||||
Fail if the source repository is a shallow repository.
|
||||
The 'clone.rejectShallow' configuration variable can be used to
|
||||
specify the default.
|
||||
|
||||
--bare::
|
||||
Make a 'bare' Git repository. That is, instead of
|
||||
creating `<directory>` and placing the administrative
|
||||
|
@ -9,13 +9,12 @@ SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
|
||||
[--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
|
||||
[--dry-run] [(-c | -C | --fixup | --squash) <commit>]
|
||||
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
|
||||
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
|
||||
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
|
||||
[-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
|
||||
[(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]
|
||||
[--] [<pathspec>...]
|
||||
[-S[<keyid>]] [--] [<pathspec>...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
@ -72,7 +71,7 @@ OPTIONS
|
||||
|
||||
-p::
|
||||
--patch::
|
||||
Use the interactive patch selection interface to choose
|
||||
Use the interactive patch selection interface to chose
|
||||
which changes to commit. See linkgit:git-add[1] for
|
||||
details.
|
||||
|
||||
@ -87,44 +86,11 @@ OPTIONS
|
||||
Like '-C', but with `-c` the editor is invoked, so that
|
||||
the user can further edit the commit message.
|
||||
|
||||
--fixup=[(amend|reword):]<commit>::
|
||||
Create a new commit which "fixes up" `<commit>` when applied with
|
||||
`git rebase --autosquash`. Plain `--fixup=<commit>` creates a
|
||||
"fixup!" commit which changes the content of `<commit>` but leaves
|
||||
its log message untouched. `--fixup=amend:<commit>` is similar but
|
||||
creates an "amend!" commit which also replaces the log message of
|
||||
`<commit>` with the log message of the "amend!" commit.
|
||||
`--fixup=reword:<commit>` creates an "amend!" commit which
|
||||
replaces the log message of `<commit>` with its own log message
|
||||
but makes no changes to the content of `<commit>`.
|
||||
+
|
||||
The commit created by plain `--fixup=<commit>` has a subject
|
||||
composed of "fixup!" followed by the subject line from <commit>,
|
||||
and is recognized specially by `git rebase --autosquash`. The `-m`
|
||||
option may be used to supplement the log message of the created
|
||||
commit, but the additional commentary will be thrown away once the
|
||||
"fixup!" commit is squashed into `<commit>` by
|
||||
`git rebase --autosquash`.
|
||||
+
|
||||
The commit created by `--fixup=amend:<commit>` is similar but its
|
||||
subject is instead prefixed with "amend!". The log message of
|
||||
<commit> is copied into the log message of the "amend!" commit and
|
||||
opened in an editor so it can be refined. When `git rebase
|
||||
--autosquash` squashes the "amend!" commit into `<commit>`, the
|
||||
log message of `<commit>` is replaced by the refined log message
|
||||
from the "amend!" commit. It is an error for the "amend!" commit's
|
||||
log message to be empty unless `--allow-empty-message` is
|
||||
specified.
|
||||
+
|
||||
`--fixup=reword:<commit>` is shorthand for `--fixup=amend:<commit>
|
||||
--only`. It creates an "amend!" commit with only a log message
|
||||
(ignoring any changes staged in the index). When squashed by `git
|
||||
rebase --autosquash`, it replaces the log message of `<commit>`
|
||||
without making any other changes.
|
||||
+
|
||||
Neither "fixup!" nor "amend!" commits change authorship of
|
||||
`<commit>` when applied by `git rebase --autosquash`.
|
||||
See linkgit:git-rebase[1] for details.
|
||||
--fixup=<commit>::
|
||||
Construct a commit message for use with `rebase --autosquash`.
|
||||
The commit message will be the subject line from the specified
|
||||
commit with a prefix of "fixup! ". See linkgit:git-rebase[1]
|
||||
for details.
|
||||
|
||||
--squash=<commit>::
|
||||
Construct a commit message for use with `rebase --autosquash`.
|
||||
@ -200,17 +166,6 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
|
||||
|
||||
include::signoff-option.txt[]
|
||||
|
||||
--trailer <token>[(=|:)<value>]::
|
||||
Specify a (<token>, <value>) pair that should be applied as a
|
||||
trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
|
||||
<committer@example.com>" --trailer "Helped-by:C O Mitter \
|
||||
<committer@example.com>"` will add the "Signed-off-by" trailer
|
||||
and the "Helped-by" trailer to the commit message.)
|
||||
The `trailer.*` configuration variables
|
||||
(linkgit:git-interpret-trailers[1]) can be used to define if
|
||||
a duplicated trailer is omitted, where in the run of trailers
|
||||
each trailer would appear, and other details.
|
||||
|
||||
-n::
|
||||
--no-verify::
|
||||
This option bypasses the pre-commit and commit-msg hooks.
|
||||
|
@ -71,7 +71,6 @@ codes are:
|
||||
|
||||
On success, the command returns the exit code 0.
|
||||
|
||||
[[OPTIONS]]
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
@ -144,13 +143,7 @@ See also <<FILES>>.
|
||||
|
||||
-f config-file::
|
||||
--file config-file::
|
||||
For writing options: write to the specified file rather than the
|
||||
repository `.git/config`.
|
||||
+
|
||||
For reading options: read only from the specified file rather than from all
|
||||
available files.
|
||||
+
|
||||
See also <<FILES>>.
|
||||
Use the given config file instead of the one specified by GIT_CONFIG.
|
||||
|
||||
--blob blob::
|
||||
Similar to `--file` but use the given blob instead of a file. E.g.
|
||||
@ -332,18 +325,20 @@ All writing options will per default write to the repository specific
|
||||
configuration file. Note that this also affects options like `--replace-all`
|
||||
and `--unset`. *'git config' will only ever change one file at a time*.
|
||||
|
||||
You can override these rules using the `--global`, `--system`,
|
||||
`--local`, `--worktree`, and `--file` command-line options; see
|
||||
<<OPTIONS>> above.
|
||||
You can override these rules either by command-line options or by environment
|
||||
variables. The `--global`, `--system` and `--worktree` options will limit
|
||||
the file used to the global, system-wide or per-worktree file respectively.
|
||||
The `GIT_CONFIG` environment variable has a similar effect, but you
|
||||
can specify any filename you want.
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
|
||||
GIT_CONFIG_GLOBAL::
|
||||
GIT_CONFIG_SYSTEM::
|
||||
Take the configuration from the given files instead from global or
|
||||
system-level configuration. See linkgit:git[1] for details.
|
||||
GIT_CONFIG::
|
||||
Take the configuration from the given file instead of .git/config.
|
||||
Using the "--global" option forces this to ~/.gitconfig. Using the
|
||||
"--system" option forces this to $(prefix)/etc/gitconfig.
|
||||
|
||||
GIT_CONFIG_NOSYSTEM::
|
||||
Whether to skip reading settings from the system-wide
|
||||
@ -367,12 +362,6 @@ This is useful for cases where you want to spawn multiple git commands
|
||||
with a common configuration but cannot depend on a configuration file,
|
||||
for example when writing scripts.
|
||||
|
||||
GIT_CONFIG::
|
||||
If no `--file` option is provided to `git config`, use the file
|
||||
given by `GIT_CONFIG` as if it were provided via `--file`. This
|
||||
variable has no effect on other Git commands, and is mostly for
|
||||
historical compatibility; there is generally no reason to use it
|
||||
instead of the `--file` option.
|
||||
|
||||
[[EXAMPLES]]
|
||||
EXAMPLES
|
||||
|
@ -159,7 +159,3 @@ empty string.
|
||||
+
|
||||
Components which are missing from the URL (e.g., there is no
|
||||
username in the example above) will be left unset.
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the linkgit:git[1] suite
|
||||
|
@ -24,18 +24,6 @@ Usage:
|
||||
[verse]
|
||||
'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
This application is a CVS emulation layer for Git.
|
||||
|
||||
It is highly functional. However, not all methods are implemented,
|
||||
and for those methods that are implemented,
|
||||
not all switches are implemented.
|
||||
|
||||
Testing has been done using both the CLI CVS client, and the Eclipse CVS
|
||||
plugin. Most functionality works fine with both of these clients.
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
@ -69,6 +57,18 @@ access still needs to be enabled by the `gitcvs.enabled` config option
|
||||
unless `--export-all` was given, too.
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
This application is a CVS emulation layer for Git.
|
||||
|
||||
It is highly functional. However, not all methods are implemented,
|
||||
and for those methods that are implemented,
|
||||
not all switches are implemented.
|
||||
|
||||
Testing has been done using both the CLI CVS client, and the Eclipse CVS
|
||||
plugin. Most functionality works fine with both of these clients.
|
||||
|
||||
LIMITATIONS
|
||||
-----------
|
||||
|
||||
|
@ -63,10 +63,9 @@ OPTIONS
|
||||
Automatically implies --tags.
|
||||
|
||||
--abbrev=<n>::
|
||||
Instead of using the default number of hexadecimal digits (which
|
||||
will vary according to the number of objects in the repository with
|
||||
a default of 7) of the abbreviated object name, use <n> digits, or
|
||||
as many digits as needed to form a unique object name. An <n> of 0
|
||||
Instead of using the default 7 hexadecimal digits as the
|
||||
abbreviated object name, use <n> digits, or as many digits
|
||||
as needed to form a unique object name. An <n> of 0
|
||||
will suppress long format, only showing the closest tag.
|
||||
|
||||
--candidates=<n>::
|
||||
@ -140,11 +139,8 @@ at the end.
|
||||
|
||||
The number of additional commits is the number
|
||||
of commits which would be displayed by "git log v1.0.4..parent".
|
||||
The hash suffix is "-g" + an unambigous abbreviation for the tip commit
|
||||
of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`). The
|
||||
length of the abbreviation scales as the repository grows, using the
|
||||
approximate number of objects in the repository and a bit of math
|
||||
around the birthday paradox, and defaults to a minimum of 7.
|
||||
The hash suffix is "-g" + unambiguous abbreviation for the tip commit
|
||||
of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).
|
||||
The "g" prefix stands for "git" and is used to allow describing the version of
|
||||
a software depending on the SCM the software is managed with. This is useful
|
||||
in an environment where people may use different SCMs.
|
||||
|
@ -51,20 +51,16 @@ files on disk.
|
||||
--staged is a synonym of --cached.
|
||||
+
|
||||
If --merge-base is given, instead of using <commit>, use the merge base
|
||||
of <commit> and HEAD. `git diff --cached --merge-base A` is equivalent to
|
||||
`git diff --cached $(git merge-base A HEAD)`.
|
||||
of <commit> and HEAD. `git diff --merge-base A` is equivalent to
|
||||
`git diff $(git merge-base A HEAD)`.
|
||||
|
||||
'git diff' [<options>] [--merge-base] <commit> [--] [<path>...]::
|
||||
'git diff' [<options>] <commit> [--] [<path>...]::
|
||||
|
||||
This form is to view the changes you have in your
|
||||
working tree relative to the named <commit>. You can
|
||||
use HEAD to compare it with the latest commit, or a
|
||||
branch name to compare with the tip of a different
|
||||
branch.
|
||||
+
|
||||
If --merge-base is given, instead of using <commit>, use the merge base
|
||||
of <commit> and HEAD. `git diff --merge-base A` is equivalent to
|
||||
`git diff $(git merge-base A HEAD)`.
|
||||
|
||||
'git diff' [<options>] [--merge-base] <commit> <commit> [--] [<path>...]::
|
||||
|
||||
|
@ -36,28 +36,11 @@ SYNOPSIS
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
Prepare each non-merge commit with its "patch" in
|
||||
one "message" per commit, formatted to resemble a UNIX mailbox.
|
||||
Prepare each commit with its patch in
|
||||
one file per commit, formatted to resemble UNIX mailbox format.
|
||||
The output of this command is convenient for e-mail submission or
|
||||
for use with 'git am'.
|
||||
|
||||
A "message" generated by the command consists of three parts:
|
||||
|
||||
* A brief metadata header that begins with `From <commit>`
|
||||
with a fixed `Mon Sep 17 00:00:00 2001` datestamp to help programs
|
||||
like "file(1)" to recognize that the file is an output from this
|
||||
command, fields that record the author identity, the author date,
|
||||
and the title of the change (taken from the first paragraph of the
|
||||
commit log message).
|
||||
|
||||
* The second and subsequent paragraphs of the commit log message.
|
||||
|
||||
* The "patch", which is the "diff -p --stat" output (see
|
||||
linkgit:git-diff[1]) between the commit and its parent.
|
||||
|
||||
The log message and the patch is separated by a line with a
|
||||
three-dash line.
|
||||
|
||||
There are two ways to specify which commits to operate on.
|
||||
|
||||
1. A single commit, <since>, specifies that the commits leading
|
||||
@ -238,11 +221,6 @@ populated with placeholder text.
|
||||
`--subject-prefix` option) has ` v<n>` appended to it. E.g.
|
||||
`--reroll-count=4` may produce `v4-0001-add-makefile.patch`
|
||||
file that has "Subject: [PATCH v4 1/20] Add makefile" in it.
|
||||
`<n>` does not have to be an integer (e.g. "--reroll-count=4.4",
|
||||
or "--reroll-count=4rev2" are allowed), but the downside of
|
||||
using such a reroll-count is that the range-diff/interdiff
|
||||
with the previous version does not state exactly which
|
||||
version the new interation is compared against.
|
||||
|
||||
--to=<email>::
|
||||
Add a `To:` header to the email headers. This is in addition
|
||||
@ -740,14 +718,6 @@ use it only when you know the recipient uses Git to apply your patch.
|
||||
$ git format-patch -3
|
||||
------------
|
||||
|
||||
CAVEATS
|
||||
-------
|
||||
|
||||
Note that `format-patch` will omit merge commits from the output, even
|
||||
if they are part of the requested range. A simple "patch" does not
|
||||
include enough information for the receiving end to reproduce the same
|
||||
merge commit.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
linkgit:git-am[1], linkgit:git-send-email[1]
|
||||
|
@ -38,6 +38,38 @@ are lists of one or more search expressions separated by newline
|
||||
characters. An empty string as search expression matches all lines.
|
||||
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
||||
grep.lineNumber::
|
||||
If set to true, enable `-n` option by default.
|
||||
|
||||
grep.column::
|
||||
If set to true, enable the `--column` option by default.
|
||||
|
||||
grep.patternType::
|
||||
Set the default matching behavior. Using a value of 'basic', 'extended',
|
||||
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
|
||||
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
|
||||
value 'default' will return to the default matching behavior.
|
||||
|
||||
grep.extendedRegexp::
|
||||
If set to true, enable `--extended-regexp` option by default. This
|
||||
option is ignored when the `grep.patternType` option is set to a value
|
||||
other than 'default'.
|
||||
|
||||
grep.threads::
|
||||
Number of grep worker threads to use. If unset (or set to 0), Git will
|
||||
use as many threads as the number of logical cores available.
|
||||
|
||||
grep.fullName::
|
||||
If set to true, enable `--full-name` option by default.
|
||||
|
||||
grep.fallbackToNoIndex::
|
||||
If set to true, fall back to git grep --no-index if git grep
|
||||
is executed outside of a git repository. Defaults to false.
|
||||
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
--cached::
|
||||
@ -331,38 +363,6 @@ with multiple threads might perform slower than single threaded if `--textconv`
|
||||
is given and there're too many text conversions. So if you experience low
|
||||
performance in this case, it might be desirable to use `--threads=1`.
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
||||
grep.lineNumber::
|
||||
If set to true, enable `-n` option by default.
|
||||
|
||||
grep.column::
|
||||
If set to true, enable the `--column` option by default.
|
||||
|
||||
grep.patternType::
|
||||
Set the default matching behavior. Using a value of 'basic', 'extended',
|
||||
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
|
||||
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
|
||||
value 'default' will return to the default matching behavior.
|
||||
|
||||
grep.extendedRegexp::
|
||||
If set to true, enable `--extended-regexp` option by default. This
|
||||
option is ignored when the `grep.patternType` option is set to a value
|
||||
other than 'default'.
|
||||
|
||||
grep.threads::
|
||||
Number of grep worker threads to use. If unset (or set to 0), Git will
|
||||
use as many threads as the number of logical cores available.
|
||||
|
||||
grep.fullName::
|
||||
If set to true, enable `--full-name` option by default.
|
||||
|
||||
grep.fallbackToNoIndex::
|
||||
If set to true, fall back to git grep --no-index if git grep
|
||||
is executed outside of a git repository. Defaults to false.
|
||||
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the linkgit:git[1] suite
|
||||
|
@ -232,38 +232,25 @@ trailer.<token>.ifmissing::
|
||||
that option for trailers with the specified <token>.
|
||||
|
||||
trailer.<token>.command::
|
||||
This option behaves in the same way as 'trailer.<token>.cmd', except
|
||||
that it doesn't pass anything as argument to the specified command.
|
||||
Instead the first occurrence of substring $ARG is replaced by the
|
||||
value that would be passed as argument.
|
||||
This option can be used to specify a shell command that will
|
||||
be called to automatically add or modify a trailer with the
|
||||
specified <token>.
|
||||
+
|
||||
The 'trailer.<token>.command' option has been deprecated in favor of
|
||||
'trailer.<token>.cmd' due to the fact that $ARG in the user's command is
|
||||
only replaced once and that the original way of replacing $ARG is not safe.
|
||||
When this option is specified, the behavior is as if a special
|
||||
'<token>=<value>' argument were added at the beginning of the command
|
||||
line, where <value> is taken to be the standard output of the
|
||||
specified command with any leading and trailing whitespace trimmed
|
||||
off.
|
||||
+
|
||||
When both 'trailer.<token>.cmd' and 'trailer.<token>.command' are given
|
||||
for the same <token>, 'trailer.<token>.cmd' is used and
|
||||
'trailer.<token>.command' is ignored.
|
||||
|
||||
trailer.<token>.cmd::
|
||||
This option can be used to specify a shell command that will be called:
|
||||
once to automatically add a trailer with the specified <token>, and then
|
||||
each time a '--trailer <token>=<value>' argument to modify the <value> of
|
||||
the trailer that this option would produce.
|
||||
If the command contains the `$ARG` string, this string will be
|
||||
replaced with the <value> part of an existing trailer with the same
|
||||
<token>, if any, before the command is launched.
|
||||
+
|
||||
When the specified command is first called to add a trailer
|
||||
with the specified <token>, the behavior is as if a special
|
||||
'--trailer <token>=<value>' argument was added at the beginning
|
||||
of the "git interpret-trailers" command, where <value>
|
||||
is taken to be the standard output of the command with any
|
||||
leading and trailing whitespace trimmed off.
|
||||
+
|
||||
If some '--trailer <token>=<value>' arguments are also passed
|
||||
on the command line, the command is called again once for each
|
||||
of these arguments with the same <token>. And the <value> part
|
||||
of these arguments, if any, will be passed to the command as its
|
||||
first argument. This way the command can produce a <value> computed
|
||||
from the <value> passed in the '--trailer <token>=<value>' argument.
|
||||
If some '<token>=<value>' arguments are also passed on the command
|
||||
line, when a 'trailer.<token>.command' is configured, the command will
|
||||
also be executed for each of these arguments. And the <value> part of
|
||||
these arguments, if any, will be used to replace the `$ARG` string in
|
||||
the command.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
@ -346,55 +333,6 @@ subject
|
||||
Fix #42
|
||||
------------
|
||||
|
||||
* Configure a 'help' trailer with a cmd use a script `glog-find-author`
|
||||
which search specified author identity from git log in git repository
|
||||
and show how it works:
|
||||
+
|
||||
------------
|
||||
$ cat ~/bin/glog-find-author
|
||||
#!/bin/sh
|
||||
test -n "$1" && git log --author="$1" --pretty="%an <%ae>" -1 || true
|
||||
$ git config trailer.help.key "Helped-by: "
|
||||
$ git config trailer.help.ifExists "addIfDifferentNeighbor"
|
||||
$ git config trailer.help.cmd "~/bin/glog-find-author"
|
||||
$ git interpret-trailers --trailer="help:Junio" --trailer="help:Couder" <<EOF
|
||||
> subject
|
||||
>
|
||||
> message
|
||||
>
|
||||
> EOF
|
||||
subject
|
||||
|
||||
message
|
||||
|
||||
Helped-by: Junio C Hamano <gitster@pobox.com>
|
||||
Helped-by: Christian Couder <christian.couder@gmail.com>
|
||||
------------
|
||||
|
||||
* Configure a 'ref' trailer with a cmd use a script `glog-grep`
|
||||
to grep last relevant commit from git log in the git repository
|
||||
and show how it works:
|
||||
+
|
||||
------------
|
||||
$ cat ~/bin/glog-grep
|
||||
#!/bin/sh
|
||||
test -n "$1" && git log --grep "$1" --pretty=reference -1 || true
|
||||
$ git config trailer.ref.key "Reference-to: "
|
||||
$ git config trailer.ref.ifExists "replace"
|
||||
$ git config trailer.ref.cmd "~/bin/glog-grep"
|
||||
$ git interpret-trailers --trailer="ref:Add copyright notices." <<EOF
|
||||
> subject
|
||||
>
|
||||
> message
|
||||
>
|
||||
> EOF
|
||||
subject
|
||||
|
||||
message
|
||||
|
||||
Reference-to: 8bc9a0c769 (Add copyright notices., 2005-04-07)
|
||||
------------
|
||||
|
||||
* Configure a 'see' trailer with a command to show the subject of a
|
||||
commit that is related, and show how it works:
|
||||
+
|
||||
|
@ -39,9 +39,7 @@ OPTIONS
|
||||
full ref name (including prefix) will be printed. If 'auto' is
|
||||
specified, then if the output is going to a terminal, the ref names
|
||||
are shown as if 'short' were given, otherwise no ref names are
|
||||
shown. The option `--decorate` is short-hand for `--decorate=short`.
|
||||
Default to configuration value of `log.decorate` if configured,
|
||||
otherwise, `auto`.
|
||||
shown. The default option is 'short'.
|
||||
|
||||
--decorate-refs=<pattern>::
|
||||
--decorate-refs-exclude=<pattern>::
|
||||
|
@ -9,9 +9,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
|
||||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n]
|
||||
[--[no-]scissors] [--quoted-cr=<action>]
|
||||
<msg> <patch>
|
||||
'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
@ -91,23 +89,6 @@ This can be enabled by default with the configuration option mailinfo.scissors.
|
||||
--no-scissors::
|
||||
Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
|
||||
|
||||
--quoted-cr=<action>::
|
||||
Action when processes email messages sent with base64 or
|
||||
quoted-printable encoding, and the decoded lines end with a CRLF
|
||||
instead of a simple LF.
|
||||
+
|
||||
The valid actions are:
|
||||
+
|
||||
--
|
||||
* `nowarn`: Git will do nothing when such a CRLF is found.
|
||||
* `warn`: Git will issue a warning for each message if such a CRLF is
|
||||
found.
|
||||
* `strip`: Git will convert those CRLF to LF.
|
||||
--
|
||||
+
|
||||
The default action could be set by configuration option `mailinfo.quotedCR`.
|
||||
If no such configuration option has been set, `warn` will be used.
|
||||
|
||||
<msg>::
|
||||
The commit log message extracted from e-mail, usually
|
||||
except the title line which comes from e-mail Subject.
|
||||
|
@ -92,8 +92,10 @@ commit-graph::
|
||||
prefetch::
|
||||
The `prefetch` task updates the object directory with the latest
|
||||
objects from all registered remotes. For each remote, a `git fetch`
|
||||
command is run. The configured refspec is modified to place all
|
||||
requested refs within `refs/prefetch/`. Also, tags are not updated.
|
||||
command is run. The refmap is custom to avoid updating local or remote
|
||||
branches (those in `refs/heads` or `refs/remotes`). Instead, the
|
||||
remote refs are stored in `refs/prefetch/<remote>/`. Also, tags are
|
||||
not updated.
|
||||
+
|
||||
This is done to avoid disrupting the remote-tracking branches. The end users
|
||||
expect these refs to stay unmoved unless they initiate a fetch. With prefetch
|
||||
|
@ -11,6 +11,14 @@ SYNOPSIS
|
||||
[verse]
|
||||
'git mktag'
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
--strict::
|
||||
By default mktag turns on the equivalent of
|
||||
linkgit:git-fsck[1] `--strict` mode. Use `--no-strict` to
|
||||
disable it.
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
@ -37,14 +45,6 @@ the appropriate `fsck.<msg-id>` varible:
|
||||
|
||||
git -c fsck.extraHeaderEntry=ignore mktag <my-tag-with-headers
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
--strict::
|
||||
By default mktag turns on the equivalent of
|
||||
linkgit:git-fsck[1] `--strict` mode. Use `--no-strict` to
|
||||
disable it.
|
||||
|
||||
Tag Format
|
||||
----------
|
||||
A tag signature file, to be fed to this command's standard input,
|
||||
|
@ -9,8 +9,7 @@ git-multi-pack-index - Write and verify multi-pack-indexes
|
||||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git multi-pack-index' [--object-dir=<dir>] [--[no-]progress]
|
||||
[--preferred-pack=<pack>] <subcommand>
|
||||
'git multi-pack-index' [--object-dir=<dir>] [--[no-]progress] <subcommand>
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
@ -31,16 +30,7 @@ OPTIONS
|
||||
The following subcommands are available:
|
||||
|
||||
write::
|
||||
Write a new MIDX file. The following options are available for
|
||||
the `write` sub-command:
|
||||
+
|
||||
--
|
||||
--preferred-pack=<pack>::
|
||||
Optionally specify the tie-breaking pack used when
|
||||
multiple packs contain the same object. If not given,
|
||||
ties are broken in favor of the pack with the lowest
|
||||
mtime.
|
||||
--
|
||||
Write a new MIDX file.
|
||||
|
||||
verify::
|
||||
Verify the contents of the MIDX file.
|
||||
|
@ -762,7 +762,3 @@ IMPLEMENTATION DETAILS
|
||||
message indicating the p4 depot location and change number. This
|
||||
line is used by later 'git p4 sync' operations to know which p4
|
||||
changes are new.
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the linkgit:git[1] suite
|
||||
|
@ -85,16 +85,6 @@ base-name::
|
||||
reference was included in the resulting packfile. This
|
||||
can be useful to send new tags to native Git clients.
|
||||
|
||||
--stdin-packs::
|
||||
Read the basenames of packfiles (e.g., `pack-1234abcd.pack`)
|
||||
from the standard input, instead of object names or revision
|
||||
arguments. The resulting pack contains all objects listed in the
|
||||
included packs (those not beginning with `^`), excluding any
|
||||
objects listed in the excluded packs (beginning with `^`).
|
||||
+
|
||||
Incompatible with `--revs`, or options that imply `--revs` (such as
|
||||
`--all`), with the exception of `--unpacked`, which is compatible.
|
||||
|
||||
--window=<n>::
|
||||
--depth=<n>::
|
||||
These two options affect how the objects contained in
|
||||
@ -128,10 +118,10 @@ depth is 4095.
|
||||
into multiple independent packfiles, each not larger than the
|
||||
given size. The size can be suffixed with
|
||||
"k", "m", or "g". The minimum size allowed is limited to 1 MiB.
|
||||
This option
|
||||
prevents the creation of a bitmap index.
|
||||
The default is unlimited, unless the config variable
|
||||
`pack.packSizeLimit` is set. Note that this option may result in
|
||||
a larger and slower repository; see the discussion in
|
||||
`pack.packSizeLimit`.
|
||||
`pack.packSizeLimit` is set.
|
||||
|
||||
--honor-pack-keep::
|
||||
This flag causes an object already in a local pack that
|
||||
|
@ -117,7 +117,7 @@ When set to `preserve` (deprecated in favor of `merges`), rebase with the
|
||||
`--preserve-merges` option passed to `git rebase` so that locally created
|
||||
merge commits will not be flattened.
|
||||
+
|
||||
When false, merge the upstream branch into the current branch.
|
||||
When false, merge the current branch into the upstream branch.
|
||||
+
|
||||
When `interactive`, enable the interactive mode of rebase.
|
||||
+
|
||||
|
@ -244,8 +244,8 @@ Imagine that you have to rebase what you have already published.
|
||||
You will have to bypass the "must fast-forward" rule in order to
|
||||
replace the history you originally published with the rebased history.
|
||||
If somebody else built on top of your original history while you are
|
||||
rebasing, the tip of the branch at the remote may advance with their
|
||||
commit, and blindly pushing with `--force` will lose their work.
|
||||
rebasing, the tip of the branch at the remote may advance with her
|
||||
commit, and blindly pushing with `--force` will lose her work.
|
||||
+
|
||||
This option allows you to say that you expect the history you are
|
||||
updating is what you rebased and want to replace. If the remote ref
|
||||
@ -600,7 +600,7 @@ EXAMPLES
|
||||
|
||||
`git push origin`::
|
||||
Without additional configuration, pushes the current branch to
|
||||
the configured upstream (`branch.<name>.merge` configuration
|
||||
the configured upstream (`remote.origin.merge` configuration
|
||||
variable) if it has the same name as the current branch, and
|
||||
errors out without pushing otherwise.
|
||||
+
|
||||
|
@ -200,6 +200,12 @@ Alternatively, you can undo the 'git rebase' with
|
||||
|
||||
git rebase --abort
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
||||
include::config/rebase.txt[]
|
||||
include::config/sequencer.txt[]
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
--onto <newbase>::
|
||||
@ -587,17 +593,16 @@ See also INCOMPATIBLE OPTIONS below.
|
||||
|
||||
--autosquash::
|
||||
--no-autosquash::
|
||||
When the commit log message begins with "squash! ..." or "fixup! ..."
|
||||
or "amend! ...", and there is already a commit in the todo list that
|
||||
matches the same `...`, automatically modify the todo list of
|
||||
`rebase -i`, so that the commit marked for squashing comes right after
|
||||
the commit to be modified, and change the action of the moved commit
|
||||
from `pick` to `squash` or `fixup` or `fixup -C` respectively. A commit
|
||||
matches the `...` if the commit subject matches, or if the `...` refers
|
||||
to the commit's hash. As a fall-back, partial matches of the commit
|
||||
subject work, too. The recommended way to create fixup/amend/squash
|
||||
commits is by using the `--fixup`, `--fixup=amend:` or `--fixup=reword:`
|
||||
and `--squash` options respectively of linkgit:git-commit[1].
|
||||
When the commit log message begins with "squash! ..." (or
|
||||
"fixup! ..."), and there is already a commit in the todo list that
|
||||
matches the same `...`, automatically modify the todo list of rebase
|
||||
-i so that the commit marked for squashing comes right after the
|
||||
commit to be modified, and change the action of the moved commit
|
||||
from `pick` to `squash` (or `fixup`). A commit matches the `...` if
|
||||
the commit subject matches, or if the `...` refers to the commit's
|
||||
hash. As a fall-back, partial matches of the commit subject work,
|
||||
too. The recommended way to create fixup/squash commits is by using
|
||||
the `--fixup`/`--squash` options of linkgit:git-commit[1].
|
||||
+
|
||||
If the `--autosquash` option is enabled by default using the
|
||||
configuration variable `rebase.autoSquash`, this option can be
|
||||
@ -617,14 +622,6 @@ See also INCOMPATIBLE OPTIONS below.
|
||||
--no-reschedule-failed-exec::
|
||||
Automatically reschedule `exec` commands that failed. This only makes
|
||||
sense in interactive mode (or when an `--exec` option was provided).
|
||||
+
|
||||
Even though this option applies once a rebase is started, it's set for
|
||||
the whole rebase at the start based on either the
|
||||
`rebase.rescheduleFailedExec` configuration (see linkgit:git-config[1]
|
||||
or "CONFIGURATION" below) or whether this option is
|
||||
provided. Otherwise an explicit `--no-reschedule-failed-exec` at the
|
||||
start would be overridden by the presence of
|
||||
`rebase.rescheduleFailedExec=true` configuration.
|
||||
|
||||
INCOMPATIBLE OPTIONS
|
||||
--------------------
|
||||
@ -890,17 +887,9 @@ If you want to fold two or more commits into one, replace the command
|
||||
"pick" for the second and subsequent commits with "squash" or "fixup".
|
||||
If the commits had different authors, the folded commit will be
|
||||
attributed to the author of the first commit. The suggested commit
|
||||
message for the folded commit is the concatenation of the first
|
||||
commit's message with those identified by "squash" commands, omitting the
|
||||
messages of commits identified by "fixup" commands, unless "fixup -c"
|
||||
is used. In that case the suggested commit message is only the message
|
||||
of the "fixup -c" commit, and an editor is opened allowing you to edit
|
||||
the message. The contents (patch) of the "fixup -c" commit are still
|
||||
incorporated into the folded commit. If there is more than one "fixup -c"
|
||||
commit, the message from the final one is used. You can also use
|
||||
"fixup -C" to get the same behavior as "fixup -c" except without opening
|
||||
an editor.
|
||||
|
||||
message for the folded commit is the concatenation of the commit
|
||||
messages of the first commit and of those with the "squash" command,
|
||||
but omits the commit messages of commits with the "fixup" command.
|
||||
|
||||
'git rebase' will stop when "pick" has been replaced with "edit" or
|
||||
when a command fails due to merge errors. When you are done editing
|
||||
@ -1268,12 +1257,6 @@ merge tlsv1.3
|
||||
merge cmake
|
||||
------------
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
||||
include::config/rebase.txt[]
|
||||
include::config/sequencer.txt[]
|
||||
|
||||
BUGS
|
||||
----
|
||||
The todo list presented by the deprecated `--preserve-merges --interactive`
|
||||
|
@ -121,9 +121,7 @@ depth is 4095.
|
||||
If specified, multiple packfiles may be created, which also
|
||||
prevents the creation of a bitmap index.
|
||||
The default is unlimited, unless the config variable
|
||||
`pack.packSizeLimit` is set. Note that this option may result in
|
||||
a larger and slower repository; see the discussion in
|
||||
`pack.packSizeLimit`.
|
||||
`pack.packSizeLimit` is set.
|
||||
|
||||
-b::
|
||||
--write-bitmap-index::
|
||||
@ -167,29 +165,6 @@ depth is 4095.
|
||||
Pass the `--delta-islands` option to `git-pack-objects`, see
|
||||
linkgit:git-pack-objects[1].
|
||||
|
||||
-g=<factor>::
|
||||
--geometric=<factor>::
|
||||
Arrange resulting pack structure so that each successive pack
|
||||
contains at least `<factor>` times the number of objects as the
|
||||
next-largest pack.
|
||||
+
|
||||
`git repack` ensures this by determining a "cut" of packfiles that need
|
||||
to be repacked into one in order to ensure a geometric progression. It
|
||||
picks the smallest set of packfiles such that as many of the larger
|
||||
packfiles (by count of objects contained in that pack) may be left
|
||||
intact.
|
||||
+
|
||||
Unlike other repack modes, the set of objects to pack is determined
|
||||
uniquely by the set of packs being "rolled-up"; in other words, the
|
||||
packs determined to need to be combined in order to restore a geometric
|
||||
progression.
|
||||
+
|
||||
When `--unpacked` is specified, loose objects are implicitly included in
|
||||
this "roll-up", without respect to their reachability. This is subject
|
||||
to change in the future. This option (implying a drastically different
|
||||
repack mode) is not guaranteed to work with all other combinations of
|
||||
option to `git repack`.
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
||||
|
@ -23,9 +23,7 @@ branch, and no updates to their contents can be staged in the index,
|
||||
though that default behavior can be overridden with the `-f` option.
|
||||
When `--cached` is given, the staged content has to
|
||||
match either the tip of the branch or the file on disk,
|
||||
allowing the file to be removed from just the index. When
|
||||
sparse-checkouts are in use (see linkgit:git-sparse-checkout[1]),
|
||||
`git rm` will only remove paths within the sparse-checkout patterns.
|
||||
allowing the file to be removed from just the index.
|
||||
|
||||
|
||||
OPTIONS
|
||||
|
@ -167,14 +167,6 @@ Sending
|
||||
`sendemail.envelopeSender` configuration variable; if that is
|
||||
unspecified, choosing the envelope sender is left to your MTA.
|
||||
|
||||
--sendmail-cmd=<command>::
|
||||
Specify a command to run to send the email. The command should
|
||||
be sendmail-like; specifically, it must support the `-i` option.
|
||||
The command will be executed in the shell if necessary. Default
|
||||
is the value of `sendemail.sendmailcmd`. If unspecified, and if
|
||||
--smtp-server is also unspecified, git-send-email will search
|
||||
for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
|
||||
|
||||
--smtp-encryption=<encryption>::
|
||||
Specify the encryption to use, either 'ssl' or 'tls'. Any other
|
||||
value reverts to plain SMTP. Default is the value of
|
||||
@ -219,16 +211,13 @@ a password is obtained using 'git-credential'.
|
||||
|
||||
--smtp-server=<host>::
|
||||
If set, specifies the outgoing SMTP server to use (e.g.
|
||||
`smtp.example.com` or a raw IP address). If unspecified, and if
|
||||
`--sendmail-cmd` is also unspecified, the default is to search
|
||||
for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH if such a
|
||||
program is available, falling back to `localhost` otherwise.
|
||||
+
|
||||
For backward compatibility, this option can also specify a full pathname
|
||||
of a sendmail-like program instead; the program must support the `-i`
|
||||
option. This method does not support passing arguments or using plain
|
||||
command names. For those use cases, consider using `--sendmail-cmd`
|
||||
instead.
|
||||
`smtp.example.com` or a raw IP address). Alternatively it can
|
||||
specify a full pathname of a sendmail-like program instead;
|
||||
the program must support the `-i` option. Default value can
|
||||
be specified by the `sendemail.smtpServer` configuration
|
||||
option; the built-in default is to search for `sendmail` in
|
||||
`/usr/sbin`, `/usr/lib` and $PATH if such program is
|
||||
available, falling back to `localhost` otherwise.
|
||||
|
||||
--smtp-server-port=<port>::
|
||||
Specifies a port different from the default port (SMTP
|
||||
|
@ -45,20 +45,6 @@ To avoid interfering with other worktrees, it first enables the
|
||||
When `--cone` is provided, the `core.sparseCheckoutCone` setting is
|
||||
also set, allowing for better performance with a limited set of
|
||||
patterns (see 'CONE PATTERN SET' below).
|
||||
+
|
||||
Use the `--[no-]sparse-index` option to toggle the use of the sparse
|
||||
index format. This reduces the size of the index to be more closely
|
||||
aligned with your sparse-checkout definition. This can have significant
|
||||
performance advantages for commands such as `git status` or `git add`.
|
||||
This feature is still experimental. Some commands might be slower with
|
||||
a sparse index until they are properly integrated with the feature.
|
||||
+
|
||||
**WARNING:** Using a sparse index requires modifying the index in a way
|
||||
that is not completely understood by external tools. If you have trouble
|
||||
with this compatibility, then run `git sparse-checkout init --no-sparse-index`
|
||||
to rewrite your index to not be sparse. Older versions of Git will not
|
||||
understand the sparse directory entries index extension and may fail to
|
||||
interact with your repository until it is disabled.
|
||||
|
||||
'set'::
|
||||
Write a set of patterns to the sparse-checkout file, as given as
|
||||
|
@ -9,7 +9,7 @@ SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git stash' list [<log-options>]
|
||||
'git stash' show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]
|
||||
'git stash' show [<diff-options>] [<stash>]
|
||||
'git stash' drop [-q|--quiet] [<stash>]
|
||||
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
|
||||
'git stash' branch <branchname> [<stash>]
|
||||
@ -83,7 +83,7 @@ stash@{1}: On master: 9cc0589... Add git-stash
|
||||
The command takes options applicable to the 'git log'
|
||||
command to control what is shown and how. See linkgit:git-log[1].
|
||||
|
||||
show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]::
|
||||
show [<diff-options>] [<stash>]::
|
||||
|
||||
Show the changes recorded in the stash entry as a diff between the
|
||||
stashed contents and the commit back when the stash entry was first
|
||||
@ -91,10 +91,8 @@ show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]::
|
||||
By default, the command shows the diffstat, but it will accept any
|
||||
format known to 'git diff' (e.g., `git stash show -p stash@{1}`
|
||||
to view the second most recent entry in patch form).
|
||||
If no `<diff-option>` is provided, the default behavior will be given
|
||||
by the `stash.showStat`, and `stash.showPatch` config variables. You
|
||||
can also use `stash.showIncludeUntracked` to set whether
|
||||
`--include-untracked` is enabled by default.
|
||||
You can use stash.showStat and/or stash.showPatch config variables
|
||||
to change the default behavior.
|
||||
|
||||
pop [--index] [-q|--quiet] [<stash>]::
|
||||
|
||||
@ -162,18 +160,10 @@ up with `git clean`.
|
||||
|
||||
-u::
|
||||
--include-untracked::
|
||||
--no-include-untracked::
|
||||
When used with the `push` and `save` commands,
|
||||
all untracked files are also stashed and then cleaned up with
|
||||
`git clean`.
|
||||
This option is only valid for `push` and `save` commands.
|
||||
+
|
||||
When used with the `show` command, show the untracked files in the stash
|
||||
entry as part of the diff.
|
||||
|
||||
--only-untracked::
|
||||
This option is only valid for the `show` command.
|
||||
+
|
||||
Show only the untracked files in the stash entry as part of the diff.
|
||||
All untracked files are also stashed and then cleaned up with
|
||||
`git clean`.
|
||||
|
||||
--index::
|
||||
This option is only valid for `pop` and `apply` commands.
|
||||
|
@ -1061,6 +1061,25 @@ with different name spaces. For example:
|
||||
branches = stable/*:refs/remotes/svn/stable/*
|
||||
branches = debug/*:refs/remotes/svn/debug/*
|
||||
|
||||
BUGS
|
||||
----
|
||||
|
||||
We ignore all SVN properties except svn:executable. Any unhandled
|
||||
properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
|
||||
|
||||
Renamed and copied directories are not detected by Git and hence not
|
||||
tracked when committing to SVN. I do not plan on adding support for
|
||||
this as it's quite difficult and time-consuming to get working for all
|
||||
the possible corner cases (Git doesn't do it, either). Committing
|
||||
renamed and copied files is fully supported if they're similar enough
|
||||
for Git to detect them.
|
||||
|
||||
In SVN, it is possible (though discouraged) to commit changes to a tag
|
||||
(because a tag is just a directory copy, thus technically the same as a
|
||||
branch). When cloning an SVN repository, 'git svn' cannot know if such a
|
||||
commit to a tag will happen in the future. Thus it acts conservatively
|
||||
and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
|
||||
@ -1147,25 +1166,6 @@ $GIT_DIR/svn/\**/.rev_map.*::
|
||||
if it is missing or not up to date. 'git svn reset' automatically
|
||||
rewinds it.
|
||||
|
||||
BUGS
|
||||
----
|
||||
|
||||
We ignore all SVN properties except svn:executable. Any unhandled
|
||||
properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
|
||||
|
||||
Renamed and copied directories are not detected by Git and hence not
|
||||
tracked when committing to SVN. I do not plan on adding support for
|
||||
this as it's quite difficult and time-consuming to get working for all
|
||||
the possible corner cases (Git doesn't do it, either). Committing
|
||||
renamed and copied files is fully supported if they're similar enough
|
||||
for Git to detect them.
|
||||
|
||||
In SVN, it is possible (though discouraged) to commit changes to a tag
|
||||
(because a tag is just a directory copy, thus technically the same as a
|
||||
branch). When cloning an SVN repository, 'git svn' cannot know if such a
|
||||
commit to a tag will happen in the future. Thus it acts conservatively
|
||||
and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
linkgit:git-rebase[1]
|
||||
|
@ -9,7 +9,7 @@ git-worktree - Manage multiple working trees
|
||||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]] [-b <new-branch>] <path> [<commit-ish>]
|
||||
'git worktree add' [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
|
||||
'git worktree list' [--porcelain]
|
||||
'git worktree lock' [--reason <string>] <worktree>
|
||||
'git worktree move' <worktree> <new-path>
|
||||
@ -242,7 +242,7 @@ With `list`, annotate missing working trees as prunable if they are
|
||||
older than `<time>`.
|
||||
|
||||
--reason <string>::
|
||||
With `lock` or with `add --lock`, an explanation why the working tree is locked.
|
||||
With `lock`, an explanation why the working tree is locked.
|
||||
|
||||
<worktree>::
|
||||
Working trees can be identified by path, either relative or
|
||||
@ -387,7 +387,7 @@ These annotations are:
|
||||
------------
|
||||
$ git worktree list
|
||||
/path/to/linked-worktree abcd1234 [master]
|
||||
/path/to/locked-worktree acbd5678 (brancha) locked
|
||||
/path/to/locked-worktreee acbd5678 (brancha) locked
|
||||
/path/to/prunable-worktree 5678abc (detached HEAD) prunable
|
||||
------------
|
||||
|
||||
|
@ -13,7 +13,7 @@ SYNOPSIS
|
||||
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
|
||||
[-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
|
||||
[--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
|
||||
[--super-prefix=<path>] [--config-env=<name>=<envvar>]
|
||||
[--super-prefix=<path>] [--config-env <name>=<envvar>]
|
||||
<command> [<args>]
|
||||
|
||||
DESCRIPTION
|
||||
@ -670,16 +670,6 @@ for further details.
|
||||
If this environment variable is set to `0`, git will not prompt
|
||||
on the terminal (e.g., when asking for HTTP authentication).
|
||||
|
||||
`GIT_CONFIG_GLOBAL`::
|
||||
`GIT_CONFIG_SYSTEM`::
|
||||
Take the configuration from the given files instead from global or
|
||||
system-level configuration files. If `GIT_CONFIG_SYSTEM` is set, the
|
||||
system config file defined at build time (usually `/etc/gitconfig`)
|
||||
will not be read. Likewise, if `GIT_CONFIG_GLOBAL` is set, neither
|
||||
`$HOME/.gitconfig` nor `$XDG_CONFIG_HOME/git/config` will be read. Can
|
||||
be set to `/dev/null` to skip reading configuration files of the
|
||||
respective level.
|
||||
|
||||
`GIT_CONFIG_NOSYSTEM`::
|
||||
Whether to skip reading settings from the system-wide
|
||||
`$(prefix)/etc/gitconfig` file. This environment variable can
|
||||
|
@ -845,8 +845,6 @@ patterns are available:
|
||||
|
||||
- `rust` suitable for source code in the Rust language.
|
||||
|
||||
- `scheme` suitable for source code in the Scheme language.
|
||||
|
||||
- `tex` suitable for source code for LaTeX documents.
|
||||
|
||||
|
||||
@ -1176,8 +1174,7 @@ tag then no replacement will be done. The placeholders are the same
|
||||
as those for the option `--pretty=format:` of linkgit:git-log[1],
|
||||
except that they need to be wrapped like this: `$Format:PLACEHOLDERS$`
|
||||
in the file. E.g. the string `$Format:%H$` will be replaced by the
|
||||
commit hash. However, only one `%(describe)` placeholder is expanded
|
||||
per archive to avoid denial-of-service attacks.
|
||||
commit hash.
|
||||
|
||||
|
||||
Packing objects
|
||||
@ -1247,12 +1244,6 @@ to:
|
||||
[attr]binary -diff -merge -text
|
||||
------------
|
||||
|
||||
NOTES
|
||||
-----
|
||||
|
||||
Git does not follow symbolic links when accessing a `.gitattributes`
|
||||
file in the working tree. This keeps behavior consistent when the file
|
||||
is accessed from the index or a tree versus from the filesystem.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
@ -187,7 +187,7 @@ mark a file pair as a rename and stop considering other candidates for
|
||||
better matches. At most, one comparison is done per file in this
|
||||
preliminary pass; so if there are several remaining ext.txt files
|
||||
throughout the directory hierarchy after exact rename detection, this
|
||||
preliminary step may be skipped for those files.
|
||||
preliminary step will be skipped for those files.
|
||||
|
||||
Note. When the "-C" option is used with `--find-copies-harder`
|
||||
option, 'git diff-{asterisk}' commands feed unmodified filepairs to
|
||||
|
@ -138,7 +138,7 @@ given); `template` (if a `-t` option was given or the
|
||||
configuration option `commit.template` is set); `merge` (if the
|
||||
commit is a merge or a `.git/MERGE_MSG` file exists); `squash`
|
||||
(if a `.git/SQUASH_MSG` file exists); or `commit`, followed by
|
||||
a commit object name (if a `-c`, `-C` or `--amend` option was given).
|
||||
a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).
|
||||
|
||||
If the exit status is non-zero, `git commit` will abort.
|
||||
|
||||
@ -231,19 +231,19 @@ named remote is not being used both values will be the same.
|
||||
Information about what is to be pushed is provided on the hook's standard
|
||||
input with lines of the form:
|
||||
|
||||
<local ref> SP <local object name> SP <remote ref> SP <remote object name> LF
|
||||
<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
|
||||
|
||||
For instance, if the command +git push origin master:foreign+ were run the
|
||||
hook would receive a line like the following:
|
||||
|
||||
refs/heads/master 67890 refs/heads/foreign 12345
|
||||
|
||||
although the full object name would be supplied. If the foreign ref does not
|
||||
yet exist the `<remote object name>` will be the all-zeroes object name. If a
|
||||
ref is to be deleted, the `<local ref>` will be supplied as `(delete)` and the
|
||||
`<local object name>` will be the all-zeroes object name. If the local commit
|
||||
was specified by something other than a name which could be expanded (such as
|
||||
`HEAD~`, or an object name) it will be supplied as it was originally given.
|
||||
although the full, 40-character SHA-1s would be supplied. If the foreign ref
|
||||
does not yet exist the `<remote SHA-1>` will be 40 `0`. If a ref is to be
|
||||
deleted, the `<local ref>` will be supplied as `(delete)` and the `<local
|
||||
SHA-1>` will be 40 `0`. If the local commit was specified by something other
|
||||
than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be
|
||||
supplied as it was originally given.
|
||||
|
||||
If this hook exits with a non-zero status, `git push` will abort without
|
||||
pushing anything. Information about why the push is rejected may be sent
|
||||
@ -268,7 +268,7 @@ input a line of the format:
|
||||
where `<old-value>` is the old object name stored in the ref,
|
||||
`<new-value>` is the new object name to be stored in the ref and
|
||||
`<ref-name>` is the full name of the ref.
|
||||
When creating a new ref, `<old-value>` is the all-zeroes object name.
|
||||
When creating a new ref, `<old-value>` is 40 `0`.
|
||||
|
||||
If the hook exits with non-zero status, none of the refs will be
|
||||
updated. If the hook exits with zero, updating of individual refs can
|
||||
@ -473,8 +473,7 @@ reference-transaction
|
||||
|
||||
This hook is invoked by any Git command that performs reference
|
||||
updates. It executes whenever a reference transaction is prepared,
|
||||
committed or aborted and may thus get called multiple times. The hook
|
||||
does not cover symbolic references (but that may change in the future).
|
||||
committed or aborted and may thus get called multiple times.
|
||||
|
||||
The hook takes exactly one argument, which is the current state the
|
||||
given reference transaction is in:
|
||||
@ -493,14 +492,6 @@ receives on standard input a line of the format:
|
||||
|
||||
<old-value> SP <new-value> SP <ref-name> LF
|
||||
|
||||
where `<old-value>` is the old object name passed into the reference
|
||||
transaction, `<new-value>` is the new object name to be stored in the
|
||||
ref and `<ref-name>` is the full name of the ref. When force updating
|
||||
the reference regardless of its current value or when the reference is
|
||||
to be created anew, `<old-value>` is the all-zeroes object name. To
|
||||
distinguish these cases, you can inspect the current value of
|
||||
`<ref-name>` via `git rev-parse`.
|
||||
|
||||
The exit status of the hook is ignored for any state except for the
|
||||
"prepared" state. In the "prepared" state, a non-zero exit status will
|
||||
cause the transaction to be aborted. The hook will not be called with
|
||||
@ -559,7 +550,7 @@ command-dependent arguments may be passed in the future.
|
||||
The hook receives a list of the rewritten commits on stdin, in the
|
||||
format
|
||||
|
||||
<old-object-name> SP <new-object-name> [ SP <extra-info> ] LF
|
||||
<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
|
||||
|
||||
The 'extra-info' is again command-dependent. If it is empty, the
|
||||
preceding SP is also omitted. Currently, no commands pass any
|
||||
@ -575,7 +566,7 @@ rebase::
|
||||
For the 'squash' and 'fixup' operation, all commits that were
|
||||
squashed are listed as being rewritten to the squashed commit.
|
||||
This means that there will be several lines sharing the same
|
||||
'new-object-name'.
|
||||
'new-sha1'.
|
||||
+
|
||||
The commits are guaranteed to be listed in the order that they were
|
||||
processed by rebase.
|
||||
|
@ -27,11 +27,12 @@ precedence, the last matching pattern decides the outcome):
|
||||
them.
|
||||
|
||||
* Patterns read from a `.gitignore` file in the same directory
|
||||
as the path, or in any parent directory (up to the top-level of the working
|
||||
tree), with patterns in the higher level files being overridden by those in
|
||||
lower level files down to the directory containing the file. These patterns
|
||||
match relative to the location of the `.gitignore` file. A project normally
|
||||
includes such `.gitignore` files in its repository, containing patterns for
|
||||
as the path, or in any parent directory, with patterns in the
|
||||
higher level files (up to the toplevel of the work tree) being overridden
|
||||
by those in lower level files down to the directory containing the file.
|
||||
These patterns match relative to the location of the
|
||||
`.gitignore` file. A project normally includes such
|
||||
`.gitignore` files in its repository, containing patterns for
|
||||
files generated as part of the project build.
|
||||
|
||||
* Patterns read from `$GIT_DIR/info/exclude`.
|
||||
@ -148,15 +149,11 @@ not tracked by Git remain untracked.
|
||||
To stop tracking a file that is currently tracked, use
|
||||
'git rm --cached'.
|
||||
|
||||
Git does not follow symbolic links when accessing a `.gitignore` file in
|
||||
the working tree. This keeps behavior consistent when the file is
|
||||
accessed from the index or a tree versus from the filesystem.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
- The pattern `hello.*` matches any file or folder
|
||||
whose name begins with `hello.`. If one wants to restrict
|
||||
whose name begins with `hello`. If one wants to restrict
|
||||
this only to the directory and not in its subdirectories,
|
||||
one can prepend the pattern with a slash, i.e. `/hello.*`;
|
||||
the pattern now matches `hello.txt`, `hello.c` but not
|
||||
|
@ -55,13 +55,6 @@ this would also match the 'Commit Name <commit@email.xx>' above:
|
||||
Proper Name <proper@email.xx> CoMmIt NaMe <CoMmIt@EmAiL.xX>
|
||||
--
|
||||
|
||||
NOTES
|
||||
-----
|
||||
|
||||
Git does not follow symbolic links when accessing a `.mailmap` file in
|
||||
the working tree. This keeps behavior consistent when the file is
|
||||
accessed from the index or a tree versus from the filesystem.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
|
@ -98,14 +98,6 @@ submodule.<name>.shallow::
|
||||
shallow clone (with a history depth of 1) unless the user explicitly
|
||||
asks for a non-shallow clone.
|
||||
|
||||
NOTES
|
||||
-----
|
||||
|
||||
Git does not allow the `.gitmodules` file within a working tree to be a
|
||||
symbolic link, and will refuse to check out such a tree entry. This
|
||||
keeps behavior consistent when the file is accessed from the index or a
|
||||
tree versus from the filesystem, and helps Git reliably enforce security
|
||||
checks of the file contents.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
@ -62,7 +62,3 @@ git clone ext::'git --namespace=foo %s /tmp/prefixed.git'
|
||||
----------
|
||||
|
||||
include::transfer-data-leaks.txt[]
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the linkgit:git[1] suite
|
||||
|
@ -751,17 +751,6 @@ default font sizes or lineheights are changed (e.g. via adding extra
|
||||
CSS stylesheet in `@stylesheets`), it may be appropriate to change
|
||||
these values.
|
||||
|
||||
email-privacy::
|
||||
Redact e-mail addresses from the generated HTML, etc. content.
|
||||
This obscures e-mail addresses retrieved from the author/committer
|
||||
and comment sections of the Git log.
|
||||
It is meant to hinder web crawlers that harvest and abuse addresses.
|
||||
Such crawlers may not respect robots.txt.
|
||||
Note that users and user tools also see the addresses as redacted.
|
||||
If Gitweb is not the final step in a workflow then subsequent steps
|
||||
may misbehave because of the redacted information they receive.
|
||||
Disabled by default.
|
||||
|
||||
highlight::
|
||||
Server-side syntax highlight support in "blob" view. It requires
|
||||
`$highlight_bin` program to be available (see the description of
|
||||
|
@ -146,8 +146,8 @@ current branch integrates with) obviously do not work, as there is no
|
||||
<<def_revision,revision>> and you are "merging" another
|
||||
<<def_branch,branch>>'s changes that happen to be a descendant of what
|
||||
you have. In such a case, you do not make a new <<def_merge,merge>>
|
||||
<<def_commit,commit>> but instead just update your branch to point at the same
|
||||
revision as the branch you are merging. This will happen frequently on a
|
||||
<<def_commit,commit>> but instead just update to his
|
||||
revision. This will happen frequently on a
|
||||
<<def_remote_tracking_branch,remote-tracking branch>> of a remote
|
||||
<<def_repository,repository>>.
|
||||
|
||||
|
@ -1,131 +0,0 @@
|
||||
Content-type: text/asciidoc
|
||||
Abstract: When a critical vulnerability is discovered and fixed, we follow this
|
||||
script to coordinate a public release.
|
||||
|
||||
How we coordinate embargoed releases
|
||||
====================================
|
||||
|
||||
To protect Git users from critical vulnerabilities, we do not just release
|
||||
fixed versions like regular maintenance releases. Instead, we coordinate
|
||||
releases with packagers, keeping the fixes under an embargo until the release
|
||||
date. That way, users will have a chance to upgrade on that date, no matter
|
||||
what Operating System or distribution they run.
|
||||
|
||||
Open a Security Advisory draft
|
||||
------------------------------
|
||||
|
||||
The first step is to https://github.com/git/git/security/advisories/new[open an
|
||||
advisory]. Technically, it is not necessary, but it is convenient and saves a
|
||||
bit of hassle. This advisory can also be used to obtain the CVE number and it
|
||||
will give us a private fork associated with it that can be used to collaborate
|
||||
on a fix.
|
||||
|
||||
Release date of the embargoed version
|
||||
-------------------------------------
|
||||
|
||||
If the vulnerability affects Windows users, we want to have our friends over at
|
||||
Visual Studio on board. This means we need to target a "Patch Tuesday" (i.e. a
|
||||
second Tuesday of the month), at the minimum three weeks from heads-up to
|
||||
coordinated release.
|
||||
|
||||
If the vulnerability affects the server side, or can benefit from scans on the
|
||||
server side (i.e. if `git fsck` can detect an attack), it is important to give
|
||||
all involved Git repository hosting sites enough time to scan all of those
|
||||
repositories.
|
||||
|
||||
Notifying the Linux distributions
|
||||
---------------------------------
|
||||
|
||||
At most two weeks before release date, we need to send a notification to
|
||||
distros@vs.openwall.org, preferably less than 7 days before the release date.
|
||||
This will reach most (all?) Linux distributions. See an example below, and the
|
||||
guidelines for this mailing list at
|
||||
https://oss-security.openwall.org/wiki/mailing-lists/distros#how-to-use-the-lists[here].
|
||||
|
||||
Once the version has been published, we send a note about that to oss-security.
|
||||
As an example, see https://www.openwall.com/lists/oss-security/2019/12/13/1[the
|
||||
v2.24.1 mail];
|
||||
https://oss-security.openwall.org/wiki/mailing-lists/oss-security[Here] are
|
||||
their guidelines.
|
||||
|
||||
The mail to oss-security should also describe the exploit, and give credit to
|
||||
the reporter(s): security researchers still receive too little respect for the
|
||||
invaluable service they provide, and public credit goes a long way to keep them
|
||||
paid by their respective organizations.
|
||||
|
||||
Technically, describing any exploit can be delayed up to 7 days, but we usually
|
||||
refrain from doing that, including it right away.
|
||||
|
||||
As a courtesy we typically attach a Git bundle (as `.tar.xz` because the list
|
||||
will drop `.bundle` attachments) in the mail to distros@ so that the involved
|
||||
parties can take care of integrating/backporting them. This bundle is typically
|
||||
created using a command like this:
|
||||
|
||||
git bundle create cve-xxx.bundle ^origin/master vA.B.C vD.E.F
|
||||
tar cJvf cve-xxx.bundle.tar.xz cve-xxx.bundle
|
||||
|
||||
Example mail to distros@vs.openwall.org
|
||||
---------------------------------------
|
||||
|
||||
....
|
||||
To: distros@vs.openwall.org
|
||||
Cc: git-security@googlegroups.com, <other people involved in the report/fix>
|
||||
Subject: [vs] Upcoming Git security fix release
|
||||
|
||||
Team,
|
||||
|
||||
The Git project will release new versions on <date> at 10am Pacific Time or
|
||||
soon thereafter. I have attached a Git bundle (embedded in a `.tar.xz` to avoid
|
||||
it being dropped) which you can fetch into a clone of
|
||||
https://github.com/git/git via `git fetch --tags /path/to/cve-xxx.bundle`,
|
||||
containing the tags for versions <versions>.
|
||||
|
||||
You can verify with `git tag -v <tag>` that the versions were signed by
|
||||
the Git maintainer, using the same GPG key as e.g. v2.24.0.
|
||||
|
||||
Please use these tags to prepare `git` packages for your various
|
||||
distributions, using the appropriate tagged versions. The added test cases
|
||||
help verify the correctness.
|
||||
|
||||
The addressed issues are:
|
||||
|
||||
<list of CVEs with a short description, typically copy/pasted from Git's
|
||||
release notes, usually demo exploit(s), too>
|
||||
|
||||
Credit for finding the vulnerability goes to <reporter>, credit for fixing
|
||||
it goes to <developer>.
|
||||
|
||||
Thanks,
|
||||
<name>
|
||||
|
||||
....
|
||||
|
||||
Example mail to oss-security@lists.openwall.com
|
||||
-----------------------------------------------
|
||||
|
||||
....
|
||||
To: oss-security@lists.openwall.com
|
||||
Cc: git-security@googlegroups.com, <other people involved in the report/fix>
|
||||
Subject: git: <copy from security advisory>
|
||||
|
||||
Team,
|
||||
|
||||
The Git project released new versions on <date>, addressing <CVE>.
|
||||
|
||||
All supported platforms are affected in one way or another, and all Git
|
||||
versions all the way back to <version> are affected. The fixed versions are:
|
||||
<versions>.
|
||||
|
||||
Link to the announcement: <link to lore.kernel.org/git>
|
||||
|
||||
We highly recommend to upgrade.
|
||||
|
||||
The addressed issues are:
|
||||
* <list of CVEs and their explanations, along with demo exploits>
|
||||
|
||||
Credit for finding the vulnerability goes to <reporter>, credit for fixing
|
||||
it goes to <developer>.
|
||||
|
||||
Thanks,
|
||||
<name>
|
||||
....
|
@ -1,67 +1,71 @@
|
||||
#!/usr/bin/perl
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
use File::Find;
|
||||
use Getopt::Long;
|
||||
|
||||
# Parse arguments, a simple state machine for input like:
|
||||
#
|
||||
# howto/*.txt config/*.txt --section=1 git.txt git-add.txt [...] --to-lint git-add.txt a-file.txt [...]
|
||||
my %TXT;
|
||||
my %SECTION;
|
||||
my $section;
|
||||
my $lint_these = 0;
|
||||
for my $arg (@ARGV) {
|
||||
if (my ($sec) = $arg =~ /^--section=(\d+)$/s) {
|
||||
$section = $sec;
|
||||
next;
|
||||
}
|
||||
my $basedir = ".";
|
||||
GetOptions("basedir=s" => \$basedir)
|
||||
or die("Cannot parse command line arguments\n");
|
||||
|
||||
my ($name) = $arg =~ /^(.*?)\.txt$/s;
|
||||
unless (defined $section) {
|
||||
$TXT{$name} = $arg;
|
||||
next;
|
||||
}
|
||||
my $found_errors = 0;
|
||||
|
||||
$SECTION{$name} = $section;
|
||||
}
|
||||
|
||||
my $exit_code = 0;
|
||||
sub report {
|
||||
my ($pos, $line, $target, $msg) = @_;
|
||||
substr($line, $pos) = "' <-- HERE";
|
||||
$line =~ s/^\s+//;
|
||||
print "$ARGV:$.: error: $target: $msg, shown with 'HERE' below:\n";
|
||||
print "$ARGV:$.:\t'$line\n";
|
||||
$exit_code = 1;
|
||||
my ($where, $what, $error) = @_;
|
||||
print "$where: $error: $what\n";
|
||||
$found_errors = 1;
|
||||
}
|
||||
|
||||
@ARGV = sort values %TXT;
|
||||
die "BUG: Nothing to process!" unless @ARGV;
|
||||
while (<>) {
|
||||
my $line = $_;
|
||||
while ($line =~ m/linkgit:((.*?)\[(\d)\])/g) {
|
||||
my $pos = pos $line;
|
||||
my ($target, $page, $section) = ($1, $2, $3);
|
||||
sub grab_section {
|
||||
my ($page) = @_;
|
||||
open my $fh, "<", "$basedir/$page.txt";
|
||||
my $firstline = <$fh>;
|
||||
chomp $firstline;
|
||||
close $fh;
|
||||
my ($section) = ($firstline =~ /.*\((\d)\)$/);
|
||||
return $section;
|
||||
}
|
||||
|
||||
# De-AsciiDoc
|
||||
$page =~ s/{litdd}/--/g;
|
||||
sub lint {
|
||||
my ($file) = @_;
|
||||
open my $fh, "<", $file
|
||||
or return;
|
||||
while (<$fh>) {
|
||||
my $where = "$file:$.";
|
||||
while (s/linkgit:((.*?)\[(\d)\])//) {
|
||||
my ($target, $page, $section) = ($1, $2, $3);
|
||||
|
||||
if (!exists $TXT{$page}) {
|
||||
report($pos, $line, $target, "link outside of our own docs");
|
||||
next;
|
||||
}
|
||||
if (!exists $SECTION{$page}) {
|
||||
report($pos, $line, $target, "link outside of our sectioned docs");
|
||||
next;
|
||||
}
|
||||
my $real_section = $SECTION{$page};
|
||||
if ($section != $SECTION{$page}) {
|
||||
report($pos, $line, $target, "wrong section (should be $real_section)");
|
||||
next;
|
||||
# De-AsciiDoc
|
||||
$page =~ s/{litdd}/--/g;
|
||||
|
||||
if ($page !~ /^git/) {
|
||||
report($where, $target, "nongit link");
|
||||
next;
|
||||
}
|
||||
if (! -f "$basedir/$page.txt") {
|
||||
report($where, $target, "no such source");
|
||||
next;
|
||||
}
|
||||
$real_section = grab_section($page);
|
||||
if ($real_section != $section) {
|
||||
report($where, $target,
|
||||
"wrong section (should be $real_section)");
|
||||
next;
|
||||
}
|
||||
}
|
||||
}
|
||||
# this resets our $. for each file
|
||||
close ARGV if eof;
|
||||
close $fh;
|
||||
}
|
||||
|
||||
exit $exit_code;
|
||||
sub lint_it {
|
||||
lint($File::Find::name) if -f && /\.txt$/;
|
||||
}
|
||||
|
||||
if (!@ARGV) {
|
||||
find({ wanted => \&lint_it, no_chdir => 1 }, $basedir);
|
||||
} else {
|
||||
for (@ARGV) {
|
||||
lint($_);
|
||||
}
|
||||
}
|
||||
|
||||
exit $found_errors;
|
||||
|
@ -1,24 +0,0 @@
|
||||
#!/usr/bin/perl
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
my $exit_code = 0;
|
||||
sub report {
|
||||
my ($target, $msg) = @_;
|
||||
print "error: $target: $msg\n";
|
||||
$exit_code = 1;
|
||||
}
|
||||
|
||||
local $/;
|
||||
while (my $slurp = <>) {
|
||||
report($ARGV, "has no 'Part of the linkgit:git[1] suite' end blurb")
|
||||
unless $slurp =~ m[
|
||||
^GIT\n
|
||||
---\n
|
||||
\QPart of the linkgit:git[1] suite\E \n
|
||||
\z
|
||||
]mx;
|
||||
}
|
||||
|
||||
exit $exit_code;
|
@ -1,105 +0,0 @@
|
||||
#!/usr/bin/perl
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
my %SECTIONS;
|
||||
{
|
||||
my $order = 0;
|
||||
%SECTIONS = (
|
||||
'NAME' => {
|
||||
required => 1,
|
||||
order => $order++,
|
||||
},
|
||||
'SYNOPSIS' => {
|
||||
required => 1,
|
||||
order => $order++,
|
||||
},
|
||||
'DESCRIPTION' => {
|
||||
required => 1,
|
||||
order => $order++,
|
||||
},
|
||||
'OPTIONS' => {
|
||||
order => $order++,
|
||||
required => 0,
|
||||
},
|
||||
'CONFIGURATION' => {
|
||||
order => $order++,
|
||||
},
|
||||
'BUGS' => {
|
||||
order => $order++,
|
||||
},
|
||||
'SEE ALSO' => {
|
||||
order => $order++,
|
||||
},
|
||||
'GIT' => {
|
||||
required => 1,
|
||||
order => $order++,
|
||||
},
|
||||
);
|
||||
}
|
||||
my $SECTION_RX = do {
|
||||
my ($names) = join "|", keys %SECTIONS;
|
||||
qr/^($names)$/s;
|
||||
};
|
||||
|
||||
my $exit_code = 0;
|
||||
sub report {
|
||||
my ($msg) = @_;
|
||||
print "$ARGV:$.: $msg\n";
|
||||
$exit_code = 1;
|
||||
}
|
||||
|
||||
my $last_was_section;
|
||||
my @actual_order;
|
||||
while (my $line = <>) {
|
||||
chomp $line;
|
||||
if ($line =~ $SECTION_RX) {
|
||||
push @actual_order => $line;
|
||||
$last_was_section = 1;
|
||||
# Have no "last" section yet, processing NAME
|
||||
next if @actual_order == 1;
|
||||
|
||||
my @expected_order = sort {
|
||||
$SECTIONS{$a}->{order} <=> $SECTIONS{$b}->{order}
|
||||
} @actual_order;
|
||||
|
||||
my $expected_last = $expected_order[-2];
|
||||
my $actual_last = $actual_order[-2];
|
||||
if ($actual_last ne $expected_last) {
|
||||
report("section '$line' incorrectly ordered, comes after '$actual_last'");
|
||||
}
|
||||
next;
|
||||
}
|
||||
if ($last_was_section) {
|
||||
my $last_section = $actual_order[-1];
|
||||
if (length $last_section ne length $line) {
|
||||
report("dashes under '$last_section' should match its length!");
|
||||
}
|
||||
if ($line !~ /^-+$/) {
|
||||
report("dashes under '$last_section' should be '-' dashes!");
|
||||
}
|
||||
$last_was_section = 0;
|
||||
}
|
||||
|
||||
if (eof) {
|
||||
# We have both a hash and an array to consider, for
|
||||
# convenience
|
||||
my %actual_sections;
|
||||
@actual_sections{@actual_order} = ();
|
||||
|
||||
for my $section (sort keys %SECTIONS) {
|
||||
next if !$SECTIONS{$section}->{required} or exists $actual_sections{$section};
|
||||
report("has no required '$section' section!");
|
||||
}
|
||||
|
||||
# Reset per-file state
|
||||
{
|
||||
@actual_order = ();
|
||||
# this resets our $. for each file
|
||||
close ARGV;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
exit $exit_code;
|
@ -190,8 +190,6 @@ The placeholders are:
|
||||
'%ai':: author date, ISO 8601-like format
|
||||
'%aI':: author date, strict ISO 8601 format
|
||||
'%as':: author date, short format (`YYYY-MM-DD`)
|
||||
'%ah':: author date, human style (like the `--date=human` option of
|
||||
linkgit:git-rev-list[1])
|
||||
'%cn':: committer name
|
||||
'%cN':: committer name (respecting .mailmap, see
|
||||
linkgit:git-shortlog[1] or linkgit:git-blame[1])
|
||||
@ -208,23 +206,8 @@ The placeholders are:
|
||||
'%ci':: committer date, ISO 8601-like format
|
||||
'%cI':: committer date, strict ISO 8601 format
|
||||
'%cs':: committer date, short format (`YYYY-MM-DD`)
|
||||
'%ch':: committer date, human style (like the `--date=human` option of
|
||||
linkgit:git-rev-list[1])
|
||||
'%d':: ref names, like the --decorate option of linkgit:git-log[1]
|
||||
'%D':: ref names without the " (", ")" wrapping.
|
||||
'%(describe[:options])':: human-readable name, like
|
||||
linkgit:git-describe[1]; empty string for
|
||||
undescribable commits. The `describe` string
|
||||
may be followed by a colon and zero or more
|
||||
comma-separated options. Descriptions can be
|
||||
inconsistent when tags are added or removed at
|
||||
the same time.
|
||||
+
|
||||
** 'match=<pattern>': Only consider tags matching the given
|
||||
`glob(7)` pattern, excluding the "refs/tags/" prefix.
|
||||
** 'exclude=<pattern>': Do not consider tags matching the given
|
||||
`glob(7)` pattern, excluding the "refs/tags/" prefix.
|
||||
|
||||
'%S':: ref name given on the command line by which the commit was reached
|
||||
(like `git log --source`), only works with `git log`
|
||||
'%e':: encoding
|
||||
@ -271,7 +254,7 @@ endif::git-rev-list[]
|
||||
`trailers` string may be followed by a colon
|
||||
and zero or more comma-separated options.
|
||||
If any option is provided multiple times the
|
||||
last occurrence wins.
|
||||
last occurance wins.
|
||||
+
|
||||
The boolean options accept an optional value `[=<BOOL>]`. The values
|
||||
`true`, `false`, `on`, `off` etc. are all accepted. See the "boolean"
|
||||
|
@ -892,12 +892,9 @@ or units. n may be zero. The suffixes k, m, and g can be used to name
|
||||
units in KiB, MiB, or GiB. For example, 'blob:limit=1k' is the same
|
||||
as 'blob:limit=1024'.
|
||||
+
|
||||
The form '--filter=object:type=(tag|commit|tree|blob)' omits all objects
|
||||
which are not of the requested type.
|
||||
+
|
||||
The form '--filter=sparse:oid=<blob-ish>' uses a sparse-checkout
|
||||
specification contained in the blob (or blob-expression) '<blob-ish>'
|
||||
to omit blobs that would not be required for a sparse checkout on
|
||||
to omit blobs that would not be not required for a sparse checkout on
|
||||
the requested refs.
|
||||
+
|
||||
The form '--filter=tree:<depth>' omits all blobs and trees whose depth
|
||||
@ -933,11 +930,6 @@ equivalent.
|
||||
--no-filter::
|
||||
Turn off any previous `--filter=` argument.
|
||||
|
||||
--filter-provided-objects::
|
||||
Filter the list of explicitly provided objects, which would otherwise
|
||||
always be printed even if they did not match any of the filters. Only
|
||||
useful with `--filter=`.
|
||||
|
||||
--filter-print-omitted::
|
||||
Only useful with `--filter=`; prints a list of the objects omitted
|
||||
by the filter. Object IDs are prefixed with a ``~'' character.
|
||||
@ -1064,14 +1056,6 @@ ifdef::git-rev-list[]
|
||||
--header::
|
||||
Print the contents of the commit in raw-format; each record is
|
||||
separated with a NUL character.
|
||||
|
||||
--no-commit-header::
|
||||
Suppress the header line containing "commit" and the object ID printed before
|
||||
the specified format. This has no effect on the built-in formats; only custom
|
||||
formats are affected.
|
||||
|
||||
--commit-header::
|
||||
Overrides a previous `--no-commit-header`.
|
||||
endif::git-rev-list[]
|
||||
|
||||
--parents::
|
||||
|
@ -260,9 +260,6 @@ any of the given commits.
|
||||
A commit's reachable set is the commit itself and the commits in
|
||||
its ancestry chain.
|
||||
|
||||
There are several notations to specify a set of connected commits
|
||||
(called a "revision range"), illustrated below.
|
||||
|
||||
|
||||
Commit Exclusions
|
||||
~~~~~~~~~~~~~~~~~
|
||||
@ -297,26 +294,6 @@ is a shorthand for 'HEAD..origin' and asks "What did the origin do since
|
||||
I forked from them?" Note that '..' would mean 'HEAD..HEAD' which is an
|
||||
empty range that is both reachable and unreachable from HEAD.
|
||||
|
||||
Commands that are specifically designed to take two distinct ranges
|
||||
(e.g. "git range-diff R1 R2" to compare two ranges) do exist, but
|
||||
they are exceptions. Unless otherwise noted, all "git" commands
|
||||
that operate on a set of commits work on a single revision range.
|
||||
In other words, writing two "two-dot range notation" next to each
|
||||
other, e.g.
|
||||
|
||||
$ git log A..B C..D
|
||||
|
||||
does *not* specify two revision ranges for most commands. Instead
|
||||
it will name a single connected set of commits, i.e. those that are
|
||||
reachable from either B or D but are reachable from neither A or C.
|
||||
In a linear history like this:
|
||||
|
||||
---A---B---o---o---C---D
|
||||
|
||||
because A and B are reachable from C, the revision range specified
|
||||
by these two dotted ranges is a single commit D.
|
||||
|
||||
|
||||
Other <rev>{caret} Parent Shorthand Notations
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Three other shorthands exist, particularly useful for merge commits,
|
||||
|
@ -1,11 +1,8 @@
|
||||
Error reporting in git
|
||||
======================
|
||||
|
||||
`BUG`, `die`, `usage`, `error`, and `warning` report errors of
|
||||
various kinds.
|
||||
|
||||
- `BUG` is for failed internal assertions that should never happen,
|
||||
i.e. a bug in git itself.
|
||||
`die`, `usage`, `error`, and `warning` report errors of various
|
||||
kinds.
|
||||
|
||||
- `die` is for fatal application errors. It prints a message to
|
||||
the user and exits with status 128.
|
||||
@ -23,9 +20,6 @@ various kinds.
|
||||
without running into too many problems. Like `error`, it
|
||||
returns -1 after reporting the situation to the caller.
|
||||
|
||||
These reports will be logged via the trace2 facility. See the "error"
|
||||
event in link:api-trace2.txt[trace2 API].
|
||||
|
||||
Customizable error handlers
|
||||
---------------------------
|
||||
|
||||
|
@ -1,105 +0,0 @@
|
||||
Simple-IPC API
|
||||
==============
|
||||
|
||||
The Simple-IPC API is a collection of `ipc_` prefixed library routines
|
||||
and a basic communication protocol that allow an IPC-client process to
|
||||
send an application-specific IPC-request message to an IPC-server
|
||||
process and receive an application-specific IPC-response message.
|
||||
|
||||
Communication occurs over a named pipe on Windows and a Unix domain
|
||||
socket on other platforms. IPC-clients and IPC-servers rendezvous at
|
||||
a previously agreed-to application-specific pathname (which is outside
|
||||
the scope of this design) that is local to the computer system.
|
||||
|
||||
The IPC-server routines within the server application process create a
|
||||
thread pool to listen for connections and receive request messages
|
||||
from multiple concurrent IPC-clients. When received, these messages
|
||||
are dispatched up to the server application callbacks for handling.
|
||||
IPC-server routines then incrementally relay responses back to the
|
||||
IPC-client.
|
||||
|
||||
The IPC-client routines within a client application process connect
|
||||
to the IPC-server and send a request message and wait for a response.
|
||||
When received, the response is returned back the caller.
|
||||
|
||||
For example, the `fsmonitor--daemon` feature will be built as a server
|
||||
application on top of the IPC-server library routines. It will have
|
||||
threads watching for file system events and a thread pool waiting for
|
||||
client connections. Clients, such as `git status` will request a list
|
||||
of file system events since a point in time and the server will
|
||||
respond with a list of changed files and directories. The formats of
|
||||
the request and response are application-specific; the IPC-client and
|
||||
IPC-server routines treat them as opaque byte streams.
|
||||
|
||||
|
||||
Comparison with sub-process model
|
||||
---------------------------------
|
||||
|
||||
The Simple-IPC mechanism differs from the existing `sub-process.c`
|
||||
model (Documentation/technical/long-running-process-protocol.txt) and
|
||||
used by applications like Git-LFS. In the LFS-style sub-process model
|
||||
the helper is started by the foreground process, communication happens
|
||||
via a pair of file descriptors bound to the stdin/stdout of the
|
||||
sub-process, the sub-process only serves the current foreground
|
||||
process, and the sub-process exits when the foreground process
|
||||
terminates.
|
||||
|
||||
In the Simple-IPC model the server is a very long-running service. It
|
||||
can service many clients at the same time and has a private socket or
|
||||
named pipe connection to each active client. It might be started
|
||||
(on-demand) by the current client process or it might have been
|
||||
started by a previous client or by the OS at boot time. The server
|
||||
process is not associated with a terminal and it persists after
|
||||
clients terminate. Clients do not have access to the stdin/stdout of
|
||||
the server process and therefore must communicate over sockets or
|
||||
named pipes.
|
||||
|
||||
|
||||
Server startup and shutdown
|
||||
---------------------------
|
||||
|
||||
How an application server based upon IPC-server is started is also
|
||||
outside the scope of the Simple-IPC design and is a property of the
|
||||
application using it. For example, the server might be started or
|
||||
restarted during routine maintenance operations, or it might be
|
||||
started as a system service during the system boot-up sequence, or it
|
||||
might be started on-demand by a foreground Git command when needed.
|
||||
|
||||
Similarly, server shutdown is a property of the application using
|
||||
the simple-ipc routines. For example, the server might decide to
|
||||
shutdown when idle or only upon explicit request.
|
||||
|
||||
|
||||
Simple-IPC protocol
|
||||
-------------------
|
||||
|
||||
The Simple-IPC protocol consists of a single request message from the
|
||||
client and an optional response message from the server. Both the
|
||||
client and server messages are unlimited in length and are terminated
|
||||
with a flush packet.
|
||||
|
||||
The pkt-line routines (Documentation/technical/protocol-common.txt)
|
||||
are used to simplify buffer management during message generation,
|
||||
transmission, and reception. A flush packet is used to mark the end
|
||||
of the message. This allows the sender to incrementally generate and
|
||||
transmit the message. It allows the receiver to incrementally receive
|
||||
the message in chunks and to know when they have received the entire
|
||||
message.
|
||||
|
||||
The actual byte format of the client request and server response
|
||||
messages are application specific. The IPC layer transmits and
|
||||
receives them as opaque byte buffers without any concern for the
|
||||
content within. It is the job of the calling application layer to
|
||||
understand the contents of the request and response messages.
|
||||
|
||||
|
||||
Summary
|
||||
-------
|
||||
|
||||
Conceptually, the Simple-IPC protocol is similar to an HTTP REST
|
||||
request. Clients connect, make an application-specific and
|
||||
stateless request, receive an application-specific
|
||||
response, and disconnect. It is a one round trip facility for
|
||||
querying the server. The Simple-IPC routines hide the socket,
|
||||
named pipe, and thread pool details and allow the application
|
||||
layer to focus on the application at hand.
|
@ -396,14 +396,14 @@ only present on the "start" and "atexit" events.
|
||||
}
|
||||
------------
|
||||
|
||||
`"too_many_files"`::
|
||||
`"discard"`::
|
||||
This event is written to the git-trace2-discard sentinel file if there
|
||||
are too many files in the target trace directory (see the
|
||||
trace2.maxFiles config option).
|
||||
+
|
||||
------------
|
||||
{
|
||||
"event":"too_many_files",
|
||||
"event":"discard",
|
||||
...
|
||||
}
|
||||
------------
|
||||
@ -465,7 +465,7 @@ completed.)
|
||||
------------
|
||||
|
||||
`"error"`::
|
||||
This event is emitted when one of the `BUG()`, `error()`, `die()`,
|
||||
This event is emitted when one of the `error()`, `die()`,
|
||||
`warning()`, or `usage()` functions are called.
|
||||
+
|
||||
------------
|
||||
|
@ -599,7 +599,7 @@ supports four different modes of operation:
|
||||
convert any object names written to output to SHA-1, but store
|
||||
objects using SHA-256. This allows users to test the code with no
|
||||
visible behavior change except for performance. This allows
|
||||
running even tests that assume the SHA-1 hash function, to
|
||||
allows running even tests that assume the SHA-1 hash function, to
|
||||
sanity-check the behavior of the new mode.
|
||||
|
||||
2. ("early transition") Allow both SHA-1 and SHA-256 object names in
|
||||
|
@ -44,13 +44,6 @@ Git index format
|
||||
localization, no special casing of directory separator '/'). Entries
|
||||
with the same name are sorted by their stage field.
|
||||
|
||||
An index entry typically represents a file. However, if sparse-checkout
|
||||
is enabled in cone mode (`core.sparseCheckoutCone` is enabled) and the
|
||||
`extensions.sparseIndex` extension is enabled, then the index may
|
||||
contain entries for directories outside of the sparse-checkout definition.
|
||||
These entries have mode `040000`, include the `SKIP_WORKTREE` bit, and
|
||||
the path ends in a directory separator.
|
||||
|
||||
32-bit ctime seconds, the last time a file's metadata changed
|
||||
this is stat(2) data
|
||||
|
||||
@ -392,15 +385,3 @@ The remaining data of each directory block is grouped by type:
|
||||
in this block of entries.
|
||||
|
||||
- 32-bit count of cache entries in this block
|
||||
|
||||
== Sparse Directory Entries
|
||||
|
||||
When using sparse-checkout in cone mode, some entire directories within
|
||||
the index can be summarized by pointing to a tree object instead of the
|
||||
entire expanded list of paths within that tree. An index containing such
|
||||
entries is a "sparse index". Index format versions 4 and less were not
|
||||
implemented with such entries in mind. Thus, for these versions, an
|
||||
index containing sparse directory entries will include this extension
|
||||
with signature { 's', 'd', 'i', 'r' }. Like the split-index extension,
|
||||
tools should avoid interacting with a sparse index unless they understand
|
||||
this extension.
|
||||
|
@ -43,9 +43,8 @@ Design Details
|
||||
a change in format.
|
||||
|
||||
- The MIDX keeps only one record per object ID. If an object appears
|
||||
in multiple packfiles, then the MIDX selects the copy in the
|
||||
preferred packfile, otherwise selecting from the most-recently
|
||||
modified packfile.
|
||||
in multiple packfiles, then the MIDX selects the copy in the most-
|
||||
recently modified packfile.
|
||||
|
||||
- If there exist packfiles in the pack directory not registered in
|
||||
the MIDX, then those packfiles are loaded into the `packed_git`
|
||||
|
@ -379,86 +379,3 @@ CHUNK DATA:
|
||||
TRAILER:
|
||||
|
||||
Index checksum of the above contents.
|
||||
|
||||
== multi-pack-index reverse indexes
|
||||
|
||||
Similar to the pack-based reverse index, the multi-pack index can also
|
||||
be used to generate a reverse index.
|
||||
|
||||
Instead of mapping between offset, pack-, and index position, this
|
||||
reverse index maps between an object's position within the MIDX, and
|
||||
that object's position within a pseudo-pack that the MIDX describes
|
||||
(i.e., the ith entry of the multi-pack reverse index holds the MIDX
|
||||
position of ith object in pseudo-pack order).
|
||||
|
||||
To clarify the difference between these orderings, consider a multi-pack
|
||||
reachability bitmap (which does not yet exist, but is what we are
|
||||
building towards here). Each bit needs to correspond to an object in the
|
||||
MIDX, and so we need an efficient mapping from bit position to MIDX
|
||||
position.
|
||||
|
||||
One solution is to let bits occupy the same position in the oid-sorted
|
||||
index stored by the MIDX. But because oids are effectively random, their
|
||||
resulting reachability bitmaps would have no locality, and thus compress
|
||||
poorly. (This is the reason that single-pack bitmaps use the pack
|
||||
ordering, and not the .idx ordering, for the same purpose.)
|
||||
|
||||
So we'd like to define an ordering for the whole MIDX based around
|
||||
pack ordering, which has far better locality (and thus compresses more
|
||||
efficiently). We can think of a pseudo-pack created by the concatenation
|
||||
of all of the packs in the MIDX. E.g., if we had a MIDX with three packs
|
||||
(a, b, c), with 10, 15, and 20 objects respectively, we can imagine an
|
||||
ordering of the objects like:
|
||||
|
||||
|a,0|a,1|...|a,9|b,0|b,1|...|b,14|c,0|c,1|...|c,19|
|
||||
|
||||
where the ordering of the packs is defined by the MIDX's pack list,
|
||||
and then the ordering of objects within each pack is the same as the
|
||||
order in the actual packfile.
|
||||
|
||||
Given the list of packs and their counts of objects, you can
|
||||
naïvely reconstruct that pseudo-pack ordering (e.g., the object at
|
||||
position 27 must be (c,1) because packs "a" and "b" consumed 25 of the
|
||||
slots). But there's a catch. Objects may be duplicated between packs, in
|
||||
which case the MIDX only stores one pointer to the object (and thus we'd
|
||||
want only one slot in the bitmap).
|
||||
|
||||
Callers could handle duplicates themselves by reading objects in order
|
||||
of their bit-position, but that's linear in the number of objects, and
|
||||
much too expensive for ordinary bitmap lookups. Building a reverse index
|
||||
solves this, since it is the logical inverse of the index, and that
|
||||
index has already removed duplicates. But, building a reverse index on
|
||||
the fly can be expensive. Since we already have an on-disk format for
|
||||
pack-based reverse indexes, let's reuse it for the MIDX's pseudo-pack,
|
||||
too.
|
||||
|
||||
Objects from the MIDX are ordered as follows to string together the
|
||||
pseudo-pack. Let `pack(o)` return the pack from which `o` was selected
|
||||
by the MIDX, and define an ordering of packs based on their numeric ID
|
||||
(as stored by the MIDX). Let `offset(o)` return the object offset of `o`
|
||||
within `pack(o)`. Then, compare `o1` and `o2` as follows:
|
||||
|
||||
- If one of `pack(o1)` and `pack(o2)` is preferred and the other
|
||||
is not, then the preferred one sorts first.
|
||||
+
|
||||
(This is a detail that allows the MIDX bitmap to determine which
|
||||
pack should be used by the pack-reuse mechanism, since it can ask
|
||||
the MIDX for the pack containing the object at bit position 0).
|
||||
|
||||
- If `pack(o1) ≠ pack(o2)`, then sort the two objects in descending
|
||||
order based on the pack ID.
|
||||
|
||||
- Otherwise, `pack(o1) = pack(o2)`, and the objects are sorted in
|
||||
pack-order (i.e., `o1` sorts ahead of `o2` exactly when `offset(o1)
|
||||
< offset(o2)`).
|
||||
|
||||
In short, a MIDX's pseudo-pack is the de-duplicated concatenation of
|
||||
objects in packs stored by the MIDX, laid out in pack order, and the
|
||||
packs arranged in MIDX order (with the preferred pack coming first).
|
||||
|
||||
Finally, note that the MIDX's reverse index is not stored as a chunk in
|
||||
the multi-pack-index itself. This is done because the reverse index
|
||||
includes the checksum of the pack or MIDX to which it belongs, which
|
||||
makes it impossible to write in the MIDX. To avoid races when rewriting
|
||||
the MIDX, a MIDX reverse index includes the MIDX's checksum in its
|
||||
filename (e.g., `multi-pack-index-xyz.rev`).
|
||||
|
@ -35,14 +35,13 @@ include some sort of non-trivial implementation in the Minimum Viable Product,
|
||||
at least so that we can test the client.
|
||||
|
||||
This is the implementation: a feature, marked experimental, that allows the
|
||||
server to be configured by one or more `uploadpack.blobPackfileUri=
|
||||
<object-hash> <pack-hash> <uri>` entries. Whenever the list of objects to be
|
||||
sent is assembled, all such blobs are excluded, replaced with URIs. As noted
|
||||
in "Future work" below, the server can evolve in the future to support
|
||||
excluding other objects (or other implementations of servers could be made
|
||||
that support excluding other objects) without needing a protocol change, so
|
||||
clients should not expect that packfiles downloaded in this way only contain
|
||||
single blobs.
|
||||
server to be configured by one or more `uploadpack.blobPackfileUri=<sha1>
|
||||
<uri>` entries. Whenever the list of objects to be sent is assembled, all such
|
||||
blobs are excluded, replaced with URIs. As noted in "Future work" below, the
|
||||
server can evolve in the future to support excluding other objects (or other
|
||||
implementations of servers could be made that support excluding other objects)
|
||||
without needing a protocol change, so clients should not expect that packfiles
|
||||
downloaded in this way only contain single blobs.
|
||||
|
||||
Client design
|
||||
-------------
|
||||
|
@ -1,270 +0,0 @@
|
||||
Parallel Checkout Design Notes
|
||||
==============================
|
||||
|
||||
The "Parallel Checkout" feature attempts to use multiple processes to
|
||||
parallelize the work of uncompressing the blobs, applying in-core
|
||||
filters, and writing the resulting contents to the working tree during a
|
||||
checkout operation. It can be used by all checkout-related commands,
|
||||
such as `clone`, `checkout`, `reset`, `sparse-checkout`, and others.
|
||||
|
||||
These commands share the following basic structure:
|
||||
|
||||
* Step 1: Read the current index file into memory.
|
||||
|
||||
* Step 2: Modify the in-memory index based upon the command, and
|
||||
temporarily mark all cache entries that need to be updated.
|
||||
|
||||
* Step 3: Populate the working tree to match the new candidate index.
|
||||
This includes iterating over all of the to-be-updated cache entries
|
||||
and delete, create, or overwrite the associated files in the working
|
||||
tree.
|
||||
|
||||
* Step 4: Write the new index to disk.
|
||||
|
||||
Step 3 is the focus of the "parallel checkout" effort described here.
|
||||
|
||||
Sequential Implementation
|
||||
-------------------------
|
||||
|
||||
For the purposes of discussion here, the current sequential
|
||||
implementation of Step 3 is divided in 3 parts, each one implemented in
|
||||
its own function:
|
||||
|
||||
* Step 3a: `unpack-trees.c:check_updates()` contains a series of
|
||||
sequential loops iterating over the `cache_entry`'s array. The main
|
||||
loop in this function calls the Step 3b function for each of the
|
||||
to-be-updated entries.
|
||||
|
||||
* Step 3b: `entry.c:checkout_entry()` examines the existing working tree
|
||||
for file conflicts, collisions, and unsaved changes. It removes files
|
||||
and creates leading directories as necessary. It calls the Step 3c
|
||||
function for each entry to be written.
|
||||
|
||||
* Step 3c: `entry.c:write_entry()` loads the blob into memory, smudges
|
||||
it if necessary, creates the file in the working tree, writes the
|
||||
smudged contents, calls `fstat()` or `lstat()`, and updates the
|
||||
associated `cache_entry` struct with the stat information gathered.
|
||||
|
||||
It wouldn't be safe to perform Step 3b in parallel, as there could be
|
||||
race conditions between file creations and removals. Instead, the
|
||||
parallel checkout framework lets the sequential code handle Step 3b,
|
||||
and uses parallel workers to replace the sequential
|
||||
`entry.c:write_entry()` calls from Step 3c.
|
||||
|
||||
Rejected Multi-Threaded Solution
|
||||
--------------------------------
|
||||
|
||||
The most "straightforward" implementation would be to spread the set of
|
||||
to-be-updated cache entries across multiple threads. But due to the
|
||||
thread-unsafe functions in the ODB code, we would have to use locks to
|
||||
coordinate the parallel operation. An early prototype of this solution
|
||||
showed that the multi-threaded checkout would bring performance
|
||||
improvements over the sequential code, but there was still too much lock
|
||||
contention. A `perf` profiling indicated that around 20% of the runtime
|
||||
during a local Linux clone (on an SSD) was spent in locking functions.
|
||||
For this reason this approach was rejected in favor of using multiple
|
||||
child processes, which led to a better performance.
|
||||
|
||||
Multi-Process Solution
|
||||
----------------------
|
||||
|
||||
Parallel checkout alters the aforementioned Step 3 to use multiple
|
||||
`checkout--worker` background processes to distribute the work. The
|
||||
long-running worker processes are controlled by the foreground Git
|
||||
command using the existing run-command API.
|
||||
|
||||
Overview
|
||||
~~~~~~~~
|
||||
|
||||
Step 3b is only slightly altered; for each entry to be checked out, the
|
||||
main process performs the following steps:
|
||||
|
||||
* M1: Check whether there is any untracked or unclean file in the
|
||||
working tree which would be overwritten by this entry, and decide
|
||||
whether to proceed (removing the file(s)) or not.
|
||||
|
||||
* M2: Create the leading directories.
|
||||
|
||||
* M3: Load the conversion attributes for the entry's path.
|
||||
|
||||
* M4: Check, based on the entry's type and conversion attributes,
|
||||
whether the entry is eligible for parallel checkout (more on this
|
||||
later). If it is eligible, enqueue the entry and the loaded
|
||||
attributes to later write the entry in parallel. If not, write the
|
||||
entry right away, using the default sequential code.
|
||||
|
||||
Note: we save the conversion attributes associated with each entry
|
||||
because the workers don't have access to the main process' index state,
|
||||
so they can't load the attributes by themselves (and the attributes are
|
||||
needed to properly smudge the entry). Additionally, this has a positive
|
||||
impact on performance as (1) we don't need to load the attributes twice
|
||||
and (2) the attributes machinery is optimized to handle paths in
|
||||
sequential order.
|
||||
|
||||
After all entries have passed through the above steps, the main process
|
||||
checks if the number of enqueued entries is sufficient to spread among
|
||||
the workers. If not, it just writes them sequentially. Otherwise, it
|
||||
spawns the workers and distributes the queued entries uniformly in
|
||||
continuous chunks. This aims to minimize the chances of two workers
|
||||
writing to the same directory simultaneously, which could increase lock
|
||||
contention in the kernel.
|
||||
|
||||
Then, for each assigned item, each worker:
|
||||
|
||||
* W1: Checks if there is any non-directory file in the leading part of
|
||||
the entry's path or if there already exists a file at the entry' path.
|
||||
If so, mark the entry with `PC_ITEM_COLLIDED` and skip it (more on
|
||||
this later).
|
||||
|
||||
* W2: Creates the file (with O_CREAT and O_EXCL).
|
||||
|
||||
* W3: Loads the blob into memory (inflating and delta reconstructing
|
||||
it).
|
||||
|
||||
* W4: Applies any required in-process filter, like end-of-line
|
||||
conversion and re-encoding.
|
||||
|
||||
* W5: Writes the result to the file descriptor opened at W2.
|
||||
|
||||
* W6: Calls `fstat()` or lstat()` on the just-written path, and sends
|
||||
the result back to the main process, together with the end status of
|
||||
the operation and the item's identification number.
|
||||
|
||||
Note that, when possible, steps W3 to W5 are delegated to the streaming
|
||||
machinery, removing the need to keep the entire blob in memory.
|
||||
|
||||
If the worker fails to read the blob or to write it to the working tree,
|
||||
it removes the created file to avoid leaving empty files behind. This is
|
||||
the *only* time a worker is allowed to remove a file.
|
||||
|
||||
As mentioned earlier, it is the responsibility of the main process to
|
||||
remove any file that blocks the checkout operation (or abort if the
|
||||
removal(s) would cause data loss and the user didn't ask to `--force`).
|
||||
This is crucial to avoid race conditions and also to properly detect
|
||||
path collisions at Step W1.
|
||||
|
||||
After the workers finish writing the items and sending back the required
|
||||
information, the main process handles the results in two steps:
|
||||
|
||||
- First, it updates the in-memory index with the `lstat()` information
|
||||
sent by the workers. (This must be done first as this information
|
||||
might me required in the following step.)
|
||||
|
||||
- Then it writes the items which collided on disk (i.e. items marked
|
||||
with `PC_ITEM_COLLIDED`). More on this below.
|
||||
|
||||
Path Collisions
|
||||
---------------
|
||||
|
||||
Path collisions happen when two different paths correspond to the same
|
||||
entry in the file system. E.g. the paths 'a' and 'A' would collide in a
|
||||
case-insensitive file system.
|
||||
|
||||
The sequential checkout deals with collisions in the same way that it
|
||||
deals with files that were already present in the working tree before
|
||||
checkout. Basically, it checks if the path that it wants to write
|
||||
already exists on disk, makes sure the existing file doesn't have
|
||||
unsaved data, and then overwrites it. (To be more pedantic: it deletes
|
||||
the existing file and creates the new one.) So, if there are multiple
|
||||
colliding files to be checked out, the sequential code will write each
|
||||
one of them but only the last will actually survive on disk.
|
||||
|
||||
Parallel checkout aims to reproduce the same behavior. However, we
|
||||
cannot let the workers racily write to the same file on disk. Instead,
|
||||
the workers detect when the entry that they want to check out would
|
||||
collide with an existing file, and mark it with `PC_ITEM_COLLIDED`.
|
||||
Later, the main process can sequentially feed these entries back to
|
||||
`checkout_entry()` without the risk of race conditions. On clone, this
|
||||
also has the effect of marking the colliding entries to later emit a
|
||||
warning for the user, like the classic sequential checkout does.
|
||||
|
||||
The workers are able to detect both collisions among the entries being
|
||||
concurrently written and collisions between a parallel-eligible entry
|
||||
and an ineligible entry. The general idea for collision detection is
|
||||
quite straightforward: for each parallel-eligible entry, the main
|
||||
process must remove all files that prevent this entry from being written
|
||||
(before enqueueing it). This includes any non-directory file in the
|
||||
leading path of the entry. Later, when a worker gets assigned the entry,
|
||||
it looks again for the non-directories files and for an already existing
|
||||
file at the entry's path. If any of these checks finds something, the
|
||||
worker knows that there was a path collision.
|
||||
|
||||
Because parallel checkout can distinguish path collisions from the case
|
||||
where the file was already present in the working tree before checkout,
|
||||
we could alternatively choose to skip the checkout of colliding entries.
|
||||
However, each entry that doesn't get written would have NULL `lstat()`
|
||||
fields on the index. This could cause performance penalties for
|
||||
subsequent commands that need to refresh the index, as they would have
|
||||
to go to the file system to see if the entry is dirty. Thus, if we have
|
||||
N entries in a colliding group and we decide to write and `lstat()` only
|
||||
one of them, every subsequent `git-status` will have to read, convert,
|
||||
and hash the written file N - 1 times. By checking out all colliding
|
||||
entries (like the sequential code does), we only pay the overhead once,
|
||||
during checkout.
|
||||
|
||||
Eligible Entries for Parallel Checkout
|
||||
--------------------------------------
|
||||
|
||||
As previously mentioned, not all entries passed to `checkout_entry()`
|
||||
will be considered eligible for parallel checkout. More specifically, we
|
||||
exclude:
|
||||
|
||||
- Symbolic links; to avoid race conditions that, in combination with
|
||||
path collisions, could cause workers to write files at the wrong
|
||||
place. For example, if we were to concurrently check out a symlink
|
||||
'a' -> 'b' and a regular file 'A/f' in a case-insensitive file system,
|
||||
we could potentially end up writing the file 'A/f' at 'a/f', due to a
|
||||
race condition.
|
||||
|
||||
- Regular files that require external filters (either "one shot" filters
|
||||
or long-running process filters). These filters are black-boxes to Git
|
||||
and may have their own internal locking or non-concurrent assumptions.
|
||||
So it might not be safe to run multiple instances in parallel.
|
||||
+
|
||||
Besides, long-running filters may use the delayed checkout feature to
|
||||
postpone the return of some filtered blobs. The delayed checkout queue
|
||||
and the parallel checkout queue are not compatible and should remain
|
||||
separate.
|
||||
+
|
||||
Note: regular files that only require internal filters, like end-of-line
|
||||
conversion and re-encoding, are eligible for parallel checkout.
|
||||
|
||||
Ineligible entries are checked out by the classic sequential codepath
|
||||
*before* spawning workers.
|
||||
|
||||
Note: submodules's files are also eligible for parallel checkout (as
|
||||
long as they don't fall into any of the excluding categories mentioned
|
||||
above). But since each submodule is checked out in its own child
|
||||
process, we don't mix the superproject's and the submodules' files in
|
||||
the same parallel checkout process or queue.
|
||||
|
||||
The API
|
||||
-------
|
||||
|
||||
The parallel checkout API was designed with the goal of minimizing
|
||||
changes to the current users of the checkout machinery. This means that
|
||||
they don't have to call a different function for sequential or parallel
|
||||
checkout. As already mentioned, `checkout_entry()` will automatically
|
||||
insert the given entry in the parallel checkout queue when this feature
|
||||
is enabled and the entry is eligible; otherwise, it will just write the
|
||||
entry right away, using the sequential code. In general, callers of the
|
||||
parallel checkout API should look similar to this:
|
||||
|
||||
----------------------------------------------
|
||||
int pc_workers, pc_threshold, err = 0;
|
||||
struct checkout state;
|
||||
|
||||
get_parallel_checkout_configs(&pc_workers, &pc_threshold);
|
||||
|
||||
/*
|
||||
* This check is not strictly required, but it
|
||||
* should save some time in sequential mode.
|
||||
*/
|
||||
if (pc_workers > 1)
|
||||
init_parallel_checkout();
|
||||
|
||||
for (each cache_entry ce to-be-updated)
|
||||
err |= checkout_entry(ce, &state, NULL, NULL);
|
||||
|
||||
err |= run_parallel_checkout(&state, pc_workers, pc_threshold, NULL, NULL);
|
||||
----------------------------------------------
|
@ -242,7 +242,8 @@ remote in a specific order.
|
||||
repository and can satisfy all such requests.
|
||||
|
||||
- Repack essentially treats promisor and non-promisor packfiles as 2
|
||||
distinct partitions and does not mix them.
|
||||
distinct partitions and does not mix them. Repack currently only works
|
||||
on non-promisor packfiles and loose objects.
|
||||
|
||||
- Dynamic object fetching invokes fetch-pack once *for each item*
|
||||
because most algorithms stumble upon a missing object and need to have
|
||||
@ -272,6 +273,9 @@ to use those promisor remotes in that order."
|
||||
The user might want to work in a triangular work flow with multiple
|
||||
promisor remotes that each have an incomplete view of the repository.
|
||||
|
||||
- Allow repack to work on promisor packfiles (while keeping them distinct
|
||||
from non-promisor packfiles).
|
||||
|
||||
- Allow non-pathname-based filters to make use of packfile bitmaps (when
|
||||
present). This was just an omission during the initial implementation.
|
||||
|
||||
|
@ -346,14 +346,6 @@ explained below.
|
||||
client should download from all given URIs. Currently, the
|
||||
protocols supported are "http" and "https".
|
||||
|
||||
If the 'wait-for-done' feature is advertised, the following argument
|
||||
can be included in the client's request.
|
||||
|
||||
wait-for-done
|
||||
Indicates to the server that it should never send "ready", but
|
||||
should wait for the client to say "done" before sending the
|
||||
packfile.
|
||||
|
||||
The response of `fetch` is broken into a number of sections separated by
|
||||
delimiter packets (0001), with each section beginning with its section
|
||||
header. Most sections are sent only when the packfile is sent.
|
||||
@ -522,34 +514,3 @@ packet-line, and must not contain non-printable or whitespace characters. The
|
||||
current implementation uses trace2 session IDs (see
|
||||
link:api-trace2.html[api-trace2] for details), but this may change and users of
|
||||
the session ID should not rely on this fact.
|
||||
|
||||
object-info
|
||||
~~~~~~~~~~~
|
||||
|
||||
`object-info` is the command to retrieve information about one or more objects.
|
||||
Its main purpose is to allow a client to make decisions based on this
|
||||
information without having to fully fetch objects. Object size is the only
|
||||
information that is currently supported.
|
||||
|
||||
An `object-info` request takes the following arguments:
|
||||
|
||||
size
|
||||
Requests size information to be returned for each listed object id.
|
||||
|
||||
oid <oid>
|
||||
Indicates to the server an object which the client wants to obtain
|
||||
information for.
|
||||
|
||||
The response of `object-info` is a list of the requested object ids
|
||||
and associated requested information, each separated by a single space.
|
||||
|
||||
output = info flush-pkt
|
||||
|
||||
info = PKT-LINE(attrs) LF)
|
||||
*PKT-LINE(obj-info LF)
|
||||
|
||||
attrs = attr | attrs SP attrs
|
||||
|
||||
attr = "size"
|
||||
|
||||
obj-info = obj-id SP obj-size
|
||||
|
@ -1011,13 +1011,8 @@ reftable stack, reload `tables.list`, and delete any tables no longer mentioned
|
||||
in `tables.list`.
|
||||
|
||||
Irregular program exit may still leave about unused files. In this case, a
|
||||
cleanup operation should proceed as follows:
|
||||
|
||||
* take a lock `tables.list.lock` to prevent concurrent modifications
|
||||
* refresh the reftable stack, by reading `tables.list`
|
||||
* for each `*.ref` file, remove it if
|
||||
** it is not mentioned in `tables.list`, and
|
||||
** its max update_index is not beyond the max update_index of the stack
|
||||
cleanup operation can read `tables.list`, note its modification timestamp, and
|
||||
delete any unreferenced `*.ref` files that are older.
|
||||
|
||||
|
||||
Alternatives considered
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user