diff --git a/.clang-format b/.clang-format index 41969eca4b7459..9547fe1b77cac0 100644 --- a/.clang-format +++ b/.clang-format @@ -32,6 +32,9 @@ AlignConsecutiveAssignments: false # double b = 3.14; AlignConsecutiveDeclarations: false +# Align consecutive macro definitions. +AlignConsecutiveMacros: true + # Align escaped newlines as far left as possible # #define A \ # int aaaa; \ @@ -209,13 +212,14 @@ KeepEmptyLinesAtTheStartOfBlocks: false # Penalties # This decides what order things should be done if a line is too long -PenaltyBreakAssignment: 10 -PenaltyBreakBeforeFirstCallParameter: 30 -PenaltyBreakComment: 10 +PenaltyBreakAssignment: 5 +PenaltyBreakBeforeFirstCallParameter: 5 +PenaltyBreakComment: 5 PenaltyBreakFirstLessLess: 0 -PenaltyBreakString: 10 -PenaltyExcessCharacter: 100 -PenaltyReturnTypeOnItsOwnLine: 60 +PenaltyBreakOpenParenthesis: 300 +PenaltyBreakString: 5 +PenaltyExcessCharacter: 10 +PenaltyReturnTypeOnItsOwnLine: 300 # Don't sort #include's SortIncludes: false diff --git a/.editorconfig b/.editorconfig index 15d6cbeab109ef..2d3929b5916a14 100644 --- a/.editorconfig +++ b/.editorconfig @@ -4,7 +4,7 @@ insert_final_newline = true # The settings for C (*.c and *.h) files are mirrored in .clang-format. Keep # them in sync. -[{*.{c,h,sh,perl,pl,pm,txt},config.mak.*,Makefile}] +[{*.{c,h,sh,bash,perl,pl,pm,txt,adoc},config.mak.*,Makefile}] indent_style = tab tab_width = 8 diff --git a/.gitattributes b/.gitattributes index 158c3d45c4c10c..c6a0b35116fd90 100644 --- a/.gitattributes +++ b/.gitattributes @@ -7,12 +7,12 @@ *.py text eol=lf diff=python *.bat text eol=crlf CODE_OF_CONDUCT.md -whitespace -/Documentation/**/*.txt text eol=lf +/Documentation/**/*.adoc text eol=lf /command-list.txt text eol=lf /GIT-VERSION-GEN text eol=lf /mergetools/* text eol=lf /t/oid-info/* text eol=lf -/Documentation/git-merge.txt conflict-marker-size=32 -/Documentation/gitk.txt conflict-marker-size=32 -/Documentation/user-manual.txt conflict-marker-size=32 +/Documentation/git-merge.adoc conflict-marker-size=32 +/Documentation/gitk.adoc conflict-marker-size=32 +/Documentation/user-manual.adoc conflict-marker-size=32 /t/t????-*.sh conflict-marker-size=32 diff --git a/.github/workflows/coverity.yml b/.github/workflows/coverity.yml index 48341e81f49066..124301dbbe2fc1 100644 --- a/.github/workflows/coverity.yml +++ b/.github/workflows/coverity.yml @@ -45,7 +45,7 @@ jobs: - run: ci/install-dependencies.sh if: contains(matrix.os, 'ubuntu') || contains(matrix.os, 'macos') env: - distro: ${{ matrix.os }} + CI_JOB_IMAGE: ${{ matrix.os }} # The Coverity site says the tool is usually updated twice yearly, so the # MD5 of download can be used to determine whether there's been an update. diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 916a64b6736d1c..9959b61ece2bcc 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -248,6 +248,58 @@ jobs: with: name: failed-tests-windows-vs-${{ matrix.nr }} path: ${{env.FAILED_TEST_ARTIFACTS}} + + windows-meson-build: + name: win+Meson build + needs: ci-config + if: needs.ci-config.outputs.enabled == 'yes' + runs-on: windows-latest + concurrency: + group: windows-meson-build-${{ github.ref }} + cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }} + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Set up dependencies + shell: pwsh + run: pip install meson ninja + - name: Setup + shell: pwsh + run: meson setup build -Dperl=disabled -Dcredential_helpers=wincred + - name: Compile + shell: pwsh + run: meson compile -C build + - name: Upload build artifacts + uses: actions/upload-artifact@v4 + with: + name: windows-meson-artifacts + path: build + windows-meson-test: + name: win+Meson test + runs-on: windows-latest + needs: [ci-config, windows-meson-build] + strategy: + fail-fast: false + matrix: + nr: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] + concurrency: + group: windows-meson-test-${{ matrix.nr }}-${{ github.ref }} + cancel-in-progress: ${{ needs.ci-config.outputs.skip_concurrent == 'yes' }} + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Set up dependencies + shell: pwsh + run: pip install meson ninja + - name: Download build artifacts + uses: actions/download-artifact@v4 + with: + name: windows-meson-artifacts + path: build + - name: Test + shell: pwsh + run: meson test -C build --list | Select-Object -Skip 1 | Select-String .* | Group-Object -Property { $_.LineNumber % 10 } | Where-Object Name -EQ ${{ matrix.nr }} | ForEach-Object { meson test -C build --no-rebuild --print-errorlogs $_.Group } + regular: name: ${{matrix.vector.jobname}} (${{matrix.vector.pool}}) needs: ci-config @@ -259,20 +311,6 @@ jobs: fail-fast: false matrix: vector: - - jobname: linux-sha256 - cc: clang - pool: ubuntu-latest - - jobname: linux-reftable - cc: clang - pool: ubuntu-latest - - jobname: linux-gcc - cc: gcc - cc_package: gcc-8 - pool: ubuntu-20.04 - - jobname: linux-TEST-vars - cc: gcc - cc_package: gcc-8 - pool: ubuntu-20.04 - jobname: osx-clang cc: clang pool: macos-13 @@ -282,23 +320,15 @@ jobs: - jobname: osx-gcc cc: gcc-13 pool: macos-13 - - jobname: linux-gcc-default - cc: gcc - pool: ubuntu-latest - - jobname: linux-leaks - cc: gcc - pool: ubuntu-latest - - jobname: linux-reftable-leaks - cc: gcc - pool: ubuntu-latest - - jobname: linux-asan-ubsan + - jobname: osx-meson cc: clang - pool: ubuntu-latest + pool: macos-13 env: CC: ${{matrix.vector.cc}} CC_PACKAGE: ${{matrix.vector.cc_package}} jobname: ${{matrix.vector.jobname}} - distro: ${{matrix.vector.pool}} + CI_JOB_IMAGE: ${{matrix.vector.pool}} + TEST_OUTPUT_DIRECTORY: ${{github.workspace}}/t runs-on: ${{matrix.vector.pool}} steps: - uses: actions/checkout@v4 @@ -335,18 +365,48 @@ jobs: fail-fast: false matrix: vector: - - jobname: linux-musl - image: alpine - distro: alpine-latest + - jobname: linux-sha256 + image: ubuntu:rolling + cc: clang + - jobname: linux-reftable + image: ubuntu:rolling + cc: clang + - jobname: linux-TEST-vars + image: ubuntu:20.04 + cc: gcc + cc_package: gcc-8 + - jobname: linux-breaking-changes + cc: gcc + image: ubuntu:rolling + - jobname: linux-leaks + image: ubuntu:rolling + cc: gcc + - jobname: linux-reftable-leaks + image: ubuntu:rolling + cc: gcc + - jobname: linux-asan-ubsan + image: ubuntu:rolling + cc: clang + - jobname: linux-meson + image: ubuntu:rolling + cc: gcc + - jobname: linux-musl-meson + image: alpine:latest + # Supported until 2025-04-02. - jobname: linux32 image: i386/ubuntu:focal - distro: ubuntu32-20.04 - jobname: pedantic - image: fedora - distro: fedora-latest + image: fedora:latest + # A RHEL 8 compatible distro. Supported until 2029-05-31. + - jobname: almalinux-8 + image: almalinux:8 + # Supported until 2026-08-31. + - jobname: debian-11 + image: debian:11 env: jobname: ${{matrix.vector.jobname}} - distro: ${{matrix.vector.distro}} + CC: ${{matrix.vector.cc}} + CI_JOB_IMAGE: ${{matrix.vector.image}} runs-on: ubuntu-latest container: ${{matrix.vector.image}} steps: @@ -355,10 +415,12 @@ jobs: run: apt -q update && apt -q -y install libc6-amd64 lib64stdc++6 - uses: actions/checkout@v4 - run: ci/install-dependencies.sh - - run: ci/run-build-and-tests.sh + - run: useradd builder --create-home + - run: chown -R builder . + - run: sudo --preserve-env --set-home --user=builder ci/run-build-and-tests.sh - name: print test failures if: failure() && env.FAILED_TEST_ARTIFACTS != '' - run: ci/print-test-failures.sh + run: sudo --preserve-env --set-home --user=builder ci/print-test-failures.sh - name: Upload failed tests' directories if: failure() && env.FAILED_TEST_ARTIFACTS != '' uses: actions/upload-artifact@v4 diff --git a/.gitignore b/.gitignore index 6687bd6db4c0a6..b47d63555f1576 100644 --- a/.gitignore +++ b/.gitignore @@ -12,7 +12,6 @@ /GIT-TEST-SUITES /GIT-USER-AGENT /GIT-VERSION-FILE -/bin-wrappers/ /git /git-add /git-am @@ -20,6 +19,7 @@ /git-apply /git-archimport /git-archive +/git-backfill /git-bisect /git-blame /git-branch @@ -165,6 +165,7 @@ /git-submodule /git-submodule--helper /git-subtree +/git-survey /git-svn /git-switch /git-symbolic-ref @@ -195,9 +196,11 @@ /config-list.h /command-list.h /hook-list.h +/version-def.h *.tar.gz *.dsc *.deb +/git.rc /git.spec *.exe *.[aos] @@ -249,3 +252,5 @@ Release/ /git.VC.db *.dSYM /contrib/buildsystems/out +/contrib/libgit-rs/target +/contrib/libgit-sys/target diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 4abfbc3e208e5b..2805cdeecb6a54 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,6 +1,11 @@ default: timeout: 2h +stages: + - build + - test + - analyze + workflow: rules: - if: $CI_PIPELINE_SOURCE == "merge_request_event" @@ -9,10 +14,13 @@ workflow: test:linux: image: $image + stage: test + needs: [ ] tags: - saas-linux-medium-amd64 variables: CUSTOM_PATH: "/custom" + TEST_OUTPUT_DIRECTORY: "/tmp/test-output" before_script: - ./ci/install-dependencies.sh script: @@ -24,42 +32,41 @@ test:linux: if test "$CI_JOB_STATUS" != 'success' then sudo --preserve-env --set-home --user=builder ./ci/print-test-failures.sh + mv "$TEST_OUTPUT_DIRECTORY"/failed-test-artifacts t/ fi parallel: matrix: - - jobname: linux-old - image: ubuntu:16.04 - CC: gcc - jobname: linux-sha256 - image: ubuntu:latest + image: ubuntu:rolling CC: clang - jobname: linux-reftable - image: ubuntu:latest + image: ubuntu:rolling CC: clang - - jobname: linux-gcc + - jobname: linux-breaking-changes image: ubuntu:20.04 CC: gcc - CC_PACKAGE: gcc-8 - jobname: linux-TEST-vars image: ubuntu:20.04 CC: gcc CC_PACKAGE: gcc-8 - - jobname: linux-gcc-default - image: ubuntu:latest - CC: gcc - jobname: linux-leaks - image: ubuntu:latest + image: ubuntu:rolling CC: gcc - jobname: linux-reftable-leaks - image: ubuntu:latest + image: ubuntu:rolling CC: gcc - jobname: linux-asan-ubsan - image: ubuntu:latest + image: ubuntu:rolling CC: clang - jobname: pedantic image: fedora:latest - - jobname: linux-musl + - jobname: linux-musl-meson image: alpine:latest + - jobname: linux32 + image: i386/ubuntu:20.04 + - jobname: linux-meson + image: ubuntu:rolling + CC: gcc artifacts: paths: - t/failed-test-artifacts @@ -67,6 +74,8 @@ test:linux: test:osx: image: $image + stage: test + needs: [ ] tags: - saas-macos-medium-m1 variables: @@ -90,18 +99,93 @@ test:osx: parallel: matrix: - jobname: osx-clang - image: macos-13-xcode-14 + image: macos-14-xcode-15 CC: clang - jobname: osx-reftable - image: macos-13-xcode-14 + image: macos-14-xcode-15 + CC: clang + - jobname: osx-meson + image: macos-14-xcode-15 CC: clang artifacts: paths: - t/failed-test-artifacts when: on_failure +build:mingw64: + stage: build + tags: + - saas-windows-medium-amd64 + variables: + NO_PERL: 1 + before_script: + - ./ci/install-sdk.ps1 -directory "git-sdk" + script: + - git-sdk/usr/bin/bash.exe -l -c 'ci/make-test-artifacts.sh artifacts' + artifacts: + paths: + - artifacts + - git-sdk + +test:mingw64: + stage: test + tags: + - saas-windows-medium-amd64 + needs: + - job: "build:mingw64" + artifacts: true + before_script: + - git-sdk/usr/bin/bash.exe -l -c 'tar xf artifacts/artifacts.tar.gz' + - New-Item -Path .git/info -ItemType Directory + - New-Item .git/info/exclude -ItemType File -Value "/git-sdk" + script: + - git-sdk/usr/bin/bash.exe -l -c "ci/run-test-slice.sh $CI_NODE_INDEX $CI_NODE_TOTAL" + after_script: + - git-sdk/usr/bin/bash.exe -l -c 'ci/print-test-failures.sh' + parallel: 10 + +.msvc-meson: + tags: + - saas-windows-medium-amd64 + before_script: + - choco install -y git meson ninja openssl + - Import-Module $env:ChocolateyInstall\helpers\chocolateyProfile.psm1 + - refreshenv + # The certificate store for Python on Windows is broken and fails to fetch + # certificates, see https://bugs.python.org/issue36011. This seems to + # mostly be an issue with how the GitLab image is set up as it is a + # non-issue on GitHub Actions. Work around the issue by importing + # cetrificates manually. + - Invoke-WebRequest https://curl.haxx.se/ca/cacert.pem -OutFile cacert.pem + - openssl pkcs12 -export -nokeys -in cacert.pem -out certs.pfx -passout "pass:" + - Import-PfxCertificate -CertStoreLocation Cert:\LocalMachine\Root -FilePath certs.pfx + +build:msvc-meson: + extends: .msvc-meson + stage: build + script: + - meson setup build -Dperl=disabled -Dbackend_max_links=1 -Dcredential_helpers=wincred + - meson compile -C build + artifacts: + paths: + - build + +test:msvc-meson: + extends: .msvc-meson + stage: test + when: manual + timeout: 6h + needs: + - job: "build:msvc-meson" + artifacts: true + script: + - meson test -C build --list | Select-Object -Skip 1 | Select-String .* | Group-Object -Property { $_.LineNumber % $Env:CI_NODE_TOTAL + 1 } | Where-Object Name -EQ $Env:CI_NODE_INDEX | ForEach-Object { meson test -C build --no-rebuild --print-errorlogs $_.Group; if (!$?) { exit $LASTEXITCODE } } + parallel: 10 + test:fuzz-smoke-tests: image: ubuntu:latest + stage: test + needs: [ ] variables: CC: clang before_script: @@ -111,6 +195,8 @@ test:fuzz-smoke-tests: static-analysis: image: ubuntu:22.04 + stage: analyze + needs: [ ] variables: jobname: StaticAnalysis before_script: @@ -121,6 +207,8 @@ static-analysis: check-whitespace: image: ubuntu:latest + stage: analyze + needs: [ ] before_script: - ./ci/install-dependencies.sh # Since $CI_MERGE_REQUEST_TARGET_BRANCH_SHA is only defined for merged @@ -128,13 +216,15 @@ check-whitespace: # be defined in all pipelines. script: - | - R=${CI_MERGE_REQUEST_TARGET_BRANCH_SHA-${CI_MERGE_REQUEST_DIFF_BASE_SHA:?}} || exit + R=${CI_MERGE_REQUEST_TARGET_BRANCH_SHA:-${CI_MERGE_REQUEST_DIFF_BASE_SHA:?}} || exit ./ci/check-whitespace.sh "$R" rules: - if: $CI_PIPELINE_SOURCE == 'merge_request_event' check-style: image: ubuntu:latest + stage: analyze + needs: [ ] allow_failure: true variables: CC: clang @@ -146,13 +236,15 @@ check-style: # be defined in all pipelines. script: - | - R=${CI_MERGE_REQUEST_TARGET_BRANCH_SHA-${CI_MERGE_REQUEST_DIFF_BASE_SHA:?}} || exit + R=${CI_MERGE_REQUEST_TARGET_BRANCH_SHA:-${CI_MERGE_REQUEST_DIFF_BASE_SHA:?}} || exit ./ci/run-style-check.sh "$R" rules: - if: $CI_PIPELINE_SOURCE == 'merge_request_event' documentation: image: ubuntu:latest + stage: analyze + needs: [ ] variables: jobname: Documentation before_script: diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes deleted file mode 100644 index ddb030137d54ef..00000000000000 --- a/Documentation/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -*.txt whitespace diff --git a/Documentation/.gitignore b/Documentation/.gitignore index a48448de32f98b..dd54cc768a250c 100644 --- a/Documentation/.gitignore +++ b/Documentation/.gitignore @@ -6,12 +6,15 @@ *.pdf git.info gitman.info -howto-index.txt +howto-index.adoc doc.dep -cmds-*.txt -mergetools-*.txt -SubmittingPatches.txt +cmds-*.adoc +mergetools-*.adoc +SubmittingPatches.adoc tmp-doc-diff/ +tmp-meson-diff/ GIT-ASCIIDOCFLAGS /.build/ /GIT-EXCLUDED-PROGRAMS +/asciidoc.conf +/asciidoctor-extensions.rb diff --git a/Documentation/BreakingChanges.txt b/Documentation/BreakingChanges.adoc similarity index 75% rename from Documentation/BreakingChanges.txt rename to Documentation/BreakingChanges.adoc index 2b64665694f6a9..bdfad29d8a9e3d 100644 --- a/Documentation/BreakingChanges.txt +++ b/Documentation/BreakingChanges.adoc @@ -59,6 +59,24 @@ over time. If circumstances change, an earlier decision to deprecate or change something may need to be revisited from time to time. So do not take items on this list to mean "it is settled, do not waste our time bringing it up again". +== Procedure + +Discussing the desire to make breaking changes, declaring that breaking +changes are made at a certain version boundary, and recording these +decisions in this document, are necessary but not sufficient. +Because such changes are expected to be numerous, and the design and +implementation of them are expected to span over time, they have to +be deployable trivially at such a version boundary, prepared over long +time. + +The breaking changes MUST be guarded with the a compile-time switch, +WITH_BREAKING_CHANGES, to help this process. When built with it, +the resulting Git binary together with its documentation would +behave as if these breaking changes slated for the next big version +boundary are already in effect. We also have a CI job to exercise +the work-in-progress version of Git with these breaking changes. + + == Git 3.0 The following subsections document upcoming breaking changes for Git 3.0. There @@ -117,7 +135,7 @@ Cf. <20140304174806.GA11561@sigill.intra.peff.net>. * The git-pack-redundant(1) command can be used to remove redundant pack files. The subcommand is unusably slow and the reason why nobody reports it as a - performance bug is suspected to be the absense of users. We have nominated + performance bug is suspected to be the absence of users. We have nominated the command for removal and have started to emit a user-visible warning in c3b58472be (pack-redundant: gauge the usage before proposing its removal, 2020-08-25) whenever the command is executed. @@ -135,6 +153,31 @@ Cf. , , <20230323204047.GA9290@coredump.intra.peff.net>, +* Support for storing shorthands for remote URLs in "$GIT_COMMON_DIR/branches/" + and "$GIT_COMMON_DIR/remotes/" has been long superseded by storing remotes in + the repository configuration. ++ +The mechanism has originally been introduced in f170e4b39d ([PATCH] fetch/pull: +short-hand notation for remote repositories., 2005-07-16) and was superseded by +6687f8fea2 ([PATCH] Use .git/remote/origin, not .git/branches/origin., +2005-08-20), where we switched from ".git/branches/" to ".git/remotes/". That +commit already mentions an upcoming deprecation of the ".git/branches/" +directory, and starting with a1d4aa7424 (Add repository-layout document., +2005-09-01) we have also marked this layout as deprecated. Eventually we also +started to migrate away from ".git/remotes/" in favor of config-based remotes, +and we have marked the directory as legacy in 3d3d282146 (Documentation: +Grammar correction, wording fixes and cleanup, 2011-08-23) ++ +As our documentation mentions, these directories are unlikely to be used in +modern repositories and most users aren't even aware of these mechanisms. They +have been deprecated for almost 20 years and 14 years respectively, and we are +not aware of any active users that have complained about this deprecation. +Furthermore, the ".git/branches/" directory is nowadays misleadingly named and +may cause confusion as "branches" are almost exclusively used in the context of +references. ++ +These features will be removed. + == Superseded features that will not be deprecated Some features have gained newer replacements that aim to improve the design in diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 3263245b032370..a0e7041c54b497 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -44,7 +44,7 @@ code are expected to match the style the surrounding code already uses (even if it doesn't match the overall style of existing code). But if you must have a list of rules, here are some language -specific ones. Note that Documentation/ToolsForGit.txt document +specific ones. Note that Documentation/ToolsForGit.adoc document has a collection of tips to help you use some external tools to conform to these guidelines. @@ -583,7 +583,7 @@ For C programs: Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or run `GIT_DEBUGGER=" " ./bin-wrappers/git foo` to use your own debugger and arguments. Example: `GIT_DEBUGGER="ddd --gdb" - ./bin-wrappers/git log` (See `wrap-for-bin.sh`.) + ./bin-wrappers/git log` (See `bin-wrappers/wrap-for-bin.sh`.) - The primary data structure that a subsystem 'S' deals with is called `struct S`. Functions that operate on `struct S` are named @@ -621,6 +621,20 @@ For C programs: - `S_free()` releases a structure's contents and frees the structure. + - Function names should be clear and descriptive, accurately reflecting + their purpose or behavior. Arbitrary suffixes that do not add meaningful + context can lead to confusion, particularly for newcomers to the codebase. + + Historically, the '_1' suffix has been used in situations where: + + - A function handles one element among a group that requires similar + processing. + - A recursive function has been separated from its setup phase. + + The '_1' suffix can be used as a concise way to indicate these specific + cases. However, it is recommended to find a more descriptive name wherever + possible to improve the readability and maintainability of the code. + For Perl programs: - Most of the C guidelines above apply. @@ -689,16 +703,30 @@ Program Output Error Messages - - Do not end error messages with a full stop. + - Do not end a single-sentence error message 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 + 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. - - Say what the error is first ("cannot open %s", not "%s: cannot open") + - Say what the error is first ("cannot open '%s'", not "%s: cannot open"). + + - Enclose the subject of an error inside a pair of single quotes, + e.g. `die(_("unable to open '%s'"), path)`. + + - Unless there is a compelling reason not to, error messages from + porcelain commands should be marked for translation, e.g. + `die(_("bad revision %s"), revision)`. + + - Error messages from the plumbing commands are sometimes meant for + machine consumption and should not be marked for translation, + e.g., `die("bad revision %s", revision)`. + + - BUG("message") are for communicating the specific error to developers, + thus should not be translated. Externally Visible Names @@ -727,7 +755,7 @@ Externally Visible Names Writing Documentation: Most (if not all) of the documentation pages are written in the - AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and + AsciiDoc format in *.adoc files (e.g. Documentation/git.adoc), and processed into HTML and manpages (e.g. git.html and git.1 in the same directory). @@ -828,78 +856,80 @@ Markup: __ __ - A placeholder is not enclosed in backticks, as it is not a literal. - When needed, use a distinctive identifier for placeholders, usually made of a qualification and a type: __ __ - When literal and placeholders are mixed, each markup is applied for - each sub-entity. If they are stuck, a special markup, called - unconstrained formatting is required. - Unconstrained formating for placeholders is ____ - Unconstrained formatting for literal formatting is ++like this++ - `--jobs` __ - ++--sort=++____ - ____++/.git++ - ++remote.++____++.mirror++ + Git's Asciidoc processor has been tailored to treat backticked text + as complex synopsis. When literal and placeholders are mixed, you can + use the backtick notation which will take care of correctly typesetting + the content. + `--jobs ` + `--sort=` + `/.git` + `remote..mirror` + `ssh://[@][:]/` - caveat: ++ unconstrained format is not verbatim and may expand - content. Use Asciidoc escapes inside them. +As a side effect, backquoted placeholders are correctly typeset, but +this style is not recommended. Synopsis Syntax - Syntax grammar is formatted neither as literal nor as placeholder. + The synopsis (a paragraph with [synopsis] attribute) is automatically + formatted by the toolchain and does not need typesetting. A few commented examples follow to provide reference when writing or modifying command usage strings and synopsis sections in the manual pages: Possibility of multiple occurrences is indicated by three dots: - __... + ... (One or more of .) Optional parts are enclosed in square brackets: - [__...] + [...] (Zero or more of .) - ++--exec-path++[++=++____] + An optional parameter needs to be typeset with unconstrained pairs + [] + + --exec-path[=] (Option with an optional argument. Note that the "=" is inside the brackets.) - [__...] + [...] (Zero or more of . Note that the dots are inside, not outside the brackets.) Multiple alternatives are indicated with vertical bars: - [`-q` | `--quiet`] - [`--utf8` | `--no-utf8`] + [-q | --quiet] + [--utf8 | --no-utf8] Use spacing around "|" token(s), but not immediately after opening or before closing a [] or () pair: - Do: [`-q` | `--quiet`] - Don't: [`-q`|`--quiet`] + Do: [-q | --quiet] + Don't: [-q|--quiet] Don't use spacing around "|" tokens when they're used to separate the alternate arguments of an option: - Do: ++--track++[++=++(`direct`|`inherit`)]` - Don't: ++--track++[++=++(`direct` | `inherit`)] + Do: --track[=(direct|inherit)] + Don't: --track[=(direct | inherit)] Parentheses are used for grouping: - [(__ | __)...] + [(|)...] (Any number of either or . Parens are needed to make it clear that "..." pertains to both and .) - [(`-p` __)...] + [(-p )...] (Any number of option -p, each with one argument.) - `git remote set-head` __ (`-a` | `-d` | __) + git remote set-head (-a|-d|) (One and only one of "-a", "-d" or "" _must_ (no square brackets) be provided.) And a somewhat more contrived example: - `--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]` + --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]] Here "=" is outside the brackets, because "--diff-filter=" is a valid usage. "*" has its own pair of brackets, because it can (optionally) be specified only when one or more of the letters is diff --git a/Documentation/DecisionMaking.txt b/Documentation/DecisionMaking.adoc similarity index 98% rename from Documentation/DecisionMaking.txt rename to Documentation/DecisionMaking.adoc index dbb4c1f56981d0..b43c472ae598ed 100644 --- a/Documentation/DecisionMaking.txt +++ b/Documentation/DecisionMaking.adoc @@ -54,7 +54,7 @@ implementation, for very large changes). For non-technical decisions such as community norms or processes, it is up to the community as a whole to implement and sustain agreed-upon changes. -The project leadership committe (PLC) may help the implementation of +The project leadership committee (PLC) may help the implementation of policy decisions. diff --git a/Documentation/Makefile b/Documentation/Makefile index 0f55baa252fffb..671267a8ac7af6 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -1,6 +1,11 @@ +# The default target of this Makefile is... +all:: + # Import tree-wide shared Makefile behavior and libraries include ../shared.mak +.PHONY: FORCE + # Guard against environment variables MAN1_TXT = MAN5_TXT = @@ -15,56 +20,56 @@ OBSOLETE_HTML = -include GIT-EXCLUDED-PROGRAMS MAN1_TXT += $(filter-out \ - $(patsubst %,%.txt,$(EXCLUDED_PROGRAMS)) \ - $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \ - $(wildcard git-*.txt)) -MAN1_TXT += git.txt -MAN1_TXT += gitk.txt -MAN1_TXT += gitweb.txt -MAN1_TXT += scalar.txt + $(patsubst %,%.adoc,$(EXCLUDED_PROGRAMS)) \ + $(addsuffix .adoc, $(ARTICLES) $(SP_ARTICLES)), \ + $(wildcard git-*.adoc)) +MAN1_TXT += git.adoc +MAN1_TXT += gitk.adoc +MAN1_TXT += gitweb.adoc +MAN1_TXT += scalar.adoc # man5 / man7 guides (note: new guides should also be added to command-list.txt) -MAN5_TXT += gitattributes.txt -MAN5_TXT += gitformat-bundle.txt -MAN5_TXT += gitformat-chunk.txt -MAN5_TXT += gitformat-commit-graph.txt -MAN5_TXT += gitformat-index.txt -MAN5_TXT += gitformat-pack.txt -MAN5_TXT += gitformat-signature.txt -MAN5_TXT += githooks.txt -MAN5_TXT += gitignore.txt -MAN5_TXT += gitmailmap.txt -MAN5_TXT += gitmodules.txt -MAN5_TXT += gitprotocol-capabilities.txt -MAN5_TXT += gitprotocol-common.txt -MAN5_TXT += gitprotocol-http.txt -MAN5_TXT += gitprotocol-pack.txt -MAN5_TXT += gitprotocol-v2.txt -MAN5_TXT += gitrepository-layout.txt -MAN5_TXT += gitweb.conf.txt - -MAN7_TXT += gitcli.txt -MAN7_TXT += gitcore-tutorial.txt -MAN7_TXT += gitcredentials.txt -MAN7_TXT += gitcvs-migration.txt -MAN7_TXT += gitdiffcore.txt -MAN7_TXT += giteveryday.txt -MAN7_TXT += gitfaq.txt -MAN7_TXT += gitglossary.txt -MAN7_TXT += gitpacking.txt -MAN7_TXT += gitnamespaces.txt -MAN7_TXT += gitremote-helpers.txt -MAN7_TXT += gitrevisions.txt -MAN7_TXT += gitsubmodules.txt -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) -DOC_DEP_TXT += $(wildcard includes/*.txt) +MAN5_TXT += gitattributes.adoc +MAN5_TXT += gitformat-bundle.adoc +MAN5_TXT += gitformat-chunk.adoc +MAN5_TXT += gitformat-commit-graph.adoc +MAN5_TXT += gitformat-index.adoc +MAN5_TXT += gitformat-pack.adoc +MAN5_TXT += gitformat-signature.adoc +MAN5_TXT += githooks.adoc +MAN5_TXT += gitignore.adoc +MAN5_TXT += gitmailmap.adoc +MAN5_TXT += gitmodules.adoc +MAN5_TXT += gitprotocol-capabilities.adoc +MAN5_TXT += gitprotocol-common.adoc +MAN5_TXT += gitprotocol-http.adoc +MAN5_TXT += gitprotocol-pack.adoc +MAN5_TXT += gitprotocol-v2.adoc +MAN5_TXT += gitrepository-layout.adoc +MAN5_TXT += gitweb.conf.adoc + +MAN7_TXT += gitcli.adoc +MAN7_TXT += gitcore-tutorial.adoc +MAN7_TXT += gitcredentials.adoc +MAN7_TXT += gitcvs-migration.adoc +MAN7_TXT += gitdiffcore.adoc +MAN7_TXT += giteveryday.adoc +MAN7_TXT += gitfaq.adoc +MAN7_TXT += gitglossary.adoc +MAN7_TXT += gitpacking.adoc +MAN7_TXT += gitnamespaces.adoc +MAN7_TXT += gitremote-helpers.adoc +MAN7_TXT += gitrevisions.adoc +MAN7_TXT += gitsubmodules.adoc +MAN7_TXT += gittutorial-2.adoc +MAN7_TXT += gittutorial.adoc +MAN7_TXT += gitworkflows.adoc + +HOWTO_TXT += $(wildcard howto/*.adoc) + +DOC_DEP_TXT += $(wildcard *.adoc) +DOC_DEP_TXT += $(wildcard config/*.adoc) +DOC_DEP_TXT += $(wildcard includes/*.adoc) ifdef MAN_FILTER MAN_TXT = $(filter $(MAN_FILTER),$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)) @@ -73,8 +78,8 @@ MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT) MAN_FILTER = $(MAN_TXT) endif -MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT)) -MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT)) +MAN_XML = $(patsubst %.adoc,%.xml,$(MAN_TXT)) +MAN_HTML = $(patsubst %.adoc,%.html,$(MAN_TXT)) GIT_MAN_REF = master OBSOLETE_HTML += everyday.html @@ -101,7 +106,7 @@ 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))) +API_DOCS = $(patsubst %.adoc,%,$(filter-out technical/api-index-skel.adoc technical/api-index.adoc, $(wildcard technical/api-*.adoc))) SP_ARTICLES += $(API_DOCS) TECH_DOCS += DecisionMaking @@ -111,6 +116,7 @@ TECH_DOCS += MyFirstObjectWalk TECH_DOCS += SubmittingPatches TECH_DOCS += ToolsForGit TECH_DOCS += technical/bitmap-format +TECH_DOCS += technical/build-systems TECH_DOCS += technical/bundle-uri TECH_DOCS += technical/hash-function-transition TECH_DOCS += technical/long-running-process-protocol @@ -133,9 +139,9 @@ ARTICLES_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES)) HTML_FILTER ?= $(ARTICLES_HTML) $(OBSOLETE_HTML) DOC_HTML = $(MAN_HTML) $(filter $(HTML_FILTER),$(ARTICLES_HTML) $(OBSOLETE_HTML)) -DOC_MAN1 = $(patsubst %.txt,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT))) -DOC_MAN5 = $(patsubst %.txt,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT))) -DOC_MAN7 = $(patsubst %.txt,%.7,$(filter $(MAN_FILTER),$(MAN7_TXT))) +DOC_MAN1 = $(patsubst %.adoc,%.1,$(filter $(MAN_FILTER),$(MAN1_TXT))) +DOC_MAN5 = $(patsubst %.adoc,%.5,$(filter $(MAN_FILTER),$(MAN5_TXT))) +DOC_MAN7 = $(patsubst %.adoc,%.7,$(filter $(MAN_FILTER),$(MAN7_TXT))) prefix ?= $(HOME) bindir ?= $(prefix)/bin @@ -148,16 +154,12 @@ man5dir = $(mandir)/man5 man7dir = $(mandir)/man7 # DESTDIR = -GIT_DATE := $(shell git show --quiet --pretty='%as') - ASCIIDOC = asciidoc ASCIIDOC_EXTRA = ASCIIDOC_HTML = xhtml11 ASCIIDOC_DOCBOOK = docbook ASCIIDOC_CONF = -f asciidoc.conf -ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) \ - -amanmanual='Git Manual' -amansource='Git $(GIT_VERSION)' \ - -arevdate='$(GIT_DATE)' +ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) ASCIIDOC_DEPS = asciidoc.conf GIT-ASCIIDOCFLAGS TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML) TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK) @@ -182,6 +184,10 @@ endif -include ../config.mak.autogen -include ../config.mak +# Set GIT_VERSION_OVERRIDE such that version_gen knows to substitute +# GIT_VERSION in case it was set by the user. +GIT_VERSION_OVERRIDE := $(GIT_VERSION) + ifndef NO_MAN_BOLD_LITERAL XMLTO_EXTRA += -m manpage-bold-literal.xsl endif @@ -210,6 +216,16 @@ ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS DBLATEX_COMMON = XMLTO_EXTRA += --skip-validation XMLTO_EXTRA += -x manpage.xsl + +asciidoctor-extensions.rb: asciidoctor-extensions.rb.in FORCE + $(QUIET_GEN)$(call version_gen,"$(shell pwd)/..",$<,$@) +else +asciidoc.conf: asciidoc.conf.in FORCE + $(QUIET_GEN)$(call version_gen,"$(shell pwd)/..",$<,$@) +endif + +ifdef WITH_BREAKING_CHANGES +ASCIIDOC_EXTRA += -awith-breaking-changes endif ASCIIDOC_DEPS += docinfo.html @@ -218,6 +234,7 @@ SHELL_PATH ?= $(SHELL) # Shell quote; SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) +ASCIIDOC_EXTRA += -abuild_dir='$(shell pwd)' ifdef DEFAULT_PAGER DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER)) ASCIIDOC_EXTRA += -a 'git-default-pager=$(DEFAULT_PAGER_SQ)' @@ -228,7 +245,7 @@ DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR)) ASCIIDOC_EXTRA += -a 'git-default-editor=$(DEFAULT_EDITOR_SQ)' endif -all: html man +all:: html man html: $(DOC_HTML) @@ -268,59 +285,46 @@ install-pdf: pdf install-html: html '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir) -../GIT-VERSION-FILE: FORCE - $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) GIT-VERSION-FILE - -ifneq ($(filter-out lint-docs clean,$(MAKECMDGOALS)),) --include ../GIT-VERSION-FILE -endif +mergetools_txt = mergetools-diff.adoc mergetools-merge.adoc # # Determine "include::" file references in asciidoc files. # docdep_prereqs = \ - mergetools-list.made $(mergetools_txt) \ + $(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) + $(QUIET_GEN)$(PERL_PATH) ./build-docdep.perl "$(shell pwd)" >$@ $(QUIET_STDERR) ifneq ($(MAKECMDGOALS),clean) -include doc.dep endif -cmds_txt = cmds-ancillaryinterrogators.txt \ - cmds-ancillarymanipulators.txt \ - cmds-mainporcelain.txt \ - cmds-plumbinginterrogators.txt \ - cmds-plumbingmanipulators.txt \ - cmds-synchingrepositories.txt \ - cmds-synchelpers.txt \ - cmds-guide.txt \ - cmds-developerinterfaces.txt \ - cmds-userinterfaces.txt \ - cmds-purehelpers.txt \ - cmds-foreignscminterface.txt +cmds_txt = cmds-ancillaryinterrogators.adoc \ + cmds-ancillarymanipulators.adoc \ + cmds-mainporcelain.adoc \ + cmds-plumbinginterrogators.adoc \ + cmds-plumbingmanipulators.adoc \ + cmds-synchingrepositories.adoc \ + cmds-synchelpers.adoc \ + cmds-guide.adoc \ + cmds-developerinterfaces.adoc \ + cmds-userinterfaces.adoc \ + cmds-purehelpers.adoc \ + cmds-foreignscminterface.adoc $(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)$(PERL_PATH) ./cmd-list.perl .. . $(cmds_txt) && \ date >$@ -mergetools_txt = mergetools-diff.txt mergetools-merge.txt - -$(mergetools_txt): mergetools-list.made - -mergetools-list.made: ../git-mergetool--lib.sh $(wildcard ../mergetools/*) - $(QUIET_GEN) \ - $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && TOOL_MODE=diff && \ - . ../git-mergetool--lib.sh && \ - show_tool_names can_diff' | sed -e "s/\([a-z0-9]*\)/\`\1\`;;/" >mergetools-diff.txt && \ - $(SHELL_PATH) -c 'MERGE_TOOLS_DIR=../mergetools && TOOL_MODE=merge && \ - . ../git-mergetool--lib.sh && \ - show_tool_names can_merge' | sed -e "s/\([a-z0-9]*\)/\`\1\`;;/" >mergetools-merge.txt && \ - date >$@ +mergetools-%.adoc: generate-mergetool-list.sh ../git-mergetool--lib.sh $(wildcard ../mergetools/*) +mergetools-diff.adoc: + $(QUIET_GEN)$(SHELL_PATH) ./generate-mergetool-list.sh .. diff $@ +mergetools-merge.adoc: + $(QUIET_GEN)$(SHELL_PATH) ./generate-mergetool-list.sh .. merge $@ TRACK_ASCIIDOCFLAGS = $(subst ','\'',$(ASCIIDOC_COMMON):$(ASCIIDOC_HTML):$(ASCIIDOC_DOCBOOK)) @@ -336,19 +340,21 @@ clean: $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 $(RM) *.texi *.texi+ *.texi++ git.info gitman.info $(RM) *.pdf - $(RM) howto-index.txt howto/*.html doc.dep - $(RM) technical/*.html technical/api-index.txt - $(RM) SubmittingPatches.txt + $(RM) howto-index.adoc howto/*.html doc.dep + $(RM) technical/*.html technical/api-index.adoc + $(RM) SubmittingPatches.adoc $(RM) $(cmds_txt) $(mergetools_txt) *.made $(RM) GIT-ASCIIDOCFLAGS + $(RM) asciidoc.conf asciidoctor-extensions.rb + $(RM) -rf tmp-meson-diff docinfo.html: docinfo-html.in $(QUIET_GEN)$(RM) $@ && cat $< >$@ -$(MAN_HTML): %.html : %.txt $(ASCIIDOC_DEPS) +$(MAN_HTML): %.html : %.adoc $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC)$(TXT_TO_HTML) -d manpage -o $@ $< -$(OBSOLETE_HTML): %.html : %.txto $(ASCIIDOC_DEPS) +$(OBSOLETE_HTML): %.html : %.adoco $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC)$(TXT_TO_HTML) -o $@ $< manpage-prereqs := $(wildcard manpage*.xsl) @@ -361,22 +367,22 @@ manpage-cmd = $(QUIET_XMLTO)$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< %.7 : %.xml $(manpage-prereqs) $(manpage-cmd) -%.xml : %.txt $(ASCIIDOC_DEPS) +%.xml : %.adoc $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d manpage -o $@ $< -user-manual.xml: user-manual.txt user-manual.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS +user-manual.xml: user-manual.adoc $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC)$(TXT_TO_XML) -d book -o $@ $< -technical/api-index.txt: technical/api-index-skel.txt \ - technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS)) - $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh +technical/api-index.adoc: technical/api-index-skel.adoc \ + technical/api-index.sh $(patsubst %,%.adoc,$(API_DOCS)) + $(QUIET_GEN)'$(SHELL_PATH_SQ)' technical/api-index.sh ./technical ./technical/api-index.adoc technical/%.html: ASCIIDOC_EXTRA += -a git-relative-html-prefix=../ -$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.txt \ - asciidoc.conf GIT-ASCIIDOCFLAGS - $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt +$(patsubst %,%.html,$(API_DOCS) technical/api-index $(TECH_DOCS)): %.html : %.adoc \ + $(ASCIIDOC_DEPS) + $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.adoc -SubmittingPatches.txt: SubmittingPatches +SubmittingPatches.adoc: SubmittingPatches $(QUIET_GEN) cp $< $@ XSLT = docbook.xsl @@ -410,19 +416,19 @@ gitman.texi: $(MAN_XML) cat-texi.perl texi.xsl gitman.info: gitman.texi $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $< -$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml +$(patsubst %.adoc,%.texi,$(MAN_TXT)): %.texi : %.xml $(QUIET_DB2TEXI)$(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@ -howto-index.txt: howto-index.sh $(HOWTO_TXT) - $(QUIET_GEN)'$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(HOWTO_TXT)) >$@ +howto-index.adoc: howto/howto-index.sh $(HOWTO_TXT) + $(QUIET_GEN)'$(SHELL_PATH_SQ)' ./howto/howto-index.sh $(sort $(HOWTO_TXT)) >$@ -$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt - $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt +$(patsubst %,%.html,$(ARTICLES)) : %.html : %.adoc $(ASCIIDOC_DEPS) + $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.adoc 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 +$(patsubst %.adoc,%.html,$(HOWTO_TXT)): %.html : %.adoc $(ASCIIDOC_DEPS) $(QUIET_ASCIIDOC) \ sed -e '1,/^$$/d' $< | \ $(TXT_TO_HTML) - >$@ @@ -453,9 +459,9 @@ print-man1: @for i in $(MAN1_TXT); do echo $$i; done ## Lint: gitlink -LINT_DOCS_GITLINK = $(patsubst %.txt,.build/lint-docs/gitlink/%.ok,$(HOWTO_TXT) $(DOC_DEP_TXT)) +LINT_DOCS_GITLINK = $(patsubst %.adoc,.build/lint-docs/gitlink/%.ok,$(HOWTO_TXT) $(DOC_DEP_TXT)) $(LINT_DOCS_GITLINK): lint-gitlink.perl -$(LINT_DOCS_GITLINK): .build/lint-docs/gitlink/%.ok: %.txt +$(LINT_DOCS_GITLINK): .build/lint-docs/gitlink/%.ok: %.adoc $(call mkdir_p_parent_template) $(QUIET_LINT_GITLINK)$(PERL_PATH) lint-gitlink.perl \ $< \ @@ -467,17 +473,17 @@ $(LINT_DOCS_GITLINK): .build/lint-docs/gitlink/%.ok: %.txt lint-docs-gitlink: $(LINT_DOCS_GITLINK) ## Lint: man-end-blurb -LINT_DOCS_MAN_END_BLURB = $(patsubst %.txt,.build/lint-docs/man-end-blurb/%.ok,$(MAN_TXT)) +LINT_DOCS_MAN_END_BLURB = $(patsubst %.adoc,.build/lint-docs/man-end-blurb/%.ok,$(MAN_TXT)) $(LINT_DOCS_MAN_END_BLURB): lint-man-end-blurb.perl -$(LINT_DOCS_MAN_END_BLURB): .build/lint-docs/man-end-blurb/%.ok: %.txt +$(LINT_DOCS_MAN_END_BLURB): .build/lint-docs/man-end-blurb/%.ok: %.adoc $(call mkdir_p_parent_template) $(QUIET_LINT_MANEND)$(PERL_PATH) lint-man-end-blurb.perl $< >$@ .PHONY: lint-docs-man-end-blurb ## Lint: man-section-order -LINT_DOCS_MAN_SECTION_ORDER = $(patsubst %.txt,.build/lint-docs/man-section-order/%.ok,$(MAN_TXT)) +LINT_DOCS_MAN_SECTION_ORDER = $(patsubst %.adoc,.build/lint-docs/man-section-order/%.ok,$(MAN_TXT)) $(LINT_DOCS_MAN_SECTION_ORDER): lint-man-section-order.perl -$(LINT_DOCS_MAN_SECTION_ORDER): .build/lint-docs/man-section-order/%.ok: %.txt +$(LINT_DOCS_MAN_SECTION_ORDER): .build/lint-docs/man-section-order/%.ok: %.adoc $(call mkdir_p_parent_template) $(QUIET_LINT_MANSEC)$(PERL_PATH) lint-man-section-order.perl $< >$@ .PHONY: lint-docs-man-section-order @@ -486,16 +492,30 @@ lint-docs-man-section-order: $(LINT_DOCS_MAN_SECTION_ORDER) .PHONY: lint-docs-fsck-msgids LINT_DOCS_FSCK_MSGIDS = .build/lint-docs/fsck-msgids.ok $(LINT_DOCS_FSCK_MSGIDS): lint-fsck-msgids.perl -$(LINT_DOCS_FSCK_MSGIDS): ../fsck.h fsck-msgids.txt +$(LINT_DOCS_FSCK_MSGIDS): ../fsck.h fsck-msgids.adoc $(call mkdir_p_parent_template) $(QUIET_GEN)$(PERL_PATH) lint-fsck-msgids.perl \ - ../fsck.h fsck-msgids.txt $@ + ../fsck.h fsck-msgids.adoc $@ lint-docs-fsck-msgids: $(LINT_DOCS_FSCK_MSGIDS) lint-docs-manpages: $(QUIET_GEN)./lint-manpages.sh +.PHONY: lint-docs-meson +lint-docs-meson: + @# awk acts up when trying to match single quotes, so we use \047 instead. + @mkdir -p tmp-meson-diff && \ + awk "/^manpages = {$$/ {flag=1 ; next } /^}$$/ { flag=0 } flag { gsub(/^ \047/, \"\"); gsub(/\047 : [157],\$$/, \"\"); print }" meson.build | \ + grep -v -e '#' -e '^$$' | \ + sort >tmp-meson-diff/meson.adoc && \ + ls git*.adoc scalar.adoc | grep -v -e git-bisect-lk2009.adoc -e git-tools.adoc >tmp-meson-diff/actual.adoc && \ + if ! cmp tmp-meson-diff/meson.adoc tmp-meson-diff/actual.adoc; then \ + echo "Meson man pages differ from actual man pages:"; \ + diff -u tmp-meson-diff/meson.adoc tmp-meson-diff/actual.adoc; \ + exit 1; \ + fi + ## Lint: list of targets above .PHONY: lint-docs lint-docs: lint-docs-fsck-msgids @@ -503,6 +523,7 @@ lint-docs: lint-docs-gitlink lint-docs: lint-docs-man-end-blurb lint-docs: lint-docs-man-section-order lint-docs: lint-docs-manpages +lint-docs: lint-docs-meson ifeq ($(wildcard po/Makefile),po/Makefile) doc-l10n install-l10n:: diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.adoc similarity index 98% rename from Documentation/MyFirstContribution.txt rename to Documentation/MyFirstContribution.adoc index e41654c00a68e0..afcf4b46c11ab2 100644 --- a/Documentation/MyFirstContribution.txt +++ b/Documentation/MyFirstContribution.adoc @@ -21,7 +21,7 @@ This tutorial aims to summarize the following documents, but the reader may find useful additional context: - `Documentation/SubmittingPatches` -- `Documentation/howto/new-command.txt` +- `Documentation/howto/new-command.adoc` [[getting-help]] === Getting Help @@ -331,7 +331,7 @@ function body: apply standard precedence rules. `git_config_get_string_tmp()` will look up a specific key ("user.name") and give you the value. There are a number of single-key lookup functions like this one; you can see them all (and more info -about how to use `git_config()`) in `Documentation/technical/api-config.txt`. +about how to use `git_config()`) in `Documentation/technical/api-config.adoc`. You should see that the name printed matches the one you see when you run: @@ -461,10 +461,10 @@ $ ./bin-wrappers/git help psuh Your new command is undocumented! Let's fix that. -Take a look at `Documentation/git-*.txt`. These are the manpages for the +Take a look at `Documentation/git-*.adoc`. These are the manpages for the subcommands that Git knows about. You can open these up and take a look to get acquainted with the format, but then go ahead and make a new file -`Documentation/git-psuh.txt`. Like with most of the documentation in the Git +`Documentation/git-psuh.adoc`. Like with most of the documentation in the Git project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing Documentation" section). Use the following template to fill out your own manpage: @@ -543,7 +543,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end. That's because `-h` is a special case which your command should handle by printing usage. -Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy +Take a look at `Documentation/technical/api-parse-options.adoc`. This is a handy tool for pulling out options you need to be able to handle, and it takes a usage string. @@ -1088,14 +1088,14 @@ This gives reviewers a summary of what they're in for when reviewing your topic. The one generated for `psuh` from the sample implementation looks like this: ---- - Documentation/git-psuh.txt | 40 +++++++++++++++++++++ - Makefile | 1 + - builtin.h | 1 + - builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++ - git.c | 1 + - t/t9999-psuh-tutorial.sh | 12 +++++++ + Documentation/git-psuh.adoc | 40 +++++++++++++++++++++ + Makefile | 1 + + builtin.h | 1 + + builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++ + git.c | 1 + + t/t9999-psuh-tutorial.sh | 12 +++++++ 6 files changed, 128 insertions(+) - create mode 100644 Documentation/git-psuh.txt + create mode 100644 Documentation/git-psuh.adoc create mode 100644 builtin/psuh.c create mode 100755 t/t9999-psuh-tutorial.sh ---- diff --git a/Documentation/MyFirstObjectWalk.txt b/Documentation/MyFirstObjectWalk.adoc similarity index 98% rename from Documentation/MyFirstObjectWalk.txt rename to Documentation/MyFirstObjectWalk.adoc index dec8afe5b10533..d6e9dfdbbe232e 100644 --- a/Documentation/MyFirstObjectWalk.txt +++ b/Documentation/MyFirstObjectWalk.adoc @@ -15,7 +15,7 @@ revision walk is used for operations like `git log`. === Related Reading -- `Documentation/user-manual.txt` under "Hacking Git" contains some coverage of +- `Documentation/user-manual.adoc` under "Hacking Git" contains some coverage of the revision walker in its various incarnations. - `revision.h` - https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists] @@ -112,7 +112,7 @@ $ GIT_TRACE=1 ./bin-wrappers/git walken ---- NOTE: For a more exhaustive overview of the new command process, take a look at -`Documentation/MyFirstContribution.txt`. +`Documentation/MyFirstContribution.adoc`. NOTE: A reference implementation can be found at https://github.com/nasamuffin/git/tree/revwalk. @@ -132,7 +132,7 @@ used to track the allocated size of the list. Per entry, we find: `item` is the object provided upon which to base the object walk. Items in Git -can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.txt`.) +can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.adoc`.) `name` is the object ID (OID) of the object - a hex string you may be familiar with from using Git to organize your source in the past. Check the tutorial @@ -141,7 +141,7 @@ from. `whence` indicates some information about what to do with the parents of the specified object. We'll explore this flag more later on; take a look at -`Documentation/revisions.txt` to get an idea of what could set the `whence` +`Documentation/revisions.adoc` to get an idea of what could set the `whence` value. `flags` are used to hint the beginning of the revision walk and are the first @@ -153,7 +153,7 @@ can be used during the walk, as well. This one is quite a bit longer, and many fields are only used during the walk by `revision.c` - not configuration options. Most of the configurable flags in -`struct rev_info` have a mirror in `Documentation/rev-list-options.txt`. It's a +`struct rev_info` have a mirror in `Documentation/rev-list-options.adoc`. It's a good idea to take some time and read through that document. == Basic Commit Walk @@ -710,7 +710,7 @@ objects grows along with the Git project. === Adding a Filter There are a handful of filters that we can apply to the object walk laid out in -`Documentation/rev-list-options.txt`. These filters are typically useful for +`Documentation/rev-list-options.adoc`. These filters are typically useful for operations such as creating packfiles or performing a partial clone. They are defined in `list-objects-filter-options.h`. For the purposes of this tutorial we will use the "tree:1" filter, which causes the walk to omit all trees and blobs diff --git a/Documentation/RelNotes/1.5.0.1.txt b/Documentation/RelNotes/1.5.0.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.1.txt rename to Documentation/RelNotes/1.5.0.1.adoc diff --git a/Documentation/RelNotes/1.5.0.2.txt b/Documentation/RelNotes/1.5.0.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.2.txt rename to Documentation/RelNotes/1.5.0.2.adoc diff --git a/Documentation/RelNotes/1.5.0.3.txt b/Documentation/RelNotes/1.5.0.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.3.txt rename to Documentation/RelNotes/1.5.0.3.adoc diff --git a/Documentation/RelNotes/1.5.0.4.txt b/Documentation/RelNotes/1.5.0.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.4.txt rename to Documentation/RelNotes/1.5.0.4.adoc diff --git a/Documentation/RelNotes/1.5.0.5.txt b/Documentation/RelNotes/1.5.0.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.5.txt rename to Documentation/RelNotes/1.5.0.5.adoc diff --git a/Documentation/RelNotes/1.5.0.6.txt b/Documentation/RelNotes/1.5.0.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.6.txt rename to Documentation/RelNotes/1.5.0.6.adoc diff --git a/Documentation/RelNotes/1.5.0.7.txt b/Documentation/RelNotes/1.5.0.7.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.7.txt rename to Documentation/RelNotes/1.5.0.7.adoc diff --git a/Documentation/RelNotes/1.5.0.txt b/Documentation/RelNotes/1.5.0.adoc similarity index 100% rename from Documentation/RelNotes/1.5.0.txt rename to Documentation/RelNotes/1.5.0.adoc diff --git a/Documentation/RelNotes/1.5.1.1.txt b/Documentation/RelNotes/1.5.1.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.1.txt rename to Documentation/RelNotes/1.5.1.1.adoc diff --git a/Documentation/RelNotes/1.5.1.2.txt b/Documentation/RelNotes/1.5.1.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.2.txt rename to Documentation/RelNotes/1.5.1.2.adoc diff --git a/Documentation/RelNotes/1.5.1.3.txt b/Documentation/RelNotes/1.5.1.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.3.txt rename to Documentation/RelNotes/1.5.1.3.adoc diff --git a/Documentation/RelNotes/1.5.1.4.txt b/Documentation/RelNotes/1.5.1.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.4.txt rename to Documentation/RelNotes/1.5.1.4.adoc diff --git a/Documentation/RelNotes/1.5.1.5.txt b/Documentation/RelNotes/1.5.1.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.5.txt rename to Documentation/RelNotes/1.5.1.5.adoc diff --git a/Documentation/RelNotes/1.5.1.6.txt b/Documentation/RelNotes/1.5.1.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.6.txt rename to Documentation/RelNotes/1.5.1.6.adoc diff --git a/Documentation/RelNotes/1.5.1.txt b/Documentation/RelNotes/1.5.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.1.txt rename to Documentation/RelNotes/1.5.1.adoc diff --git a/Documentation/RelNotes/1.5.2.1.txt b/Documentation/RelNotes/1.5.2.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.2.1.txt rename to Documentation/RelNotes/1.5.2.1.adoc diff --git a/Documentation/RelNotes/1.5.2.2.txt b/Documentation/RelNotes/1.5.2.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.2.2.txt rename to Documentation/RelNotes/1.5.2.2.adoc diff --git a/Documentation/RelNotes/1.5.2.3.txt b/Documentation/RelNotes/1.5.2.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.2.3.txt rename to Documentation/RelNotes/1.5.2.3.adoc diff --git a/Documentation/RelNotes/1.5.2.4.txt b/Documentation/RelNotes/1.5.2.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.2.4.txt rename to Documentation/RelNotes/1.5.2.4.adoc diff --git a/Documentation/RelNotes/1.5.2.5.txt b/Documentation/RelNotes/1.5.2.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.2.5.txt rename to Documentation/RelNotes/1.5.2.5.adoc diff --git a/Documentation/RelNotes/1.5.2.txt b/Documentation/RelNotes/1.5.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.2.txt rename to Documentation/RelNotes/1.5.2.adoc diff --git a/Documentation/RelNotes/1.5.3.1.txt b/Documentation/RelNotes/1.5.3.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.1.txt rename to Documentation/RelNotes/1.5.3.1.adoc diff --git a/Documentation/RelNotes/1.5.3.2.txt b/Documentation/RelNotes/1.5.3.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.2.txt rename to Documentation/RelNotes/1.5.3.2.adoc diff --git a/Documentation/RelNotes/1.5.3.3.txt b/Documentation/RelNotes/1.5.3.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.3.txt rename to Documentation/RelNotes/1.5.3.3.adoc diff --git a/Documentation/RelNotes/1.5.3.4.txt b/Documentation/RelNotes/1.5.3.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.4.txt rename to Documentation/RelNotes/1.5.3.4.adoc diff --git a/Documentation/RelNotes/1.5.3.5.txt b/Documentation/RelNotes/1.5.3.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.5.txt rename to Documentation/RelNotes/1.5.3.5.adoc diff --git a/Documentation/RelNotes/1.5.3.6.txt b/Documentation/RelNotes/1.5.3.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.6.txt rename to Documentation/RelNotes/1.5.3.6.adoc diff --git a/Documentation/RelNotes/1.5.3.7.txt b/Documentation/RelNotes/1.5.3.7.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.7.txt rename to Documentation/RelNotes/1.5.3.7.adoc diff --git a/Documentation/RelNotes/1.5.3.8.txt b/Documentation/RelNotes/1.5.3.8.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.8.txt rename to Documentation/RelNotes/1.5.3.8.adoc diff --git a/Documentation/RelNotes/1.5.3.txt b/Documentation/RelNotes/1.5.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.3.txt rename to Documentation/RelNotes/1.5.3.adoc diff --git a/Documentation/RelNotes/1.5.4.1.txt b/Documentation/RelNotes/1.5.4.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.1.txt rename to Documentation/RelNotes/1.5.4.1.adoc diff --git a/Documentation/RelNotes/1.5.4.2.txt b/Documentation/RelNotes/1.5.4.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.2.txt rename to Documentation/RelNotes/1.5.4.2.adoc diff --git a/Documentation/RelNotes/1.5.4.3.txt b/Documentation/RelNotes/1.5.4.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.3.txt rename to Documentation/RelNotes/1.5.4.3.adoc diff --git a/Documentation/RelNotes/1.5.4.4.txt b/Documentation/RelNotes/1.5.4.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.4.txt rename to Documentation/RelNotes/1.5.4.4.adoc diff --git a/Documentation/RelNotes/1.5.4.5.txt b/Documentation/RelNotes/1.5.4.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.5.txt rename to Documentation/RelNotes/1.5.4.5.adoc diff --git a/Documentation/RelNotes/1.5.4.6.txt b/Documentation/RelNotes/1.5.4.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.6.txt rename to Documentation/RelNotes/1.5.4.6.adoc diff --git a/Documentation/RelNotes/1.5.4.7.txt b/Documentation/RelNotes/1.5.4.7.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.7.txt rename to Documentation/RelNotes/1.5.4.7.adoc diff --git a/Documentation/RelNotes/1.5.4.txt b/Documentation/RelNotes/1.5.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.4.txt rename to Documentation/RelNotes/1.5.4.adoc diff --git a/Documentation/RelNotes/1.5.5.1.txt b/Documentation/RelNotes/1.5.5.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.1.txt rename to Documentation/RelNotes/1.5.5.1.adoc diff --git a/Documentation/RelNotes/1.5.5.2.txt b/Documentation/RelNotes/1.5.5.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.2.txt rename to Documentation/RelNotes/1.5.5.2.adoc diff --git a/Documentation/RelNotes/1.5.5.3.txt b/Documentation/RelNotes/1.5.5.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.3.txt rename to Documentation/RelNotes/1.5.5.3.adoc diff --git a/Documentation/RelNotes/1.5.5.4.txt b/Documentation/RelNotes/1.5.5.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.4.txt rename to Documentation/RelNotes/1.5.5.4.adoc diff --git a/Documentation/RelNotes/1.5.5.5.txt b/Documentation/RelNotes/1.5.5.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.5.txt rename to Documentation/RelNotes/1.5.5.5.adoc diff --git a/Documentation/RelNotes/1.5.5.6.txt b/Documentation/RelNotes/1.5.5.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.6.txt rename to Documentation/RelNotes/1.5.5.6.adoc diff --git a/Documentation/RelNotes/1.5.5.txt b/Documentation/RelNotes/1.5.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.5.txt rename to Documentation/RelNotes/1.5.5.adoc diff --git a/Documentation/RelNotes/1.5.6.1.txt b/Documentation/RelNotes/1.5.6.1.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.1.txt rename to Documentation/RelNotes/1.5.6.1.adoc diff --git a/Documentation/RelNotes/1.5.6.2.txt b/Documentation/RelNotes/1.5.6.2.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.2.txt rename to Documentation/RelNotes/1.5.6.2.adoc diff --git a/Documentation/RelNotes/1.5.6.3.txt b/Documentation/RelNotes/1.5.6.3.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.3.txt rename to Documentation/RelNotes/1.5.6.3.adoc diff --git a/Documentation/RelNotes/1.5.6.4.txt b/Documentation/RelNotes/1.5.6.4.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.4.txt rename to Documentation/RelNotes/1.5.6.4.adoc diff --git a/Documentation/RelNotes/1.5.6.5.txt b/Documentation/RelNotes/1.5.6.5.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.5.txt rename to Documentation/RelNotes/1.5.6.5.adoc diff --git a/Documentation/RelNotes/1.5.6.6.txt b/Documentation/RelNotes/1.5.6.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.6.txt rename to Documentation/RelNotes/1.5.6.6.adoc diff --git a/Documentation/RelNotes/1.5.6.txt b/Documentation/RelNotes/1.5.6.adoc similarity index 100% rename from Documentation/RelNotes/1.5.6.txt rename to Documentation/RelNotes/1.5.6.adoc diff --git a/Documentation/RelNotes/1.6.0.1.txt b/Documentation/RelNotes/1.6.0.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.1.txt rename to Documentation/RelNotes/1.6.0.1.adoc diff --git a/Documentation/RelNotes/1.6.0.2.txt b/Documentation/RelNotes/1.6.0.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.2.txt rename to Documentation/RelNotes/1.6.0.2.adoc diff --git a/Documentation/RelNotes/1.6.0.3.txt b/Documentation/RelNotes/1.6.0.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.3.txt rename to Documentation/RelNotes/1.6.0.3.adoc diff --git a/Documentation/RelNotes/1.6.0.4.txt b/Documentation/RelNotes/1.6.0.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.4.txt rename to Documentation/RelNotes/1.6.0.4.adoc diff --git a/Documentation/RelNotes/1.6.0.5.txt b/Documentation/RelNotes/1.6.0.5.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.5.txt rename to Documentation/RelNotes/1.6.0.5.adoc diff --git a/Documentation/RelNotes/1.6.0.6.txt b/Documentation/RelNotes/1.6.0.6.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.6.txt rename to Documentation/RelNotes/1.6.0.6.adoc diff --git a/Documentation/RelNotes/1.6.0.txt b/Documentation/RelNotes/1.6.0.adoc similarity index 100% rename from Documentation/RelNotes/1.6.0.txt rename to Documentation/RelNotes/1.6.0.adoc diff --git a/Documentation/RelNotes/1.6.1.1.txt b/Documentation/RelNotes/1.6.1.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.1.1.txt rename to Documentation/RelNotes/1.6.1.1.adoc diff --git a/Documentation/RelNotes/1.6.1.2.txt b/Documentation/RelNotes/1.6.1.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.1.2.txt rename to Documentation/RelNotes/1.6.1.2.adoc diff --git a/Documentation/RelNotes/1.6.1.3.txt b/Documentation/RelNotes/1.6.1.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.1.3.txt rename to Documentation/RelNotes/1.6.1.3.adoc diff --git a/Documentation/RelNotes/1.6.1.4.txt b/Documentation/RelNotes/1.6.1.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.1.4.txt rename to Documentation/RelNotes/1.6.1.4.adoc diff --git a/Documentation/RelNotes/1.6.1.txt b/Documentation/RelNotes/1.6.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.1.txt rename to Documentation/RelNotes/1.6.1.adoc diff --git a/Documentation/RelNotes/1.6.2.1.txt b/Documentation/RelNotes/1.6.2.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.2.1.txt rename to Documentation/RelNotes/1.6.2.1.adoc diff --git a/Documentation/RelNotes/1.6.2.2.txt b/Documentation/RelNotes/1.6.2.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.2.2.txt rename to Documentation/RelNotes/1.6.2.2.adoc diff --git a/Documentation/RelNotes/1.6.2.3.txt b/Documentation/RelNotes/1.6.2.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.2.3.txt rename to Documentation/RelNotes/1.6.2.3.adoc diff --git a/Documentation/RelNotes/1.6.2.4.txt b/Documentation/RelNotes/1.6.2.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.2.4.txt rename to Documentation/RelNotes/1.6.2.4.adoc diff --git a/Documentation/RelNotes/1.6.2.5.txt b/Documentation/RelNotes/1.6.2.5.adoc similarity index 100% rename from Documentation/RelNotes/1.6.2.5.txt rename to Documentation/RelNotes/1.6.2.5.adoc diff --git a/Documentation/RelNotes/1.6.2.txt b/Documentation/RelNotes/1.6.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.2.txt rename to Documentation/RelNotes/1.6.2.adoc diff --git a/Documentation/RelNotes/1.6.3.1.txt b/Documentation/RelNotes/1.6.3.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.3.1.txt rename to Documentation/RelNotes/1.6.3.1.adoc diff --git a/Documentation/RelNotes/1.6.3.2.txt b/Documentation/RelNotes/1.6.3.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.3.2.txt rename to Documentation/RelNotes/1.6.3.2.adoc diff --git a/Documentation/RelNotes/1.6.3.3.txt b/Documentation/RelNotes/1.6.3.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.3.3.txt rename to Documentation/RelNotes/1.6.3.3.adoc diff --git a/Documentation/RelNotes/1.6.3.4.txt b/Documentation/RelNotes/1.6.3.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.3.4.txt rename to Documentation/RelNotes/1.6.3.4.adoc diff --git a/Documentation/RelNotes/1.6.3.txt b/Documentation/RelNotes/1.6.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.3.txt rename to Documentation/RelNotes/1.6.3.adoc diff --git a/Documentation/RelNotes/1.6.4.1.txt b/Documentation/RelNotes/1.6.4.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.4.1.txt rename to Documentation/RelNotes/1.6.4.1.adoc diff --git a/Documentation/RelNotes/1.6.4.2.txt b/Documentation/RelNotes/1.6.4.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.4.2.txt rename to Documentation/RelNotes/1.6.4.2.adoc diff --git a/Documentation/RelNotes/1.6.4.3.txt b/Documentation/RelNotes/1.6.4.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.4.3.txt rename to Documentation/RelNotes/1.6.4.3.adoc diff --git a/Documentation/RelNotes/1.6.4.4.txt b/Documentation/RelNotes/1.6.4.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.4.4.txt rename to Documentation/RelNotes/1.6.4.4.adoc diff --git a/Documentation/RelNotes/1.6.4.5.txt b/Documentation/RelNotes/1.6.4.5.adoc similarity index 100% rename from Documentation/RelNotes/1.6.4.5.txt rename to Documentation/RelNotes/1.6.4.5.adoc diff --git a/Documentation/RelNotes/1.6.4.txt b/Documentation/RelNotes/1.6.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.4.txt rename to Documentation/RelNotes/1.6.4.adoc diff --git a/Documentation/RelNotes/1.6.5.1.txt b/Documentation/RelNotes/1.6.5.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.1.txt rename to Documentation/RelNotes/1.6.5.1.adoc diff --git a/Documentation/RelNotes/1.6.5.2.txt b/Documentation/RelNotes/1.6.5.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.2.txt rename to Documentation/RelNotes/1.6.5.2.adoc diff --git a/Documentation/RelNotes/1.6.5.3.txt b/Documentation/RelNotes/1.6.5.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.3.txt rename to Documentation/RelNotes/1.6.5.3.adoc diff --git a/Documentation/RelNotes/1.6.5.4.txt b/Documentation/RelNotes/1.6.5.4.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.4.txt rename to Documentation/RelNotes/1.6.5.4.adoc diff --git a/Documentation/RelNotes/1.6.5.5.txt b/Documentation/RelNotes/1.6.5.5.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.5.txt rename to Documentation/RelNotes/1.6.5.5.adoc diff --git a/Documentation/RelNotes/1.6.5.6.txt b/Documentation/RelNotes/1.6.5.6.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.6.txt rename to Documentation/RelNotes/1.6.5.6.adoc diff --git a/Documentation/RelNotes/1.6.5.7.txt b/Documentation/RelNotes/1.6.5.7.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.7.txt rename to Documentation/RelNotes/1.6.5.7.adoc diff --git a/Documentation/RelNotes/1.6.5.8.txt b/Documentation/RelNotes/1.6.5.8.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.8.txt rename to Documentation/RelNotes/1.6.5.8.adoc diff --git a/Documentation/RelNotes/1.6.5.9.txt b/Documentation/RelNotes/1.6.5.9.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.9.txt rename to Documentation/RelNotes/1.6.5.9.adoc diff --git a/Documentation/RelNotes/1.6.5.txt b/Documentation/RelNotes/1.6.5.adoc similarity index 100% rename from Documentation/RelNotes/1.6.5.txt rename to Documentation/RelNotes/1.6.5.adoc diff --git a/Documentation/RelNotes/1.6.6.1.txt b/Documentation/RelNotes/1.6.6.1.adoc similarity index 100% rename from Documentation/RelNotes/1.6.6.1.txt rename to Documentation/RelNotes/1.6.6.1.adoc diff --git a/Documentation/RelNotes/1.6.6.2.txt b/Documentation/RelNotes/1.6.6.2.adoc similarity index 100% rename from Documentation/RelNotes/1.6.6.2.txt rename to Documentation/RelNotes/1.6.6.2.adoc diff --git a/Documentation/RelNotes/1.6.6.3.txt b/Documentation/RelNotes/1.6.6.3.adoc similarity index 100% rename from Documentation/RelNotes/1.6.6.3.txt rename to Documentation/RelNotes/1.6.6.3.adoc diff --git a/Documentation/RelNotes/1.6.6.txt b/Documentation/RelNotes/1.6.6.adoc similarity index 100% rename from Documentation/RelNotes/1.6.6.txt rename to Documentation/RelNotes/1.6.6.adoc diff --git a/Documentation/RelNotes/1.7.0.1.txt b/Documentation/RelNotes/1.7.0.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.1.txt rename to Documentation/RelNotes/1.7.0.1.adoc diff --git a/Documentation/RelNotes/1.7.0.2.txt b/Documentation/RelNotes/1.7.0.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.2.txt rename to Documentation/RelNotes/1.7.0.2.adoc diff --git a/Documentation/RelNotes/1.7.0.3.txt b/Documentation/RelNotes/1.7.0.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.3.txt rename to Documentation/RelNotes/1.7.0.3.adoc diff --git a/Documentation/RelNotes/1.7.0.4.txt b/Documentation/RelNotes/1.7.0.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.4.txt rename to Documentation/RelNotes/1.7.0.4.adoc diff --git a/Documentation/RelNotes/1.7.0.5.txt b/Documentation/RelNotes/1.7.0.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.5.txt rename to Documentation/RelNotes/1.7.0.5.adoc diff --git a/Documentation/RelNotes/1.7.0.6.txt b/Documentation/RelNotes/1.7.0.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.6.txt rename to Documentation/RelNotes/1.7.0.6.adoc diff --git a/Documentation/RelNotes/1.7.0.7.txt b/Documentation/RelNotes/1.7.0.7.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.7.txt rename to Documentation/RelNotes/1.7.0.7.adoc diff --git a/Documentation/RelNotes/1.7.0.8.txt b/Documentation/RelNotes/1.7.0.8.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.8.txt rename to Documentation/RelNotes/1.7.0.8.adoc diff --git a/Documentation/RelNotes/1.7.0.9.txt b/Documentation/RelNotes/1.7.0.9.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.9.txt rename to Documentation/RelNotes/1.7.0.9.adoc diff --git a/Documentation/RelNotes/1.7.0.txt b/Documentation/RelNotes/1.7.0.adoc similarity index 100% rename from Documentation/RelNotes/1.7.0.txt rename to Documentation/RelNotes/1.7.0.adoc diff --git a/Documentation/RelNotes/1.7.1.1.txt b/Documentation/RelNotes/1.7.1.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.1.1.txt rename to Documentation/RelNotes/1.7.1.1.adoc diff --git a/Documentation/RelNotes/1.7.1.2.txt b/Documentation/RelNotes/1.7.1.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.1.2.txt rename to Documentation/RelNotes/1.7.1.2.adoc diff --git a/Documentation/RelNotes/1.7.1.3.txt b/Documentation/RelNotes/1.7.1.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.1.3.txt rename to Documentation/RelNotes/1.7.1.3.adoc diff --git a/Documentation/RelNotes/1.7.1.4.txt b/Documentation/RelNotes/1.7.1.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.1.4.txt rename to Documentation/RelNotes/1.7.1.4.adoc diff --git a/Documentation/RelNotes/1.7.1.txt b/Documentation/RelNotes/1.7.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.1.txt rename to Documentation/RelNotes/1.7.1.adoc diff --git a/Documentation/RelNotes/1.7.10.1.txt b/Documentation/RelNotes/1.7.10.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.10.1.txt rename to Documentation/RelNotes/1.7.10.1.adoc diff --git a/Documentation/RelNotes/1.7.10.2.txt b/Documentation/RelNotes/1.7.10.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.10.2.txt rename to Documentation/RelNotes/1.7.10.2.adoc diff --git a/Documentation/RelNotes/1.7.10.3.txt b/Documentation/RelNotes/1.7.10.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.10.3.txt rename to Documentation/RelNotes/1.7.10.3.adoc diff --git a/Documentation/RelNotes/1.7.10.4.txt b/Documentation/RelNotes/1.7.10.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.10.4.txt rename to Documentation/RelNotes/1.7.10.4.adoc diff --git a/Documentation/RelNotes/1.7.10.5.txt b/Documentation/RelNotes/1.7.10.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.10.5.txt rename to Documentation/RelNotes/1.7.10.5.adoc diff --git a/Documentation/RelNotes/1.7.10.txt b/Documentation/RelNotes/1.7.10.adoc similarity index 100% rename from Documentation/RelNotes/1.7.10.txt rename to Documentation/RelNotes/1.7.10.adoc diff --git a/Documentation/RelNotes/1.7.11.1.txt b/Documentation/RelNotes/1.7.11.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.1.txt rename to Documentation/RelNotes/1.7.11.1.adoc diff --git a/Documentation/RelNotes/1.7.11.2.txt b/Documentation/RelNotes/1.7.11.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.2.txt rename to Documentation/RelNotes/1.7.11.2.adoc diff --git a/Documentation/RelNotes/1.7.11.3.txt b/Documentation/RelNotes/1.7.11.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.3.txt rename to Documentation/RelNotes/1.7.11.3.adoc diff --git a/Documentation/RelNotes/1.7.11.4.txt b/Documentation/RelNotes/1.7.11.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.4.txt rename to Documentation/RelNotes/1.7.11.4.adoc diff --git a/Documentation/RelNotes/1.7.11.5.txt b/Documentation/RelNotes/1.7.11.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.5.txt rename to Documentation/RelNotes/1.7.11.5.adoc diff --git a/Documentation/RelNotes/1.7.11.6.txt b/Documentation/RelNotes/1.7.11.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.6.txt rename to Documentation/RelNotes/1.7.11.6.adoc diff --git a/Documentation/RelNotes/1.7.11.7.txt b/Documentation/RelNotes/1.7.11.7.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.7.txt rename to Documentation/RelNotes/1.7.11.7.adoc diff --git a/Documentation/RelNotes/1.7.11.txt b/Documentation/RelNotes/1.7.11.adoc similarity index 100% rename from Documentation/RelNotes/1.7.11.txt rename to Documentation/RelNotes/1.7.11.adoc diff --git a/Documentation/RelNotes/1.7.12.1.txt b/Documentation/RelNotes/1.7.12.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.12.1.txt rename to Documentation/RelNotes/1.7.12.1.adoc diff --git a/Documentation/RelNotes/1.7.12.2.txt b/Documentation/RelNotes/1.7.12.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.12.2.txt rename to Documentation/RelNotes/1.7.12.2.adoc diff --git a/Documentation/RelNotes/1.7.12.3.txt b/Documentation/RelNotes/1.7.12.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.12.3.txt rename to Documentation/RelNotes/1.7.12.3.adoc diff --git a/Documentation/RelNotes/1.7.12.4.txt b/Documentation/RelNotes/1.7.12.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.12.4.txt rename to Documentation/RelNotes/1.7.12.4.adoc diff --git a/Documentation/RelNotes/1.7.12.txt b/Documentation/RelNotes/1.7.12.adoc similarity index 100% rename from Documentation/RelNotes/1.7.12.txt rename to Documentation/RelNotes/1.7.12.adoc diff --git a/Documentation/RelNotes/1.7.2.1.txt b/Documentation/RelNotes/1.7.2.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.2.1.txt rename to Documentation/RelNotes/1.7.2.1.adoc diff --git a/Documentation/RelNotes/1.7.2.2.txt b/Documentation/RelNotes/1.7.2.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.2.2.txt rename to Documentation/RelNotes/1.7.2.2.adoc diff --git a/Documentation/RelNotes/1.7.2.3.txt b/Documentation/RelNotes/1.7.2.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.2.3.txt rename to Documentation/RelNotes/1.7.2.3.adoc diff --git a/Documentation/RelNotes/1.7.2.4.txt b/Documentation/RelNotes/1.7.2.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.2.4.txt rename to Documentation/RelNotes/1.7.2.4.adoc diff --git a/Documentation/RelNotes/1.7.2.5.txt b/Documentation/RelNotes/1.7.2.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.2.5.txt rename to Documentation/RelNotes/1.7.2.5.adoc diff --git a/Documentation/RelNotes/1.7.2.txt b/Documentation/RelNotes/1.7.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.2.txt rename to Documentation/RelNotes/1.7.2.adoc diff --git a/Documentation/RelNotes/1.7.3.1.txt b/Documentation/RelNotes/1.7.3.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.3.1.txt rename to Documentation/RelNotes/1.7.3.1.adoc diff --git a/Documentation/RelNotes/1.7.3.2.txt b/Documentation/RelNotes/1.7.3.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.3.2.txt rename to Documentation/RelNotes/1.7.3.2.adoc diff --git a/Documentation/RelNotes/1.7.3.3.txt b/Documentation/RelNotes/1.7.3.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.3.3.txt rename to Documentation/RelNotes/1.7.3.3.adoc diff --git a/Documentation/RelNotes/1.7.3.4.txt b/Documentation/RelNotes/1.7.3.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.3.4.txt rename to Documentation/RelNotes/1.7.3.4.adoc diff --git a/Documentation/RelNotes/1.7.3.5.txt b/Documentation/RelNotes/1.7.3.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.3.5.txt rename to Documentation/RelNotes/1.7.3.5.adoc diff --git a/Documentation/RelNotes/1.7.3.txt b/Documentation/RelNotes/1.7.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.3.txt rename to Documentation/RelNotes/1.7.3.adoc diff --git a/Documentation/RelNotes/1.7.4.1.txt b/Documentation/RelNotes/1.7.4.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.4.1.txt rename to Documentation/RelNotes/1.7.4.1.adoc diff --git a/Documentation/RelNotes/1.7.4.2.txt b/Documentation/RelNotes/1.7.4.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.4.2.txt rename to Documentation/RelNotes/1.7.4.2.adoc diff --git a/Documentation/RelNotes/1.7.4.3.txt b/Documentation/RelNotes/1.7.4.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.4.3.txt rename to Documentation/RelNotes/1.7.4.3.adoc diff --git a/Documentation/RelNotes/1.7.4.4.txt b/Documentation/RelNotes/1.7.4.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.4.4.txt rename to Documentation/RelNotes/1.7.4.4.adoc diff --git a/Documentation/RelNotes/1.7.4.5.txt b/Documentation/RelNotes/1.7.4.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.4.5.txt rename to Documentation/RelNotes/1.7.4.5.adoc diff --git a/Documentation/RelNotes/1.7.4.txt b/Documentation/RelNotes/1.7.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.4.txt rename to Documentation/RelNotes/1.7.4.adoc diff --git a/Documentation/RelNotes/1.7.5.1.txt b/Documentation/RelNotes/1.7.5.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.5.1.txt rename to Documentation/RelNotes/1.7.5.1.adoc diff --git a/Documentation/RelNotes/1.7.5.2.txt b/Documentation/RelNotes/1.7.5.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.5.2.txt rename to Documentation/RelNotes/1.7.5.2.adoc diff --git a/Documentation/RelNotes/1.7.5.3.txt b/Documentation/RelNotes/1.7.5.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.5.3.txt rename to Documentation/RelNotes/1.7.5.3.adoc diff --git a/Documentation/RelNotes/1.7.5.4.txt b/Documentation/RelNotes/1.7.5.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.5.4.txt rename to Documentation/RelNotes/1.7.5.4.adoc diff --git a/Documentation/RelNotes/1.7.5.txt b/Documentation/RelNotes/1.7.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.5.txt rename to Documentation/RelNotes/1.7.5.adoc diff --git a/Documentation/RelNotes/1.7.6.1.txt b/Documentation/RelNotes/1.7.6.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.1.txt rename to Documentation/RelNotes/1.7.6.1.adoc diff --git a/Documentation/RelNotes/1.7.6.2.txt b/Documentation/RelNotes/1.7.6.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.2.txt rename to Documentation/RelNotes/1.7.6.2.adoc diff --git a/Documentation/RelNotes/1.7.6.3.txt b/Documentation/RelNotes/1.7.6.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.3.txt rename to Documentation/RelNotes/1.7.6.3.adoc diff --git a/Documentation/RelNotes/1.7.6.4.txt b/Documentation/RelNotes/1.7.6.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.4.txt rename to Documentation/RelNotes/1.7.6.4.adoc diff --git a/Documentation/RelNotes/1.7.6.5.txt b/Documentation/RelNotes/1.7.6.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.5.txt rename to Documentation/RelNotes/1.7.6.5.adoc diff --git a/Documentation/RelNotes/1.7.6.6.txt b/Documentation/RelNotes/1.7.6.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.6.txt rename to Documentation/RelNotes/1.7.6.6.adoc diff --git a/Documentation/RelNotes/1.7.6.txt b/Documentation/RelNotes/1.7.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.6.txt rename to Documentation/RelNotes/1.7.6.adoc diff --git a/Documentation/RelNotes/1.7.7.1.txt b/Documentation/RelNotes/1.7.7.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.1.txt rename to Documentation/RelNotes/1.7.7.1.adoc diff --git a/Documentation/RelNotes/1.7.7.2.txt b/Documentation/RelNotes/1.7.7.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.2.txt rename to Documentation/RelNotes/1.7.7.2.adoc diff --git a/Documentation/RelNotes/1.7.7.3.txt b/Documentation/RelNotes/1.7.7.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.3.txt rename to Documentation/RelNotes/1.7.7.3.adoc diff --git a/Documentation/RelNotes/1.7.7.4.txt b/Documentation/RelNotes/1.7.7.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.4.txt rename to Documentation/RelNotes/1.7.7.4.adoc diff --git a/Documentation/RelNotes/1.7.7.5.txt b/Documentation/RelNotes/1.7.7.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.5.txt rename to Documentation/RelNotes/1.7.7.5.adoc diff --git a/Documentation/RelNotes/1.7.7.6.txt b/Documentation/RelNotes/1.7.7.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.6.txt rename to Documentation/RelNotes/1.7.7.6.adoc diff --git a/Documentation/RelNotes/1.7.7.7.txt b/Documentation/RelNotes/1.7.7.7.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.7.txt rename to Documentation/RelNotes/1.7.7.7.adoc diff --git a/Documentation/RelNotes/1.7.7.txt b/Documentation/RelNotes/1.7.7.adoc similarity index 100% rename from Documentation/RelNotes/1.7.7.txt rename to Documentation/RelNotes/1.7.7.adoc diff --git a/Documentation/RelNotes/1.7.8.1.txt b/Documentation/RelNotes/1.7.8.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.1.txt rename to Documentation/RelNotes/1.7.8.1.adoc diff --git a/Documentation/RelNotes/1.7.8.2.txt b/Documentation/RelNotes/1.7.8.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.2.txt rename to Documentation/RelNotes/1.7.8.2.adoc diff --git a/Documentation/RelNotes/1.7.8.3.txt b/Documentation/RelNotes/1.7.8.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.3.txt rename to Documentation/RelNotes/1.7.8.3.adoc diff --git a/Documentation/RelNotes/1.7.8.4.txt b/Documentation/RelNotes/1.7.8.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.4.txt rename to Documentation/RelNotes/1.7.8.4.adoc diff --git a/Documentation/RelNotes/1.7.8.5.txt b/Documentation/RelNotes/1.7.8.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.5.txt rename to Documentation/RelNotes/1.7.8.5.adoc diff --git a/Documentation/RelNotes/1.7.8.6.txt b/Documentation/RelNotes/1.7.8.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.6.txt rename to Documentation/RelNotes/1.7.8.6.adoc diff --git a/Documentation/RelNotes/1.7.8.txt b/Documentation/RelNotes/1.7.8.adoc similarity index 100% rename from Documentation/RelNotes/1.7.8.txt rename to Documentation/RelNotes/1.7.8.adoc diff --git a/Documentation/RelNotes/1.7.9.1.txt b/Documentation/RelNotes/1.7.9.1.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.1.txt rename to Documentation/RelNotes/1.7.9.1.adoc diff --git a/Documentation/RelNotes/1.7.9.2.txt b/Documentation/RelNotes/1.7.9.2.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.2.txt rename to Documentation/RelNotes/1.7.9.2.adoc diff --git a/Documentation/RelNotes/1.7.9.3.txt b/Documentation/RelNotes/1.7.9.3.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.3.txt rename to Documentation/RelNotes/1.7.9.3.adoc diff --git a/Documentation/RelNotes/1.7.9.4.txt b/Documentation/RelNotes/1.7.9.4.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.4.txt rename to Documentation/RelNotes/1.7.9.4.adoc diff --git a/Documentation/RelNotes/1.7.9.5.txt b/Documentation/RelNotes/1.7.9.5.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.5.txt rename to Documentation/RelNotes/1.7.9.5.adoc diff --git a/Documentation/RelNotes/1.7.9.6.txt b/Documentation/RelNotes/1.7.9.6.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.6.txt rename to Documentation/RelNotes/1.7.9.6.adoc diff --git a/Documentation/RelNotes/1.7.9.7.txt b/Documentation/RelNotes/1.7.9.7.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.7.txt rename to Documentation/RelNotes/1.7.9.7.adoc diff --git a/Documentation/RelNotes/1.7.9.txt b/Documentation/RelNotes/1.7.9.adoc similarity index 100% rename from Documentation/RelNotes/1.7.9.txt rename to Documentation/RelNotes/1.7.9.adoc diff --git a/Documentation/RelNotes/1.8.0.1.txt b/Documentation/RelNotes/1.8.0.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.0.1.txt rename to Documentation/RelNotes/1.8.0.1.adoc diff --git a/Documentation/RelNotes/1.8.0.2.txt b/Documentation/RelNotes/1.8.0.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.0.2.txt rename to Documentation/RelNotes/1.8.0.2.adoc diff --git a/Documentation/RelNotes/1.8.0.3.txt b/Documentation/RelNotes/1.8.0.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.0.3.txt rename to Documentation/RelNotes/1.8.0.3.adoc diff --git a/Documentation/RelNotes/1.8.0.txt b/Documentation/RelNotes/1.8.0.adoc similarity index 100% rename from Documentation/RelNotes/1.8.0.txt rename to Documentation/RelNotes/1.8.0.adoc diff --git a/Documentation/RelNotes/1.8.1.1.txt b/Documentation/RelNotes/1.8.1.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.1.txt rename to Documentation/RelNotes/1.8.1.1.adoc diff --git a/Documentation/RelNotes/1.8.1.2.txt b/Documentation/RelNotes/1.8.1.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.2.txt rename to Documentation/RelNotes/1.8.1.2.adoc diff --git a/Documentation/RelNotes/1.8.1.3.txt b/Documentation/RelNotes/1.8.1.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.3.txt rename to Documentation/RelNotes/1.8.1.3.adoc diff --git a/Documentation/RelNotes/1.8.1.4.txt b/Documentation/RelNotes/1.8.1.4.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.4.txt rename to Documentation/RelNotes/1.8.1.4.adoc diff --git a/Documentation/RelNotes/1.8.1.5.txt b/Documentation/RelNotes/1.8.1.5.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.5.txt rename to Documentation/RelNotes/1.8.1.5.adoc diff --git a/Documentation/RelNotes/1.8.1.6.txt b/Documentation/RelNotes/1.8.1.6.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.6.txt rename to Documentation/RelNotes/1.8.1.6.adoc diff --git a/Documentation/RelNotes/1.8.1.txt b/Documentation/RelNotes/1.8.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.1.txt rename to Documentation/RelNotes/1.8.1.adoc diff --git a/Documentation/RelNotes/1.8.2.1.txt b/Documentation/RelNotes/1.8.2.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.2.1.txt rename to Documentation/RelNotes/1.8.2.1.adoc diff --git a/Documentation/RelNotes/1.8.2.2.txt b/Documentation/RelNotes/1.8.2.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.2.2.txt rename to Documentation/RelNotes/1.8.2.2.adoc diff --git a/Documentation/RelNotes/1.8.2.3.txt b/Documentation/RelNotes/1.8.2.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.2.3.txt rename to Documentation/RelNotes/1.8.2.3.adoc diff --git a/Documentation/RelNotes/1.8.2.txt b/Documentation/RelNotes/1.8.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.2.txt rename to Documentation/RelNotes/1.8.2.adoc diff --git a/Documentation/RelNotes/1.8.3.1.txt b/Documentation/RelNotes/1.8.3.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.3.1.txt rename to Documentation/RelNotes/1.8.3.1.adoc diff --git a/Documentation/RelNotes/1.8.3.2.txt b/Documentation/RelNotes/1.8.3.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.3.2.txt rename to Documentation/RelNotes/1.8.3.2.adoc diff --git a/Documentation/RelNotes/1.8.3.3.txt b/Documentation/RelNotes/1.8.3.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.3.3.txt rename to Documentation/RelNotes/1.8.3.3.adoc diff --git a/Documentation/RelNotes/1.8.3.4.txt b/Documentation/RelNotes/1.8.3.4.adoc similarity index 100% rename from Documentation/RelNotes/1.8.3.4.txt rename to Documentation/RelNotes/1.8.3.4.adoc diff --git a/Documentation/RelNotes/1.8.3.txt b/Documentation/RelNotes/1.8.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.3.txt rename to Documentation/RelNotes/1.8.3.adoc diff --git a/Documentation/RelNotes/1.8.4.1.txt b/Documentation/RelNotes/1.8.4.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.4.1.txt rename to Documentation/RelNotes/1.8.4.1.adoc diff --git a/Documentation/RelNotes/1.8.4.2.txt b/Documentation/RelNotes/1.8.4.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.4.2.txt rename to Documentation/RelNotes/1.8.4.2.adoc diff --git a/Documentation/RelNotes/1.8.4.3.txt b/Documentation/RelNotes/1.8.4.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.4.3.txt rename to Documentation/RelNotes/1.8.4.3.adoc diff --git a/Documentation/RelNotes/1.8.4.4.txt b/Documentation/RelNotes/1.8.4.4.adoc similarity index 100% rename from Documentation/RelNotes/1.8.4.4.txt rename to Documentation/RelNotes/1.8.4.4.adoc diff --git a/Documentation/RelNotes/1.8.4.5.txt b/Documentation/RelNotes/1.8.4.5.adoc similarity index 100% rename from Documentation/RelNotes/1.8.4.5.txt rename to Documentation/RelNotes/1.8.4.5.adoc diff --git a/Documentation/RelNotes/1.8.4.txt b/Documentation/RelNotes/1.8.4.adoc similarity index 100% rename from Documentation/RelNotes/1.8.4.txt rename to Documentation/RelNotes/1.8.4.adoc diff --git a/Documentation/RelNotes/1.8.5.1.txt b/Documentation/RelNotes/1.8.5.1.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.1.txt rename to Documentation/RelNotes/1.8.5.1.adoc diff --git a/Documentation/RelNotes/1.8.5.2.txt b/Documentation/RelNotes/1.8.5.2.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.2.txt rename to Documentation/RelNotes/1.8.5.2.adoc diff --git a/Documentation/RelNotes/1.8.5.3.txt b/Documentation/RelNotes/1.8.5.3.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.3.txt rename to Documentation/RelNotes/1.8.5.3.adoc diff --git a/Documentation/RelNotes/1.8.5.4.txt b/Documentation/RelNotes/1.8.5.4.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.4.txt rename to Documentation/RelNotes/1.8.5.4.adoc diff --git a/Documentation/RelNotes/1.8.5.5.txt b/Documentation/RelNotes/1.8.5.5.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.5.txt rename to Documentation/RelNotes/1.8.5.5.adoc diff --git a/Documentation/RelNotes/1.8.5.6.txt b/Documentation/RelNotes/1.8.5.6.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.6.txt rename to Documentation/RelNotes/1.8.5.6.adoc diff --git a/Documentation/RelNotes/1.8.5.txt b/Documentation/RelNotes/1.8.5.adoc similarity index 100% rename from Documentation/RelNotes/1.8.5.txt rename to Documentation/RelNotes/1.8.5.adoc diff --git a/Documentation/RelNotes/1.9.0.txt b/Documentation/RelNotes/1.9.0.adoc similarity index 100% rename from Documentation/RelNotes/1.9.0.txt rename to Documentation/RelNotes/1.9.0.adoc diff --git a/Documentation/RelNotes/1.9.1.txt b/Documentation/RelNotes/1.9.1.adoc similarity index 100% rename from Documentation/RelNotes/1.9.1.txt rename to Documentation/RelNotes/1.9.1.adoc diff --git a/Documentation/RelNotes/1.9.2.txt b/Documentation/RelNotes/1.9.2.adoc similarity index 100% rename from Documentation/RelNotes/1.9.2.txt rename to Documentation/RelNotes/1.9.2.adoc diff --git a/Documentation/RelNotes/1.9.3.txt b/Documentation/RelNotes/1.9.3.adoc similarity index 100% rename from Documentation/RelNotes/1.9.3.txt rename to Documentation/RelNotes/1.9.3.adoc diff --git a/Documentation/RelNotes/1.9.4.txt b/Documentation/RelNotes/1.9.4.adoc similarity index 100% rename from Documentation/RelNotes/1.9.4.txt rename to Documentation/RelNotes/1.9.4.adoc diff --git a/Documentation/RelNotes/1.9.5.txt b/Documentation/RelNotes/1.9.5.adoc similarity index 100% rename from Documentation/RelNotes/1.9.5.txt rename to Documentation/RelNotes/1.9.5.adoc diff --git a/Documentation/RelNotes/2.0.0.txt b/Documentation/RelNotes/2.0.0.adoc similarity index 100% rename from Documentation/RelNotes/2.0.0.txt rename to Documentation/RelNotes/2.0.0.adoc diff --git a/Documentation/RelNotes/2.0.1.txt b/Documentation/RelNotes/2.0.1.adoc similarity index 100% rename from Documentation/RelNotes/2.0.1.txt rename to Documentation/RelNotes/2.0.1.adoc diff --git a/Documentation/RelNotes/2.0.2.txt b/Documentation/RelNotes/2.0.2.adoc similarity index 100% rename from Documentation/RelNotes/2.0.2.txt rename to Documentation/RelNotes/2.0.2.adoc diff --git a/Documentation/RelNotes/2.0.3.txt b/Documentation/RelNotes/2.0.3.adoc similarity index 100% rename from Documentation/RelNotes/2.0.3.txt rename to Documentation/RelNotes/2.0.3.adoc diff --git a/Documentation/RelNotes/2.0.4.txt b/Documentation/RelNotes/2.0.4.adoc similarity index 100% rename from Documentation/RelNotes/2.0.4.txt rename to Documentation/RelNotes/2.0.4.adoc diff --git a/Documentation/RelNotes/2.0.5.txt b/Documentation/RelNotes/2.0.5.adoc similarity index 100% rename from Documentation/RelNotes/2.0.5.txt rename to Documentation/RelNotes/2.0.5.adoc diff --git a/Documentation/RelNotes/2.1.0.txt b/Documentation/RelNotes/2.1.0.adoc similarity index 100% rename from Documentation/RelNotes/2.1.0.txt rename to Documentation/RelNotes/2.1.0.adoc diff --git a/Documentation/RelNotes/2.1.1.txt b/Documentation/RelNotes/2.1.1.adoc similarity index 100% rename from Documentation/RelNotes/2.1.1.txt rename to Documentation/RelNotes/2.1.1.adoc diff --git a/Documentation/RelNotes/2.1.2.txt b/Documentation/RelNotes/2.1.2.adoc similarity index 100% rename from Documentation/RelNotes/2.1.2.txt rename to Documentation/RelNotes/2.1.2.adoc diff --git a/Documentation/RelNotes/2.1.3.txt b/Documentation/RelNotes/2.1.3.adoc similarity index 100% rename from Documentation/RelNotes/2.1.3.txt rename to Documentation/RelNotes/2.1.3.adoc diff --git a/Documentation/RelNotes/2.1.4.txt b/Documentation/RelNotes/2.1.4.adoc similarity index 100% rename from Documentation/RelNotes/2.1.4.txt rename to Documentation/RelNotes/2.1.4.adoc diff --git a/Documentation/RelNotes/2.10.0.txt b/Documentation/RelNotes/2.10.0.adoc similarity index 100% rename from Documentation/RelNotes/2.10.0.txt rename to Documentation/RelNotes/2.10.0.adoc diff --git a/Documentation/RelNotes/2.10.1.txt b/Documentation/RelNotes/2.10.1.adoc similarity index 100% rename from Documentation/RelNotes/2.10.1.txt rename to Documentation/RelNotes/2.10.1.adoc diff --git a/Documentation/RelNotes/2.10.2.txt b/Documentation/RelNotes/2.10.2.adoc similarity index 100% rename from Documentation/RelNotes/2.10.2.txt rename to Documentation/RelNotes/2.10.2.adoc diff --git a/Documentation/RelNotes/2.10.3.txt b/Documentation/RelNotes/2.10.3.adoc similarity index 100% rename from Documentation/RelNotes/2.10.3.txt rename to Documentation/RelNotes/2.10.3.adoc diff --git a/Documentation/RelNotes/2.10.4.txt b/Documentation/RelNotes/2.10.4.adoc similarity index 100% rename from Documentation/RelNotes/2.10.4.txt rename to Documentation/RelNotes/2.10.4.adoc diff --git a/Documentation/RelNotes/2.10.5.txt b/Documentation/RelNotes/2.10.5.adoc similarity index 100% rename from Documentation/RelNotes/2.10.5.txt rename to Documentation/RelNotes/2.10.5.adoc diff --git a/Documentation/RelNotes/2.11.0.txt b/Documentation/RelNotes/2.11.0.adoc similarity index 100% rename from Documentation/RelNotes/2.11.0.txt rename to Documentation/RelNotes/2.11.0.adoc diff --git a/Documentation/RelNotes/2.11.1.txt b/Documentation/RelNotes/2.11.1.adoc similarity index 100% rename from Documentation/RelNotes/2.11.1.txt rename to Documentation/RelNotes/2.11.1.adoc diff --git a/Documentation/RelNotes/2.11.2.txt b/Documentation/RelNotes/2.11.2.adoc similarity index 100% rename from Documentation/RelNotes/2.11.2.txt rename to Documentation/RelNotes/2.11.2.adoc diff --git a/Documentation/RelNotes/2.11.3.txt b/Documentation/RelNotes/2.11.3.adoc similarity index 100% rename from Documentation/RelNotes/2.11.3.txt rename to Documentation/RelNotes/2.11.3.adoc diff --git a/Documentation/RelNotes/2.11.4.txt b/Documentation/RelNotes/2.11.4.adoc similarity index 100% rename from Documentation/RelNotes/2.11.4.txt rename to Documentation/RelNotes/2.11.4.adoc diff --git a/Documentation/RelNotes/2.12.0.txt b/Documentation/RelNotes/2.12.0.adoc similarity index 100% rename from Documentation/RelNotes/2.12.0.txt rename to Documentation/RelNotes/2.12.0.adoc diff --git a/Documentation/RelNotes/2.12.1.txt b/Documentation/RelNotes/2.12.1.adoc similarity index 100% rename from Documentation/RelNotes/2.12.1.txt rename to Documentation/RelNotes/2.12.1.adoc diff --git a/Documentation/RelNotes/2.12.2.txt b/Documentation/RelNotes/2.12.2.adoc similarity index 100% rename from Documentation/RelNotes/2.12.2.txt rename to Documentation/RelNotes/2.12.2.adoc diff --git a/Documentation/RelNotes/2.12.3.txt b/Documentation/RelNotes/2.12.3.adoc similarity index 100% rename from Documentation/RelNotes/2.12.3.txt rename to Documentation/RelNotes/2.12.3.adoc diff --git a/Documentation/RelNotes/2.12.4.txt b/Documentation/RelNotes/2.12.4.adoc similarity index 100% rename from Documentation/RelNotes/2.12.4.txt rename to Documentation/RelNotes/2.12.4.adoc diff --git a/Documentation/RelNotes/2.12.5.txt b/Documentation/RelNotes/2.12.5.adoc similarity index 100% rename from Documentation/RelNotes/2.12.5.txt rename to Documentation/RelNotes/2.12.5.adoc diff --git a/Documentation/RelNotes/2.13.0.txt b/Documentation/RelNotes/2.13.0.adoc similarity index 100% rename from Documentation/RelNotes/2.13.0.txt rename to Documentation/RelNotes/2.13.0.adoc diff --git a/Documentation/RelNotes/2.13.1.txt b/Documentation/RelNotes/2.13.1.adoc similarity index 100% rename from Documentation/RelNotes/2.13.1.txt rename to Documentation/RelNotes/2.13.1.adoc diff --git a/Documentation/RelNotes/2.13.2.txt b/Documentation/RelNotes/2.13.2.adoc similarity index 100% rename from Documentation/RelNotes/2.13.2.txt rename to Documentation/RelNotes/2.13.2.adoc diff --git a/Documentation/RelNotes/2.13.3.txt b/Documentation/RelNotes/2.13.3.adoc similarity index 100% rename from Documentation/RelNotes/2.13.3.txt rename to Documentation/RelNotes/2.13.3.adoc diff --git a/Documentation/RelNotes/2.13.4.txt b/Documentation/RelNotes/2.13.4.adoc similarity index 100% rename from Documentation/RelNotes/2.13.4.txt rename to Documentation/RelNotes/2.13.4.adoc diff --git a/Documentation/RelNotes/2.13.5.txt b/Documentation/RelNotes/2.13.5.adoc similarity index 100% rename from Documentation/RelNotes/2.13.5.txt rename to Documentation/RelNotes/2.13.5.adoc diff --git a/Documentation/RelNotes/2.13.6.txt b/Documentation/RelNotes/2.13.6.adoc similarity index 100% rename from Documentation/RelNotes/2.13.6.txt rename to Documentation/RelNotes/2.13.6.adoc diff --git a/Documentation/RelNotes/2.13.7.txt b/Documentation/RelNotes/2.13.7.adoc similarity index 100% rename from Documentation/RelNotes/2.13.7.txt rename to Documentation/RelNotes/2.13.7.adoc diff --git a/Documentation/RelNotes/2.14.0.txt b/Documentation/RelNotes/2.14.0.adoc similarity index 100% rename from Documentation/RelNotes/2.14.0.txt rename to Documentation/RelNotes/2.14.0.adoc diff --git a/Documentation/RelNotes/2.14.1.txt b/Documentation/RelNotes/2.14.1.adoc similarity index 100% rename from Documentation/RelNotes/2.14.1.txt rename to Documentation/RelNotes/2.14.1.adoc diff --git a/Documentation/RelNotes/2.14.2.txt b/Documentation/RelNotes/2.14.2.adoc similarity index 100% rename from Documentation/RelNotes/2.14.2.txt rename to Documentation/RelNotes/2.14.2.adoc diff --git a/Documentation/RelNotes/2.14.3.txt b/Documentation/RelNotes/2.14.3.adoc similarity index 100% rename from Documentation/RelNotes/2.14.3.txt rename to Documentation/RelNotes/2.14.3.adoc diff --git a/Documentation/RelNotes/2.14.4.txt b/Documentation/RelNotes/2.14.4.adoc similarity index 100% rename from Documentation/RelNotes/2.14.4.txt rename to Documentation/RelNotes/2.14.4.adoc diff --git a/Documentation/RelNotes/2.14.5.txt b/Documentation/RelNotes/2.14.5.adoc similarity index 100% rename from Documentation/RelNotes/2.14.5.txt rename to Documentation/RelNotes/2.14.5.adoc diff --git a/Documentation/RelNotes/2.14.6.txt b/Documentation/RelNotes/2.14.6.adoc similarity index 100% rename from Documentation/RelNotes/2.14.6.txt rename to Documentation/RelNotes/2.14.6.adoc diff --git a/Documentation/RelNotes/2.15.0.txt b/Documentation/RelNotes/2.15.0.adoc similarity index 100% rename from Documentation/RelNotes/2.15.0.txt rename to Documentation/RelNotes/2.15.0.adoc diff --git a/Documentation/RelNotes/2.15.1.txt b/Documentation/RelNotes/2.15.1.adoc similarity index 100% rename from Documentation/RelNotes/2.15.1.txt rename to Documentation/RelNotes/2.15.1.adoc diff --git a/Documentation/RelNotes/2.15.2.txt b/Documentation/RelNotes/2.15.2.adoc similarity index 100% rename from Documentation/RelNotes/2.15.2.txt rename to Documentation/RelNotes/2.15.2.adoc diff --git a/Documentation/RelNotes/2.15.3.txt b/Documentation/RelNotes/2.15.3.adoc similarity index 100% rename from Documentation/RelNotes/2.15.3.txt rename to Documentation/RelNotes/2.15.3.adoc diff --git a/Documentation/RelNotes/2.15.4.txt b/Documentation/RelNotes/2.15.4.adoc similarity index 100% rename from Documentation/RelNotes/2.15.4.txt rename to Documentation/RelNotes/2.15.4.adoc diff --git a/Documentation/RelNotes/2.16.0.txt b/Documentation/RelNotes/2.16.0.adoc similarity index 100% rename from Documentation/RelNotes/2.16.0.txt rename to Documentation/RelNotes/2.16.0.adoc diff --git a/Documentation/RelNotes/2.16.1.txt b/Documentation/RelNotes/2.16.1.adoc similarity index 100% rename from Documentation/RelNotes/2.16.1.txt rename to Documentation/RelNotes/2.16.1.adoc diff --git a/Documentation/RelNotes/2.16.2.txt b/Documentation/RelNotes/2.16.2.adoc similarity index 100% rename from Documentation/RelNotes/2.16.2.txt rename to Documentation/RelNotes/2.16.2.adoc diff --git a/Documentation/RelNotes/2.16.3.txt b/Documentation/RelNotes/2.16.3.adoc similarity index 100% rename from Documentation/RelNotes/2.16.3.txt rename to Documentation/RelNotes/2.16.3.adoc diff --git a/Documentation/RelNotes/2.16.4.txt b/Documentation/RelNotes/2.16.4.adoc similarity index 100% rename from Documentation/RelNotes/2.16.4.txt rename to Documentation/RelNotes/2.16.4.adoc diff --git a/Documentation/RelNotes/2.16.5.txt b/Documentation/RelNotes/2.16.5.adoc similarity index 100% rename from Documentation/RelNotes/2.16.5.txt rename to Documentation/RelNotes/2.16.5.adoc diff --git a/Documentation/RelNotes/2.16.6.txt b/Documentation/RelNotes/2.16.6.adoc similarity index 100% rename from Documentation/RelNotes/2.16.6.txt rename to Documentation/RelNotes/2.16.6.adoc diff --git a/Documentation/RelNotes/2.17.0.txt b/Documentation/RelNotes/2.17.0.adoc similarity index 100% rename from Documentation/RelNotes/2.17.0.txt rename to Documentation/RelNotes/2.17.0.adoc diff --git a/Documentation/RelNotes/2.17.1.txt b/Documentation/RelNotes/2.17.1.adoc similarity index 100% rename from Documentation/RelNotes/2.17.1.txt rename to Documentation/RelNotes/2.17.1.adoc diff --git a/Documentation/RelNotes/2.17.2.txt b/Documentation/RelNotes/2.17.2.adoc similarity index 100% rename from Documentation/RelNotes/2.17.2.txt rename to Documentation/RelNotes/2.17.2.adoc diff --git a/Documentation/RelNotes/2.17.3.txt b/Documentation/RelNotes/2.17.3.adoc similarity index 100% rename from Documentation/RelNotes/2.17.3.txt rename to Documentation/RelNotes/2.17.3.adoc diff --git a/Documentation/RelNotes/2.17.4.txt b/Documentation/RelNotes/2.17.4.adoc similarity index 100% rename from Documentation/RelNotes/2.17.4.txt rename to Documentation/RelNotes/2.17.4.adoc diff --git a/Documentation/RelNotes/2.17.5.txt b/Documentation/RelNotes/2.17.5.adoc similarity index 100% rename from Documentation/RelNotes/2.17.5.txt rename to Documentation/RelNotes/2.17.5.adoc diff --git a/Documentation/RelNotes/2.17.6.txt b/Documentation/RelNotes/2.17.6.adoc similarity index 100% rename from Documentation/RelNotes/2.17.6.txt rename to Documentation/RelNotes/2.17.6.adoc diff --git a/Documentation/RelNotes/2.18.0.txt b/Documentation/RelNotes/2.18.0.adoc similarity index 100% rename from Documentation/RelNotes/2.18.0.txt rename to Documentation/RelNotes/2.18.0.adoc diff --git a/Documentation/RelNotes/2.18.1.txt b/Documentation/RelNotes/2.18.1.adoc similarity index 100% rename from Documentation/RelNotes/2.18.1.txt rename to Documentation/RelNotes/2.18.1.adoc diff --git a/Documentation/RelNotes/2.18.2.txt b/Documentation/RelNotes/2.18.2.adoc similarity index 100% rename from Documentation/RelNotes/2.18.2.txt rename to Documentation/RelNotes/2.18.2.adoc diff --git a/Documentation/RelNotes/2.18.3.txt b/Documentation/RelNotes/2.18.3.adoc similarity index 100% rename from Documentation/RelNotes/2.18.3.txt rename to Documentation/RelNotes/2.18.3.adoc diff --git a/Documentation/RelNotes/2.18.4.txt b/Documentation/RelNotes/2.18.4.adoc similarity index 100% rename from Documentation/RelNotes/2.18.4.txt rename to Documentation/RelNotes/2.18.4.adoc diff --git a/Documentation/RelNotes/2.18.5.txt b/Documentation/RelNotes/2.18.5.adoc similarity index 100% rename from Documentation/RelNotes/2.18.5.txt rename to Documentation/RelNotes/2.18.5.adoc diff --git a/Documentation/RelNotes/2.19.0.txt b/Documentation/RelNotes/2.19.0.adoc similarity index 100% rename from Documentation/RelNotes/2.19.0.txt rename to Documentation/RelNotes/2.19.0.adoc diff --git a/Documentation/RelNotes/2.19.1.txt b/Documentation/RelNotes/2.19.1.adoc similarity index 100% rename from Documentation/RelNotes/2.19.1.txt rename to Documentation/RelNotes/2.19.1.adoc diff --git a/Documentation/RelNotes/2.19.2.txt b/Documentation/RelNotes/2.19.2.adoc similarity index 100% rename from Documentation/RelNotes/2.19.2.txt rename to Documentation/RelNotes/2.19.2.adoc diff --git a/Documentation/RelNotes/2.19.3.txt b/Documentation/RelNotes/2.19.3.adoc similarity index 100% rename from Documentation/RelNotes/2.19.3.txt rename to Documentation/RelNotes/2.19.3.adoc diff --git a/Documentation/RelNotes/2.19.4.txt b/Documentation/RelNotes/2.19.4.adoc similarity index 100% rename from Documentation/RelNotes/2.19.4.txt rename to Documentation/RelNotes/2.19.4.adoc diff --git a/Documentation/RelNotes/2.19.5.txt b/Documentation/RelNotes/2.19.5.adoc similarity index 100% rename from Documentation/RelNotes/2.19.5.txt rename to Documentation/RelNotes/2.19.5.adoc diff --git a/Documentation/RelNotes/2.19.6.txt b/Documentation/RelNotes/2.19.6.adoc similarity index 100% rename from Documentation/RelNotes/2.19.6.txt rename to Documentation/RelNotes/2.19.6.adoc diff --git a/Documentation/RelNotes/2.2.0.txt b/Documentation/RelNotes/2.2.0.adoc similarity index 100% rename from Documentation/RelNotes/2.2.0.txt rename to Documentation/RelNotes/2.2.0.adoc diff --git a/Documentation/RelNotes/2.2.1.txt b/Documentation/RelNotes/2.2.1.adoc similarity index 100% rename from Documentation/RelNotes/2.2.1.txt rename to Documentation/RelNotes/2.2.1.adoc diff --git a/Documentation/RelNotes/2.2.2.txt b/Documentation/RelNotes/2.2.2.adoc similarity index 100% rename from Documentation/RelNotes/2.2.2.txt rename to Documentation/RelNotes/2.2.2.adoc diff --git a/Documentation/RelNotes/2.2.3.txt b/Documentation/RelNotes/2.2.3.adoc similarity index 100% rename from Documentation/RelNotes/2.2.3.txt rename to Documentation/RelNotes/2.2.3.adoc diff --git a/Documentation/RelNotes/2.20.0.txt b/Documentation/RelNotes/2.20.0.adoc similarity index 100% rename from Documentation/RelNotes/2.20.0.txt rename to Documentation/RelNotes/2.20.0.adoc diff --git a/Documentation/RelNotes/2.20.1.txt b/Documentation/RelNotes/2.20.1.adoc similarity index 100% rename from Documentation/RelNotes/2.20.1.txt rename to Documentation/RelNotes/2.20.1.adoc diff --git a/Documentation/RelNotes/2.20.2.txt b/Documentation/RelNotes/2.20.2.adoc similarity index 100% rename from Documentation/RelNotes/2.20.2.txt rename to Documentation/RelNotes/2.20.2.adoc diff --git a/Documentation/RelNotes/2.20.3.txt b/Documentation/RelNotes/2.20.3.adoc similarity index 100% rename from Documentation/RelNotes/2.20.3.txt rename to Documentation/RelNotes/2.20.3.adoc diff --git a/Documentation/RelNotes/2.20.4.txt b/Documentation/RelNotes/2.20.4.adoc similarity index 100% rename from Documentation/RelNotes/2.20.4.txt rename to Documentation/RelNotes/2.20.4.adoc diff --git a/Documentation/RelNotes/2.20.5.txt b/Documentation/RelNotes/2.20.5.adoc similarity index 100% rename from Documentation/RelNotes/2.20.5.txt rename to Documentation/RelNotes/2.20.5.adoc diff --git a/Documentation/RelNotes/2.21.0.txt b/Documentation/RelNotes/2.21.0.adoc similarity index 100% rename from Documentation/RelNotes/2.21.0.txt rename to Documentation/RelNotes/2.21.0.adoc diff --git a/Documentation/RelNotes/2.21.1.txt b/Documentation/RelNotes/2.21.1.adoc similarity index 100% rename from Documentation/RelNotes/2.21.1.txt rename to Documentation/RelNotes/2.21.1.adoc diff --git a/Documentation/RelNotes/2.21.2.txt b/Documentation/RelNotes/2.21.2.adoc similarity index 100% rename from Documentation/RelNotes/2.21.2.txt rename to Documentation/RelNotes/2.21.2.adoc diff --git a/Documentation/RelNotes/2.21.3.txt b/Documentation/RelNotes/2.21.3.adoc similarity index 100% rename from Documentation/RelNotes/2.21.3.txt rename to Documentation/RelNotes/2.21.3.adoc diff --git a/Documentation/RelNotes/2.21.4.txt b/Documentation/RelNotes/2.21.4.adoc similarity index 100% rename from Documentation/RelNotes/2.21.4.txt rename to Documentation/RelNotes/2.21.4.adoc diff --git a/Documentation/RelNotes/2.22.0.txt b/Documentation/RelNotes/2.22.0.adoc similarity index 100% rename from Documentation/RelNotes/2.22.0.txt rename to Documentation/RelNotes/2.22.0.adoc diff --git a/Documentation/RelNotes/2.22.1.txt b/Documentation/RelNotes/2.22.1.adoc similarity index 100% rename from Documentation/RelNotes/2.22.1.txt rename to Documentation/RelNotes/2.22.1.adoc diff --git a/Documentation/RelNotes/2.22.2.txt b/Documentation/RelNotes/2.22.2.adoc similarity index 100% rename from Documentation/RelNotes/2.22.2.txt rename to Documentation/RelNotes/2.22.2.adoc diff --git a/Documentation/RelNotes/2.22.3.txt b/Documentation/RelNotes/2.22.3.adoc similarity index 100% rename from Documentation/RelNotes/2.22.3.txt rename to Documentation/RelNotes/2.22.3.adoc diff --git a/Documentation/RelNotes/2.22.4.txt b/Documentation/RelNotes/2.22.4.adoc similarity index 100% rename from Documentation/RelNotes/2.22.4.txt rename to Documentation/RelNotes/2.22.4.adoc diff --git a/Documentation/RelNotes/2.22.5.txt b/Documentation/RelNotes/2.22.5.adoc similarity index 100% rename from Documentation/RelNotes/2.22.5.txt rename to Documentation/RelNotes/2.22.5.adoc diff --git a/Documentation/RelNotes/2.23.0.txt b/Documentation/RelNotes/2.23.0.adoc similarity index 100% rename from Documentation/RelNotes/2.23.0.txt rename to Documentation/RelNotes/2.23.0.adoc diff --git a/Documentation/RelNotes/2.23.1.txt b/Documentation/RelNotes/2.23.1.adoc similarity index 100% rename from Documentation/RelNotes/2.23.1.txt rename to Documentation/RelNotes/2.23.1.adoc diff --git a/Documentation/RelNotes/2.23.2.txt b/Documentation/RelNotes/2.23.2.adoc similarity index 100% rename from Documentation/RelNotes/2.23.2.txt rename to Documentation/RelNotes/2.23.2.adoc diff --git a/Documentation/RelNotes/2.23.3.txt b/Documentation/RelNotes/2.23.3.adoc similarity index 100% rename from Documentation/RelNotes/2.23.3.txt rename to Documentation/RelNotes/2.23.3.adoc diff --git a/Documentation/RelNotes/2.23.4.txt b/Documentation/RelNotes/2.23.4.adoc similarity index 100% rename from Documentation/RelNotes/2.23.4.txt rename to Documentation/RelNotes/2.23.4.adoc diff --git a/Documentation/RelNotes/2.24.0.txt b/Documentation/RelNotes/2.24.0.adoc similarity index 100% rename from Documentation/RelNotes/2.24.0.txt rename to Documentation/RelNotes/2.24.0.adoc diff --git a/Documentation/RelNotes/2.24.1.txt b/Documentation/RelNotes/2.24.1.adoc similarity index 100% rename from Documentation/RelNotes/2.24.1.txt rename to Documentation/RelNotes/2.24.1.adoc diff --git a/Documentation/RelNotes/2.24.2.txt b/Documentation/RelNotes/2.24.2.adoc similarity index 100% rename from Documentation/RelNotes/2.24.2.txt rename to Documentation/RelNotes/2.24.2.adoc diff --git a/Documentation/RelNotes/2.24.3.txt b/Documentation/RelNotes/2.24.3.adoc similarity index 100% rename from Documentation/RelNotes/2.24.3.txt rename to Documentation/RelNotes/2.24.3.adoc diff --git a/Documentation/RelNotes/2.24.4.txt b/Documentation/RelNotes/2.24.4.adoc similarity index 100% rename from Documentation/RelNotes/2.24.4.txt rename to Documentation/RelNotes/2.24.4.adoc diff --git a/Documentation/RelNotes/2.25.0.txt b/Documentation/RelNotes/2.25.0.adoc similarity index 100% rename from Documentation/RelNotes/2.25.0.txt rename to Documentation/RelNotes/2.25.0.adoc diff --git a/Documentation/RelNotes/2.25.1.txt b/Documentation/RelNotes/2.25.1.adoc similarity index 100% rename from Documentation/RelNotes/2.25.1.txt rename to Documentation/RelNotes/2.25.1.adoc diff --git a/Documentation/RelNotes/2.25.2.txt b/Documentation/RelNotes/2.25.2.adoc similarity index 100% rename from Documentation/RelNotes/2.25.2.txt rename to Documentation/RelNotes/2.25.2.adoc diff --git a/Documentation/RelNotes/2.25.3.txt b/Documentation/RelNotes/2.25.3.adoc similarity index 100% rename from Documentation/RelNotes/2.25.3.txt rename to Documentation/RelNotes/2.25.3.adoc diff --git a/Documentation/RelNotes/2.25.4.txt b/Documentation/RelNotes/2.25.4.adoc similarity index 100% rename from Documentation/RelNotes/2.25.4.txt rename to Documentation/RelNotes/2.25.4.adoc diff --git a/Documentation/RelNotes/2.25.5.txt b/Documentation/RelNotes/2.25.5.adoc similarity index 100% rename from Documentation/RelNotes/2.25.5.txt rename to Documentation/RelNotes/2.25.5.adoc diff --git a/Documentation/RelNotes/2.26.0.txt b/Documentation/RelNotes/2.26.0.adoc similarity index 100% rename from Documentation/RelNotes/2.26.0.txt rename to Documentation/RelNotes/2.26.0.adoc diff --git a/Documentation/RelNotes/2.26.1.txt b/Documentation/RelNotes/2.26.1.adoc similarity index 100% rename from Documentation/RelNotes/2.26.1.txt rename to Documentation/RelNotes/2.26.1.adoc diff --git a/Documentation/RelNotes/2.26.2.txt b/Documentation/RelNotes/2.26.2.adoc similarity index 100% rename from Documentation/RelNotes/2.26.2.txt rename to Documentation/RelNotes/2.26.2.adoc diff --git a/Documentation/RelNotes/2.26.3.txt b/Documentation/RelNotes/2.26.3.adoc similarity index 100% rename from Documentation/RelNotes/2.26.3.txt rename to Documentation/RelNotes/2.26.3.adoc diff --git a/Documentation/RelNotes/2.27.0.txt b/Documentation/RelNotes/2.27.0.adoc similarity index 100% rename from Documentation/RelNotes/2.27.0.txt rename to Documentation/RelNotes/2.27.0.adoc diff --git a/Documentation/RelNotes/2.27.1.txt b/Documentation/RelNotes/2.27.1.adoc similarity index 100% rename from Documentation/RelNotes/2.27.1.txt rename to Documentation/RelNotes/2.27.1.adoc diff --git a/Documentation/RelNotes/2.28.0.txt b/Documentation/RelNotes/2.28.0.adoc similarity index 100% rename from Documentation/RelNotes/2.28.0.txt rename to Documentation/RelNotes/2.28.0.adoc diff --git a/Documentation/RelNotes/2.28.1.txt b/Documentation/RelNotes/2.28.1.adoc similarity index 100% rename from Documentation/RelNotes/2.28.1.txt rename to Documentation/RelNotes/2.28.1.adoc diff --git a/Documentation/RelNotes/2.29.0.txt b/Documentation/RelNotes/2.29.0.adoc similarity index 100% rename from Documentation/RelNotes/2.29.0.txt rename to Documentation/RelNotes/2.29.0.adoc diff --git a/Documentation/RelNotes/2.29.1.txt b/Documentation/RelNotes/2.29.1.adoc similarity index 100% rename from Documentation/RelNotes/2.29.1.txt rename to Documentation/RelNotes/2.29.1.adoc diff --git a/Documentation/RelNotes/2.29.2.txt b/Documentation/RelNotes/2.29.2.adoc similarity index 100% rename from Documentation/RelNotes/2.29.2.txt rename to Documentation/RelNotes/2.29.2.adoc diff --git a/Documentation/RelNotes/2.29.3.txt b/Documentation/RelNotes/2.29.3.adoc similarity index 100% rename from Documentation/RelNotes/2.29.3.txt rename to Documentation/RelNotes/2.29.3.adoc diff --git a/Documentation/RelNotes/2.3.0.txt b/Documentation/RelNotes/2.3.0.adoc similarity index 100% rename from Documentation/RelNotes/2.3.0.txt rename to Documentation/RelNotes/2.3.0.adoc diff --git a/Documentation/RelNotes/2.3.1.txt b/Documentation/RelNotes/2.3.1.adoc similarity index 100% rename from Documentation/RelNotes/2.3.1.txt rename to Documentation/RelNotes/2.3.1.adoc diff --git a/Documentation/RelNotes/2.3.10.txt b/Documentation/RelNotes/2.3.10.adoc similarity index 100% rename from Documentation/RelNotes/2.3.10.txt rename to Documentation/RelNotes/2.3.10.adoc diff --git a/Documentation/RelNotes/2.3.2.txt b/Documentation/RelNotes/2.3.2.adoc similarity index 100% rename from Documentation/RelNotes/2.3.2.txt rename to Documentation/RelNotes/2.3.2.adoc diff --git a/Documentation/RelNotes/2.3.3.txt b/Documentation/RelNotes/2.3.3.adoc similarity index 100% rename from Documentation/RelNotes/2.3.3.txt rename to Documentation/RelNotes/2.3.3.adoc diff --git a/Documentation/RelNotes/2.3.4.txt b/Documentation/RelNotes/2.3.4.adoc similarity index 100% rename from Documentation/RelNotes/2.3.4.txt rename to Documentation/RelNotes/2.3.4.adoc diff --git a/Documentation/RelNotes/2.3.5.txt b/Documentation/RelNotes/2.3.5.adoc similarity index 100% rename from Documentation/RelNotes/2.3.5.txt rename to Documentation/RelNotes/2.3.5.adoc diff --git a/Documentation/RelNotes/2.3.6.txt b/Documentation/RelNotes/2.3.6.adoc similarity index 100% rename from Documentation/RelNotes/2.3.6.txt rename to Documentation/RelNotes/2.3.6.adoc diff --git a/Documentation/RelNotes/2.3.7.txt b/Documentation/RelNotes/2.3.7.adoc similarity index 100% rename from Documentation/RelNotes/2.3.7.txt rename to Documentation/RelNotes/2.3.7.adoc diff --git a/Documentation/RelNotes/2.3.8.txt b/Documentation/RelNotes/2.3.8.adoc similarity index 100% rename from Documentation/RelNotes/2.3.8.txt rename to Documentation/RelNotes/2.3.8.adoc diff --git a/Documentation/RelNotes/2.3.9.txt b/Documentation/RelNotes/2.3.9.adoc similarity index 100% rename from Documentation/RelNotes/2.3.9.txt rename to Documentation/RelNotes/2.3.9.adoc diff --git a/Documentation/RelNotes/2.30.0.txt b/Documentation/RelNotes/2.30.0.adoc similarity index 100% rename from Documentation/RelNotes/2.30.0.txt rename to Documentation/RelNotes/2.30.0.adoc diff --git a/Documentation/RelNotes/2.30.1.txt b/Documentation/RelNotes/2.30.1.adoc similarity index 100% rename from Documentation/RelNotes/2.30.1.txt rename to Documentation/RelNotes/2.30.1.adoc diff --git a/Documentation/RelNotes/2.30.2.txt b/Documentation/RelNotes/2.30.2.adoc similarity index 100% rename from Documentation/RelNotes/2.30.2.txt rename to Documentation/RelNotes/2.30.2.adoc diff --git a/Documentation/RelNotes/2.30.3.txt b/Documentation/RelNotes/2.30.3.adoc similarity index 100% rename from Documentation/RelNotes/2.30.3.txt rename to Documentation/RelNotes/2.30.3.adoc diff --git a/Documentation/RelNotes/2.30.4.txt b/Documentation/RelNotes/2.30.4.adoc similarity index 100% rename from Documentation/RelNotes/2.30.4.txt rename to Documentation/RelNotes/2.30.4.adoc diff --git a/Documentation/RelNotes/2.30.5.txt b/Documentation/RelNotes/2.30.5.adoc similarity index 100% rename from Documentation/RelNotes/2.30.5.txt rename to Documentation/RelNotes/2.30.5.adoc diff --git a/Documentation/RelNotes/2.30.6.txt b/Documentation/RelNotes/2.30.6.adoc similarity index 100% rename from Documentation/RelNotes/2.30.6.txt rename to Documentation/RelNotes/2.30.6.adoc diff --git a/Documentation/RelNotes/2.30.7.txt b/Documentation/RelNotes/2.30.7.adoc similarity index 100% rename from Documentation/RelNotes/2.30.7.txt rename to Documentation/RelNotes/2.30.7.adoc diff --git a/Documentation/RelNotes/2.30.8.txt b/Documentation/RelNotes/2.30.8.adoc similarity index 100% rename from Documentation/RelNotes/2.30.8.txt rename to Documentation/RelNotes/2.30.8.adoc diff --git a/Documentation/RelNotes/2.30.9.txt b/Documentation/RelNotes/2.30.9.adoc similarity index 100% rename from Documentation/RelNotes/2.30.9.txt rename to Documentation/RelNotes/2.30.9.adoc diff --git a/Documentation/RelNotes/2.31.0.txt b/Documentation/RelNotes/2.31.0.adoc similarity index 100% rename from Documentation/RelNotes/2.31.0.txt rename to Documentation/RelNotes/2.31.0.adoc diff --git a/Documentation/RelNotes/2.31.1.txt b/Documentation/RelNotes/2.31.1.adoc similarity index 100% rename from Documentation/RelNotes/2.31.1.txt rename to Documentation/RelNotes/2.31.1.adoc diff --git a/Documentation/RelNotes/2.31.2.txt b/Documentation/RelNotes/2.31.2.adoc similarity index 100% rename from Documentation/RelNotes/2.31.2.txt rename to Documentation/RelNotes/2.31.2.adoc diff --git a/Documentation/RelNotes/2.31.3.txt b/Documentation/RelNotes/2.31.3.adoc similarity index 100% rename from Documentation/RelNotes/2.31.3.txt rename to Documentation/RelNotes/2.31.3.adoc diff --git a/Documentation/RelNotes/2.31.4.txt b/Documentation/RelNotes/2.31.4.adoc similarity index 100% rename from Documentation/RelNotes/2.31.4.txt rename to Documentation/RelNotes/2.31.4.adoc diff --git a/Documentation/RelNotes/2.31.5.txt b/Documentation/RelNotes/2.31.5.adoc similarity index 100% rename from Documentation/RelNotes/2.31.5.txt rename to Documentation/RelNotes/2.31.5.adoc diff --git a/Documentation/RelNotes/2.31.6.txt b/Documentation/RelNotes/2.31.6.adoc similarity index 100% rename from Documentation/RelNotes/2.31.6.txt rename to Documentation/RelNotes/2.31.6.adoc diff --git a/Documentation/RelNotes/2.31.7.txt b/Documentation/RelNotes/2.31.7.adoc similarity index 100% rename from Documentation/RelNotes/2.31.7.txt rename to Documentation/RelNotes/2.31.7.adoc diff --git a/Documentation/RelNotes/2.31.8.txt b/Documentation/RelNotes/2.31.8.adoc similarity index 100% rename from Documentation/RelNotes/2.31.8.txt rename to Documentation/RelNotes/2.31.8.adoc diff --git a/Documentation/RelNotes/2.32.0.txt b/Documentation/RelNotes/2.32.0.adoc similarity index 100% rename from Documentation/RelNotes/2.32.0.txt rename to Documentation/RelNotes/2.32.0.adoc diff --git a/Documentation/RelNotes/2.32.1.txt b/Documentation/RelNotes/2.32.1.adoc similarity index 100% rename from Documentation/RelNotes/2.32.1.txt rename to Documentation/RelNotes/2.32.1.adoc diff --git a/Documentation/RelNotes/2.32.2.txt b/Documentation/RelNotes/2.32.2.adoc similarity index 100% rename from Documentation/RelNotes/2.32.2.txt rename to Documentation/RelNotes/2.32.2.adoc diff --git a/Documentation/RelNotes/2.32.3.txt b/Documentation/RelNotes/2.32.3.adoc similarity index 100% rename from Documentation/RelNotes/2.32.3.txt rename to Documentation/RelNotes/2.32.3.adoc diff --git a/Documentation/RelNotes/2.32.4.txt b/Documentation/RelNotes/2.32.4.adoc similarity index 100% rename from Documentation/RelNotes/2.32.4.txt rename to Documentation/RelNotes/2.32.4.adoc diff --git a/Documentation/RelNotes/2.32.5.txt b/Documentation/RelNotes/2.32.5.adoc similarity index 100% rename from Documentation/RelNotes/2.32.5.txt rename to Documentation/RelNotes/2.32.5.adoc diff --git a/Documentation/RelNotes/2.32.6.txt b/Documentation/RelNotes/2.32.6.adoc similarity index 100% rename from Documentation/RelNotes/2.32.6.txt rename to Documentation/RelNotes/2.32.6.adoc diff --git a/Documentation/RelNotes/2.32.7.txt b/Documentation/RelNotes/2.32.7.adoc similarity index 100% rename from Documentation/RelNotes/2.32.7.txt rename to Documentation/RelNotes/2.32.7.adoc diff --git a/Documentation/RelNotes/2.33.0.txt b/Documentation/RelNotes/2.33.0.adoc similarity index 100% rename from Documentation/RelNotes/2.33.0.txt rename to Documentation/RelNotes/2.33.0.adoc diff --git a/Documentation/RelNotes/2.33.1.txt b/Documentation/RelNotes/2.33.1.adoc similarity index 100% rename from Documentation/RelNotes/2.33.1.txt rename to Documentation/RelNotes/2.33.1.adoc diff --git a/Documentation/RelNotes/2.33.2.txt b/Documentation/RelNotes/2.33.2.adoc similarity index 100% rename from Documentation/RelNotes/2.33.2.txt rename to Documentation/RelNotes/2.33.2.adoc diff --git a/Documentation/RelNotes/2.33.3.txt b/Documentation/RelNotes/2.33.3.adoc similarity index 100% rename from Documentation/RelNotes/2.33.3.txt rename to Documentation/RelNotes/2.33.3.adoc diff --git a/Documentation/RelNotes/2.33.4.txt b/Documentation/RelNotes/2.33.4.adoc similarity index 100% rename from Documentation/RelNotes/2.33.4.txt rename to Documentation/RelNotes/2.33.4.adoc diff --git a/Documentation/RelNotes/2.33.5.txt b/Documentation/RelNotes/2.33.5.adoc similarity index 100% rename from Documentation/RelNotes/2.33.5.txt rename to Documentation/RelNotes/2.33.5.adoc diff --git a/Documentation/RelNotes/2.33.6.txt b/Documentation/RelNotes/2.33.6.adoc similarity index 100% rename from Documentation/RelNotes/2.33.6.txt rename to Documentation/RelNotes/2.33.6.adoc diff --git a/Documentation/RelNotes/2.33.7.txt b/Documentation/RelNotes/2.33.7.adoc similarity index 100% rename from Documentation/RelNotes/2.33.7.txt rename to Documentation/RelNotes/2.33.7.adoc diff --git a/Documentation/RelNotes/2.33.8.txt b/Documentation/RelNotes/2.33.8.adoc similarity index 100% rename from Documentation/RelNotes/2.33.8.txt rename to Documentation/RelNotes/2.33.8.adoc diff --git a/Documentation/RelNotes/2.34.0.txt b/Documentation/RelNotes/2.34.0.adoc similarity index 100% rename from Documentation/RelNotes/2.34.0.txt rename to Documentation/RelNotes/2.34.0.adoc diff --git a/Documentation/RelNotes/2.34.1.txt b/Documentation/RelNotes/2.34.1.adoc similarity index 100% rename from Documentation/RelNotes/2.34.1.txt rename to Documentation/RelNotes/2.34.1.adoc diff --git a/Documentation/RelNotes/2.34.2.txt b/Documentation/RelNotes/2.34.2.adoc similarity index 100% rename from Documentation/RelNotes/2.34.2.txt rename to Documentation/RelNotes/2.34.2.adoc diff --git a/Documentation/RelNotes/2.34.3.txt b/Documentation/RelNotes/2.34.3.adoc similarity index 100% rename from Documentation/RelNotes/2.34.3.txt rename to Documentation/RelNotes/2.34.3.adoc diff --git a/Documentation/RelNotes/2.34.4.txt b/Documentation/RelNotes/2.34.4.adoc similarity index 100% rename from Documentation/RelNotes/2.34.4.txt rename to Documentation/RelNotes/2.34.4.adoc diff --git a/Documentation/RelNotes/2.34.5.txt b/Documentation/RelNotes/2.34.5.adoc similarity index 100% rename from Documentation/RelNotes/2.34.5.txt rename to Documentation/RelNotes/2.34.5.adoc diff --git a/Documentation/RelNotes/2.34.6.txt b/Documentation/RelNotes/2.34.6.adoc similarity index 100% rename from Documentation/RelNotes/2.34.6.txt rename to Documentation/RelNotes/2.34.6.adoc diff --git a/Documentation/RelNotes/2.34.7.txt b/Documentation/RelNotes/2.34.7.adoc similarity index 100% rename from Documentation/RelNotes/2.34.7.txt rename to Documentation/RelNotes/2.34.7.adoc diff --git a/Documentation/RelNotes/2.34.8.txt b/Documentation/RelNotes/2.34.8.adoc similarity index 100% rename from Documentation/RelNotes/2.34.8.txt rename to Documentation/RelNotes/2.34.8.adoc diff --git a/Documentation/RelNotes/2.35.0.txt b/Documentation/RelNotes/2.35.0.adoc similarity index 100% rename from Documentation/RelNotes/2.35.0.txt rename to Documentation/RelNotes/2.35.0.adoc diff --git a/Documentation/RelNotes/2.35.1.txt b/Documentation/RelNotes/2.35.1.adoc similarity index 100% rename from Documentation/RelNotes/2.35.1.txt rename to Documentation/RelNotes/2.35.1.adoc diff --git a/Documentation/RelNotes/2.35.2.txt b/Documentation/RelNotes/2.35.2.adoc similarity index 100% rename from Documentation/RelNotes/2.35.2.txt rename to Documentation/RelNotes/2.35.2.adoc diff --git a/Documentation/RelNotes/2.35.3.txt b/Documentation/RelNotes/2.35.3.adoc similarity index 100% rename from Documentation/RelNotes/2.35.3.txt rename to Documentation/RelNotes/2.35.3.adoc diff --git a/Documentation/RelNotes/2.35.4.txt b/Documentation/RelNotes/2.35.4.adoc similarity index 100% rename from Documentation/RelNotes/2.35.4.txt rename to Documentation/RelNotes/2.35.4.adoc diff --git a/Documentation/RelNotes/2.35.5.txt b/Documentation/RelNotes/2.35.5.adoc similarity index 100% rename from Documentation/RelNotes/2.35.5.txt rename to Documentation/RelNotes/2.35.5.adoc diff --git a/Documentation/RelNotes/2.35.6.txt b/Documentation/RelNotes/2.35.6.adoc similarity index 100% rename from Documentation/RelNotes/2.35.6.txt rename to Documentation/RelNotes/2.35.6.adoc diff --git a/Documentation/RelNotes/2.35.7.txt b/Documentation/RelNotes/2.35.7.adoc similarity index 100% rename from Documentation/RelNotes/2.35.7.txt rename to Documentation/RelNotes/2.35.7.adoc diff --git a/Documentation/RelNotes/2.35.8.txt b/Documentation/RelNotes/2.35.8.adoc similarity index 100% rename from Documentation/RelNotes/2.35.8.txt rename to Documentation/RelNotes/2.35.8.adoc diff --git a/Documentation/RelNotes/2.36.0.txt b/Documentation/RelNotes/2.36.0.adoc similarity index 100% rename from Documentation/RelNotes/2.36.0.txt rename to Documentation/RelNotes/2.36.0.adoc diff --git a/Documentation/RelNotes/2.36.1.txt b/Documentation/RelNotes/2.36.1.adoc similarity index 100% rename from Documentation/RelNotes/2.36.1.txt rename to Documentation/RelNotes/2.36.1.adoc diff --git a/Documentation/RelNotes/2.36.2.txt b/Documentation/RelNotes/2.36.2.adoc similarity index 100% rename from Documentation/RelNotes/2.36.2.txt rename to Documentation/RelNotes/2.36.2.adoc diff --git a/Documentation/RelNotes/2.36.3.txt b/Documentation/RelNotes/2.36.3.adoc similarity index 100% rename from Documentation/RelNotes/2.36.3.txt rename to Documentation/RelNotes/2.36.3.adoc diff --git a/Documentation/RelNotes/2.36.4.txt b/Documentation/RelNotes/2.36.4.adoc similarity index 100% rename from Documentation/RelNotes/2.36.4.txt rename to Documentation/RelNotes/2.36.4.adoc diff --git a/Documentation/RelNotes/2.36.5.txt b/Documentation/RelNotes/2.36.5.adoc similarity index 100% rename from Documentation/RelNotes/2.36.5.txt rename to Documentation/RelNotes/2.36.5.adoc diff --git a/Documentation/RelNotes/2.36.6.txt b/Documentation/RelNotes/2.36.6.adoc similarity index 100% rename from Documentation/RelNotes/2.36.6.txt rename to Documentation/RelNotes/2.36.6.adoc diff --git a/Documentation/RelNotes/2.37.0.txt b/Documentation/RelNotes/2.37.0.adoc similarity index 100% rename from Documentation/RelNotes/2.37.0.txt rename to Documentation/RelNotes/2.37.0.adoc diff --git a/Documentation/RelNotes/2.37.1.txt b/Documentation/RelNotes/2.37.1.adoc similarity index 100% rename from Documentation/RelNotes/2.37.1.txt rename to Documentation/RelNotes/2.37.1.adoc diff --git a/Documentation/RelNotes/2.37.2.txt b/Documentation/RelNotes/2.37.2.adoc similarity index 100% rename from Documentation/RelNotes/2.37.2.txt rename to Documentation/RelNotes/2.37.2.adoc diff --git a/Documentation/RelNotes/2.37.3.txt b/Documentation/RelNotes/2.37.3.adoc similarity index 100% rename from Documentation/RelNotes/2.37.3.txt rename to Documentation/RelNotes/2.37.3.adoc diff --git a/Documentation/RelNotes/2.37.4.txt b/Documentation/RelNotes/2.37.4.adoc similarity index 100% rename from Documentation/RelNotes/2.37.4.txt rename to Documentation/RelNotes/2.37.4.adoc diff --git a/Documentation/RelNotes/2.37.5.txt b/Documentation/RelNotes/2.37.5.adoc similarity index 100% rename from Documentation/RelNotes/2.37.5.txt rename to Documentation/RelNotes/2.37.5.adoc diff --git a/Documentation/RelNotes/2.37.6.txt b/Documentation/RelNotes/2.37.6.adoc similarity index 100% rename from Documentation/RelNotes/2.37.6.txt rename to Documentation/RelNotes/2.37.6.adoc diff --git a/Documentation/RelNotes/2.37.7.txt b/Documentation/RelNotes/2.37.7.adoc similarity index 100% rename from Documentation/RelNotes/2.37.7.txt rename to Documentation/RelNotes/2.37.7.adoc diff --git a/Documentation/RelNotes/2.38.0.txt b/Documentation/RelNotes/2.38.0.adoc similarity index 100% rename from Documentation/RelNotes/2.38.0.txt rename to Documentation/RelNotes/2.38.0.adoc diff --git a/Documentation/RelNotes/2.38.1.txt b/Documentation/RelNotes/2.38.1.adoc similarity index 100% rename from Documentation/RelNotes/2.38.1.txt rename to Documentation/RelNotes/2.38.1.adoc diff --git a/Documentation/RelNotes/2.38.2.txt b/Documentation/RelNotes/2.38.2.adoc similarity index 100% rename from Documentation/RelNotes/2.38.2.txt rename to Documentation/RelNotes/2.38.2.adoc diff --git a/Documentation/RelNotes/2.38.3.txt b/Documentation/RelNotes/2.38.3.adoc similarity index 100% rename from Documentation/RelNotes/2.38.3.txt rename to Documentation/RelNotes/2.38.3.adoc diff --git a/Documentation/RelNotes/2.38.4.txt b/Documentation/RelNotes/2.38.4.adoc similarity index 100% rename from Documentation/RelNotes/2.38.4.txt rename to Documentation/RelNotes/2.38.4.adoc diff --git a/Documentation/RelNotes/2.38.5.txt b/Documentation/RelNotes/2.38.5.adoc similarity index 100% rename from Documentation/RelNotes/2.38.5.txt rename to Documentation/RelNotes/2.38.5.adoc diff --git a/Documentation/RelNotes/2.39.0.txt b/Documentation/RelNotes/2.39.0.adoc similarity index 100% rename from Documentation/RelNotes/2.39.0.txt rename to Documentation/RelNotes/2.39.0.adoc diff --git a/Documentation/RelNotes/2.39.1.txt b/Documentation/RelNotes/2.39.1.adoc similarity index 100% rename from Documentation/RelNotes/2.39.1.txt rename to Documentation/RelNotes/2.39.1.adoc diff --git a/Documentation/RelNotes/2.39.2.txt b/Documentation/RelNotes/2.39.2.adoc similarity index 100% rename from Documentation/RelNotes/2.39.2.txt rename to Documentation/RelNotes/2.39.2.adoc diff --git a/Documentation/RelNotes/2.39.3.txt b/Documentation/RelNotes/2.39.3.adoc similarity index 100% rename from Documentation/RelNotes/2.39.3.txt rename to Documentation/RelNotes/2.39.3.adoc diff --git a/Documentation/RelNotes/2.39.4.txt b/Documentation/RelNotes/2.39.4.adoc similarity index 100% rename from Documentation/RelNotes/2.39.4.txt rename to Documentation/RelNotes/2.39.4.adoc diff --git a/Documentation/RelNotes/2.39.5.txt b/Documentation/RelNotes/2.39.5.adoc similarity index 100% rename from Documentation/RelNotes/2.39.5.txt rename to Documentation/RelNotes/2.39.5.adoc diff --git a/Documentation/RelNotes/2.4.0.txt b/Documentation/RelNotes/2.4.0.adoc similarity index 100% rename from Documentation/RelNotes/2.4.0.txt rename to Documentation/RelNotes/2.4.0.adoc diff --git a/Documentation/RelNotes/2.4.1.txt b/Documentation/RelNotes/2.4.1.adoc similarity index 100% rename from Documentation/RelNotes/2.4.1.txt rename to Documentation/RelNotes/2.4.1.adoc diff --git a/Documentation/RelNotes/2.4.10.txt b/Documentation/RelNotes/2.4.10.adoc similarity index 100% rename from Documentation/RelNotes/2.4.10.txt rename to Documentation/RelNotes/2.4.10.adoc diff --git a/Documentation/RelNotes/2.4.11.txt b/Documentation/RelNotes/2.4.11.adoc similarity index 100% rename from Documentation/RelNotes/2.4.11.txt rename to Documentation/RelNotes/2.4.11.adoc diff --git a/Documentation/RelNotes/2.4.12.txt b/Documentation/RelNotes/2.4.12.adoc similarity index 100% rename from Documentation/RelNotes/2.4.12.txt rename to Documentation/RelNotes/2.4.12.adoc diff --git a/Documentation/RelNotes/2.4.2.txt b/Documentation/RelNotes/2.4.2.adoc similarity index 100% rename from Documentation/RelNotes/2.4.2.txt rename to Documentation/RelNotes/2.4.2.adoc diff --git a/Documentation/RelNotes/2.4.3.txt b/Documentation/RelNotes/2.4.3.adoc similarity index 100% rename from Documentation/RelNotes/2.4.3.txt rename to Documentation/RelNotes/2.4.3.adoc diff --git a/Documentation/RelNotes/2.4.4.txt b/Documentation/RelNotes/2.4.4.adoc similarity index 100% rename from Documentation/RelNotes/2.4.4.txt rename to Documentation/RelNotes/2.4.4.adoc diff --git a/Documentation/RelNotes/2.4.5.txt b/Documentation/RelNotes/2.4.5.adoc similarity index 100% rename from Documentation/RelNotes/2.4.5.txt rename to Documentation/RelNotes/2.4.5.adoc diff --git a/Documentation/RelNotes/2.4.6.txt b/Documentation/RelNotes/2.4.6.adoc similarity index 100% rename from Documentation/RelNotes/2.4.6.txt rename to Documentation/RelNotes/2.4.6.adoc diff --git a/Documentation/RelNotes/2.4.7.txt b/Documentation/RelNotes/2.4.7.adoc similarity index 100% rename from Documentation/RelNotes/2.4.7.txt rename to Documentation/RelNotes/2.4.7.adoc diff --git a/Documentation/RelNotes/2.4.8.txt b/Documentation/RelNotes/2.4.8.adoc similarity index 100% rename from Documentation/RelNotes/2.4.8.txt rename to Documentation/RelNotes/2.4.8.adoc diff --git a/Documentation/RelNotes/2.4.9.txt b/Documentation/RelNotes/2.4.9.adoc similarity index 100% rename from Documentation/RelNotes/2.4.9.txt rename to Documentation/RelNotes/2.4.9.adoc diff --git a/Documentation/RelNotes/2.40.0.txt b/Documentation/RelNotes/2.40.0.adoc similarity index 100% rename from Documentation/RelNotes/2.40.0.txt rename to Documentation/RelNotes/2.40.0.adoc diff --git a/Documentation/RelNotes/2.40.1.txt b/Documentation/RelNotes/2.40.1.adoc similarity index 100% rename from Documentation/RelNotes/2.40.1.txt rename to Documentation/RelNotes/2.40.1.adoc diff --git a/Documentation/RelNotes/2.40.2.txt b/Documentation/RelNotes/2.40.2.adoc similarity index 100% rename from Documentation/RelNotes/2.40.2.txt rename to Documentation/RelNotes/2.40.2.adoc diff --git a/Documentation/RelNotes/2.40.3.txt b/Documentation/RelNotes/2.40.3.adoc similarity index 100% rename from Documentation/RelNotes/2.40.3.txt rename to Documentation/RelNotes/2.40.3.adoc diff --git a/Documentation/RelNotes/2.40.4.adoc b/Documentation/RelNotes/2.40.4.adoc new file mode 100644 index 00000000000000..0ff29f3cfcfefe --- /dev/null +++ b/Documentation/RelNotes/2.40.4.adoc @@ -0,0 +1,5 @@ +Git v2.40.4 Release Notes +========================= + +This release lets Git refuse to accept URLs that contain control +sequences. This addresses CVE-2024-50349 and CVE-2024-52006. diff --git a/Documentation/RelNotes/2.41.0.txt b/Documentation/RelNotes/2.41.0.adoc similarity index 100% rename from Documentation/RelNotes/2.41.0.txt rename to Documentation/RelNotes/2.41.0.adoc diff --git a/Documentation/RelNotes/2.41.1.txt b/Documentation/RelNotes/2.41.1.adoc similarity index 100% rename from Documentation/RelNotes/2.41.1.txt rename to Documentation/RelNotes/2.41.1.adoc diff --git a/Documentation/RelNotes/2.41.2.txt b/Documentation/RelNotes/2.41.2.adoc similarity index 100% rename from Documentation/RelNotes/2.41.2.txt rename to Documentation/RelNotes/2.41.2.adoc diff --git a/Documentation/RelNotes/2.41.3.adoc b/Documentation/RelNotes/2.41.3.adoc new file mode 100644 index 00000000000000..b5aba88790c2c0 --- /dev/null +++ b/Documentation/RelNotes/2.41.3.adoc @@ -0,0 +1,6 @@ +Git v2.41.3 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4 to address +the security issues CVE-2024-50349 and CVE-2024-52006; see the +release notes for that version for details. diff --git a/Documentation/RelNotes/2.42.0.txt b/Documentation/RelNotes/2.42.0.adoc similarity index 100% rename from Documentation/RelNotes/2.42.0.txt rename to Documentation/RelNotes/2.42.0.adoc diff --git a/Documentation/RelNotes/2.42.1.txt b/Documentation/RelNotes/2.42.1.adoc similarity index 100% rename from Documentation/RelNotes/2.42.1.txt rename to Documentation/RelNotes/2.42.1.adoc diff --git a/Documentation/RelNotes/2.42.2.txt b/Documentation/RelNotes/2.42.2.adoc similarity index 100% rename from Documentation/RelNotes/2.42.2.txt rename to Documentation/RelNotes/2.42.2.adoc diff --git a/Documentation/RelNotes/2.42.3.txt b/Documentation/RelNotes/2.42.3.adoc similarity index 100% rename from Documentation/RelNotes/2.42.3.txt rename to Documentation/RelNotes/2.42.3.adoc diff --git a/Documentation/RelNotes/2.42.4.adoc b/Documentation/RelNotes/2.42.4.adoc new file mode 100644 index 00000000000000..3129d76e751dab --- /dev/null +++ b/Documentation/RelNotes/2.42.4.adoc @@ -0,0 +1,6 @@ +Git v2.42.4 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4 and v2.41.3 +to address the security issues CVE-2024-50349 and CVE-2024-52006; +see the release notes for these versions for details. diff --git a/Documentation/RelNotes/2.43.0.txt b/Documentation/RelNotes/2.43.0.adoc similarity index 100% rename from Documentation/RelNotes/2.43.0.txt rename to Documentation/RelNotes/2.43.0.adoc diff --git a/Documentation/RelNotes/2.43.1.txt b/Documentation/RelNotes/2.43.1.adoc similarity index 100% rename from Documentation/RelNotes/2.43.1.txt rename to Documentation/RelNotes/2.43.1.adoc diff --git a/Documentation/RelNotes/2.43.2.txt b/Documentation/RelNotes/2.43.2.adoc similarity index 100% rename from Documentation/RelNotes/2.43.2.txt rename to Documentation/RelNotes/2.43.2.adoc diff --git a/Documentation/RelNotes/2.43.3.txt b/Documentation/RelNotes/2.43.3.adoc similarity index 100% rename from Documentation/RelNotes/2.43.3.txt rename to Documentation/RelNotes/2.43.3.adoc diff --git a/Documentation/RelNotes/2.43.4.txt b/Documentation/RelNotes/2.43.4.adoc similarity index 100% rename from Documentation/RelNotes/2.43.4.txt rename to Documentation/RelNotes/2.43.4.adoc diff --git a/Documentation/RelNotes/2.43.5.txt b/Documentation/RelNotes/2.43.5.adoc similarity index 100% rename from Documentation/RelNotes/2.43.5.txt rename to Documentation/RelNotes/2.43.5.adoc diff --git a/Documentation/RelNotes/2.43.6.adoc b/Documentation/RelNotes/2.43.6.adoc new file mode 100644 index 00000000000000..2114b9f78d3b20 --- /dev/null +++ b/Documentation/RelNotes/2.43.6.adoc @@ -0,0 +1,7 @@ +Git v2.43.6 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4, v2.41.3 +and v2.42.4 to address the security issues CVE-2024-50349 and +CVE-2024-52006; see the release notes for these versions for +details. diff --git a/Documentation/RelNotes/2.44.0.txt b/Documentation/RelNotes/2.44.0.adoc similarity index 100% rename from Documentation/RelNotes/2.44.0.txt rename to Documentation/RelNotes/2.44.0.adoc diff --git a/Documentation/RelNotes/2.44.1.txt b/Documentation/RelNotes/2.44.1.adoc similarity index 100% rename from Documentation/RelNotes/2.44.1.txt rename to Documentation/RelNotes/2.44.1.adoc diff --git a/Documentation/RelNotes/2.44.2.txt b/Documentation/RelNotes/2.44.2.adoc similarity index 100% rename from Documentation/RelNotes/2.44.2.txt rename to Documentation/RelNotes/2.44.2.adoc diff --git a/Documentation/RelNotes/2.44.3.adoc b/Documentation/RelNotes/2.44.3.adoc new file mode 100644 index 00000000000000..58628454583da9 --- /dev/null +++ b/Documentation/RelNotes/2.44.3.adoc @@ -0,0 +1,7 @@ +Git v2.44.3 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4, v2.41.3, +v2.42.4 and v2.43.6 to address the security issues CVE-2024-50349 +and CVE-2024-52006; see the release notes for these versions +for details. diff --git a/Documentation/RelNotes/2.45.0.txt b/Documentation/RelNotes/2.45.0.adoc similarity index 99% rename from Documentation/RelNotes/2.45.0.txt rename to Documentation/RelNotes/2.45.0.adoc index fec193679f7048..aa0315259b7fa1 100644 --- a/Documentation/RelNotes/2.45.0.txt +++ b/Documentation/RelNotes/2.45.0.adoc @@ -9,7 +9,7 @@ UI, Workflows & Features With "git init --ref-format=reftable", hopefully it would be a lot more efficient to manage a repository with many references. - * "git checkout -p" and friends learned that that "@" is a synonym + * "git checkout -p" and friends learned that "@" is a synonym for "HEAD". * Variants of vimdiff learned to honor mergetool..layout diff --git a/Documentation/RelNotes/2.45.1.txt b/Documentation/RelNotes/2.45.1.adoc similarity index 100% rename from Documentation/RelNotes/2.45.1.txt rename to Documentation/RelNotes/2.45.1.adoc diff --git a/Documentation/RelNotes/2.45.2.txt b/Documentation/RelNotes/2.45.2.adoc similarity index 100% rename from Documentation/RelNotes/2.45.2.txt rename to Documentation/RelNotes/2.45.2.adoc diff --git a/Documentation/RelNotes/2.45.3.txt b/Documentation/RelNotes/2.45.3.adoc similarity index 93% rename from Documentation/RelNotes/2.45.3.txt rename to Documentation/RelNotes/2.45.3.adoc index 2a1e9aa60879aa..ddb3cb694b518e 100644 --- a/Documentation/RelNotes/2.45.3.txt +++ b/Documentation/RelNotes/2.45.3.adoc @@ -1,7 +1,12 @@ Git v2.45.3 Release Notes ========================= -This primarily is to backport various small fixes accumulated on the +This release merges up the fix that appears in v2.40.4, v2.41.3, +v2.42.4, v2.43.6 and v2.44.3 to address the security issues +CVE-2024-50349 and CVE-2024-52006; see the release notes for +these versions for details. + +This version also backports various small fixes accumulated on the 'master' front during the development towards Git 2.46, the next feature release. diff --git a/Documentation/RelNotes/2.46.0.txt b/Documentation/RelNotes/2.46.0.adoc similarity index 99% rename from Documentation/RelNotes/2.46.0.txt rename to Documentation/RelNotes/2.46.0.adoc index b25475918a08c7..c06a04a91bced8 100644 --- a/Documentation/RelNotes/2.46.0.txt +++ b/Documentation/RelNotes/2.46.0.adoc @@ -78,7 +78,7 @@ UI, Workflows & Features turn on cover letters automatically (unless told never to enable cover letter with "--no-cover-letter" and such). - * The "--heads" option of "ls-remote" and "show-ref" has been been + * The "--heads" option of "ls-remote" and "show-ref" has been deprecated; "--branches" replaces "--heads". * For over a year, setting add.interactive.useBuiltin configuration diff --git a/Documentation/RelNotes/2.46.1.txt b/Documentation/RelNotes/2.46.1.adoc similarity index 100% rename from Documentation/RelNotes/2.46.1.txt rename to Documentation/RelNotes/2.46.1.adoc diff --git a/Documentation/RelNotes/2.46.2.txt b/Documentation/RelNotes/2.46.2.adoc similarity index 100% rename from Documentation/RelNotes/2.46.2.txt rename to Documentation/RelNotes/2.46.2.adoc diff --git a/Documentation/RelNotes/2.46.3.adoc b/Documentation/RelNotes/2.46.3.adoc new file mode 100644 index 00000000000000..4af032b63c7053 --- /dev/null +++ b/Documentation/RelNotes/2.46.3.adoc @@ -0,0 +1,6 @@ +Git v2.46.3 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4, v2.41.3, v2.42.4, +v2.43.6, v2.44.3 and v2.45.3 to address the security issues CVE-2024-50349 and +CVE-2024-52006; see the release notes for these versions for details. diff --git a/Documentation/RelNotes/2.47.0.txt b/Documentation/RelNotes/2.47.0.adoc similarity index 94% rename from Documentation/RelNotes/2.47.0.txt rename to Documentation/RelNotes/2.47.0.adoc index fbbea257a9bcc2..b63c3364af5088 100644 --- a/Documentation/RelNotes/2.47.0.txt +++ b/Documentation/RelNotes/2.47.0.adoc @@ -162,6 +162,11 @@ Performance, Internal Implementation, Development Support etc. * Give timeout to the locking code to write to reftable, instead of failing on the first failure without retrying. + * The checksum at the tail of files are now computed without + collision detection protection. This is safe as the consumer of + the information to protect itself from replay attacks checks for + hash collisions independently. + Fixes since v2.46 ----------------- @@ -317,6 +322,15 @@ Fixes since v2.46 wasn't in any repository while processing includeIf.onbranch configuration and instead crashed. + * When "git sparse-checkout disable" turns a sparse checkout into a + regular checkout, the index is fully expanded. This totally + expected behaviour however had an "oops, we are expanding the + index" advice message, which has been corrected. + (merge 537e516a39 ds/sparse-checkout-expansion-advice later to maint). + + * macOS with fsmonitor daemon can hang forever when a submodule is + involved, which has been corrected. + * Other code cleanup, docfix, build fix, etc. (merge be10ac7037 jc/mailinfo-header-cleanup later to maint). (merge 4460e052e0 jc/range-diff-lazy-setup later to maint). @@ -324,3 +338,5 @@ Fixes since v2.46 (merge 83799f1500 jk/t9001-deflake later to maint). (merge e02cc08a88 ak/typofix-2.46-maint later to maint). (merge 5c5d29e1c4 ps/ci-gitlab-upgrade later to maint). + (merge 9c4c840901 jc/doc-discarding-stalled-topics later to maint). + (merge 5e6f359f6b ds/read-cache-mempool-leakfix later to maint). diff --git a/Documentation/RelNotes/2.47.1.adoc b/Documentation/RelNotes/2.47.1.adoc new file mode 100644 index 00000000000000..39206c09fdbe62 --- /dev/null +++ b/Documentation/RelNotes/2.47.1.adoc @@ -0,0 +1,31 @@ +Git 2.47.1 Release Notes +======================== + +This is to flush accumulated fixes since 2.47.0 on the 'master' +front down to the maintenance track. + + +Fixes since Git 2.47 +-------------------- + + * Use after free and double freeing at the end in "git log -L... -p" + had been identified and fixed. + + * On macOS, fsmonitor can fall into a race condition that results in + a client waiting forever to be notified for an event that have + already happened. This problem has been corrected. + + * "git maintenance start" crashed due to an uninitialized variable + reference, which has been corrected. + + * Fail gracefully instead of crashing when attempting to write the + contents of a corrupt in-core index as a tree object. + + * A "git fetch" from the superproject going down to a submodule used + a wrong remote when the default remote names are set differently + between them. + + * The "gitk" project tree has been synchronized again with its new + maintainer, Johannes Sixt. + +Also contains minor documentation updates and code clean-ups. diff --git a/Documentation/RelNotes/2.47.2.adoc b/Documentation/RelNotes/2.47.2.adoc new file mode 100644 index 00000000000000..7a52ad8cb44a69 --- /dev/null +++ b/Documentation/RelNotes/2.47.2.adoc @@ -0,0 +1,7 @@ +Git v2.47.2 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4, v2.41.3, +v2.42.4, v2.43.6, v2.44.3, v2.45.3 and v2.46.3 to address the +security issues CVE-2024-50349 and CVE-2024-52006; see the release +notes for these versions for details. diff --git a/Documentation/RelNotes/2.48.0.adoc b/Documentation/RelNotes/2.48.0.adoc new file mode 100644 index 00000000000000..eff93be37a2269 --- /dev/null +++ b/Documentation/RelNotes/2.48.0.adoc @@ -0,0 +1,330 @@ +Git v2.48 Release Notes +======================= + +UI, Workflows & Features +------------------------ + + * A new configuration variable remote..serverOption makes the + transport layer act as if the --serverOption= option is + given from the command line. + + * "git rebase --rebase-merges" now uses branch names as labels when + able. + + * Describe the policy to introduce breaking changes. + + * Teach 'git notes add' and 'git notes append' a new '-e' flag, + instructing them to open the note in $GIT_EDITOR before saving. + + * Documentation for "git bundle" saw improvements to more prominently + call out the use of '--all' when creating bundles. + + * Drop support for older libcURL and Perl. + + * End-user experience of "git mergetool" when the command errors out + has been improved. + + * "git bundle --unbundle" and "git clone" running on a bundle file + both learned to trigger fsck over the new objects with configurable + fck check levels. + + * When "git fetch $remote" notices that refs/remotes/$remote/HEAD is + missing and discovers what branch the other side points with its + HEAD, refs/remotes/$remote/HEAD is updated to point to it. + + * "git fetch" honors "remote..followRemoteHEAD" settings to + tweak the remote-tracking HEAD in "refs/remotes//HEAD". + + * "git range-diff" learned to optionally show and compare merge + commits in the ranges being compared, with the --diff-merges + option. + + +Performance, Internal Implementation, Development Support etc. +-------------------------------------------------------------- + + * Document "amlog" notes. + + * The way AsciiDoc is used for SYNOPSIS part of the manual pages has + been revamped. The sources, at least for the simple cases, got + vastly more pleasant to work with. + + * The reftable library is now prepared to expect that the memory + allocation function given to it may fail to allocate and to deal + with such an error. + + * An extra worktree attached to a repository points at each other to + allow finding the repository from the worktree (and vice versa) + possible. Use relative paths for this linkage. + + * Enable Windows-based CI in GitLab. + + * Commands that can also work outside Git have learned to take the + repository instance "repo" when we know we are in a repository, and + NULL when we are not, in a parameter. The uses of the_repository + variable in a few of them have been removed using the new calling + convention. + + * The reftable sub-system grew a new reftable-specific strbuf + replacement to reduce its dependency on Git-specific data + structures. + + * The ref-filter machinery learns to recognize and avoid cases where + sorting would be redundant. + + * Various platform compatibility fixes split out of the larger effort + to use Meson as the primary build tool. + + * Treat ECONNABORTED the same as ECONNRESET in 'git credential-cache' + to work around a possible Cygwin regression. This resolves a race + condition caused by changes in Cygwin's handling of socket + closures, allowing the client to exit cleanly when encountering + ECONNABORTED. + + * Demonstrate an assertion failure in 'git mv'. + + * Documentation update to clarify that 'uploadpack.allowAnySHA1InWant' + implies both 'allowTipSHA1InWant' and 'allowReachableSHA1InWant'. + + * Replace various calls to atoi() with strtol_i() and strtoul_ui(), + and add improved error handling. + + * Documentation updates to 'git-update-ref(1)'. + + * Update the project's CodingGuidelines to discourage naming functions + with a "_1()" suffix. + + * Update '.clang-format' to match project conventions. + + * Centralize documentation for repository extensions into a single place. + + * Buildfix and upgrade of Clar to a newer version. + + * Documentation mark-up updates. + + * Renaming a handful of variables and structure fields. + + * Fix for clar unit tests to support CMake build. + + * C23 compatibility updates. + + * GCC 15 compatibility updates. + + * We now ensure "index-pack" is used with the "--promisor" option + only during a "git fetch". + + * The migration procedure between two ref backends has been optimized. + + * "git fsck" learned to issue warnings on "curiously formatted" ref + contents that have always been treated as valid but that Git + wouldn't have written itself (e.g., missing terminating end-of-line + after the full object name). + + * Work around Coverity warning that would not trigger in practice. + + * Built-in Git subcommands are supplied the repository object to work + with; they learned to do the same when they invoke sub-subcommands. + + * Drop support for ancient environments in various CI jobs. + + * Isolate the reftable subsystem from the rest of Git's codebase by + using fewer pieces of Git's infrastructure. + + * Optimize reading random references out of the reftable backend by + allowing reuse of iterator objects. + + * Backport oss-fuzz tests to our codebase. + + * Introduce a new repository extension to prevent older Git versions + from mis-interpreting worktrees created with relative paths. + + * Yet another "pass the repository through the callchain" topic. + + * "git describe" learned to stop digging the history needlessly + deeper. + + * Build procedure update plus introduction of Meson based builds. + + * Recent reftable updates mistook a NULL return from a request for + 0-byte allocation as OOM and died unnecessarily, which has been + corrected. + + * Reftable backend adds check for upper limit of log's update_index. + + * Start working to make the codebase buildable with -Wsign-compare. + + * Regression fix for 'show-index' when run outside of a repository. + + * The meson-build procedure is integrated into CI to catch and + prevent bitrotting. + + * "git refs migrate" learned to also migrate the reflog data across + backends. + + * The developer documentation has been updated to give the latest + info on gitk and git-gui maintainer. + + + * CI jobs that run threaded programs under LSan has been giving false + positives from time to time, which has been worked around. + + +Fixes since v2.47 +----------------- + + * Doc update to clarify how periodical maintenance are scheduled, + spread across time to avoid thundering herds. + + * Use after free and double freeing at the end in "git log -L... -p" + had been identified and fixed. + + * On macOS, fsmonitor can fall into a race condition that results in + a client waiting forever to be notified about an event that has + already happened. This problem has been corrected. + + * "git maintenance start" crashed due to an uninitialized variable + reference, which has been corrected. + + * Fail gracefully instead of crashing when attempting to write the + contents of a corrupt in-core index as a tree object. + + * A "git fetch" from the superproject going down to a submodule used + a wrong remote when the default remote names are set differently + between them. + + * Fixes compile time warnings with 64-bit MSVC. + + * Teaches 'shortlog' to explicitly use SHA-1 when operating outside + of a repository. + + * Fix 'git grep' regression on macOS by disabling lookahead when + encountering invalid UTF-8 byte sequences. + + * The dumb-http code regressed when the result of re-indexing a pack + yielded an *.idx file that differs in content from the *.idx file + it downloaded from the remote. This has been corrected by no longer + relying on the *.idx file we got from the remote. + + * When called with '--left-right' and '--use-bitmap-index', 'rev-list' + will produce output without any left/right markers, which has been + corrected. + + * More leakfixes. + + * Test modernization. + + * The "--shallow-exclude=" option to various history transfer + commands takes a ref, not an arbitrary revision. + + * A regression where commit objects missing from a commit-graph can + cause an infinite loop when doing a fetch in a partial clone has + been fixed. + + * The MinGW compatibility layer has been taught to support POSIX + semantics for atomic renames when other process(es) have a file + opened at the destination path. + + * "git gc" discards any objects that are outside promisor packs that + are referred to by an object in a promisor pack, and we do not + refetch them from the promisor at runtime, resulting an unusable + repository. Work around it by including these objects in the + referring promisor pack at the receiving end of the fetch. + + * Avoid build/test breakage on a system without working malloc debug + support dynamic library. + (merge 72ad6dc368 jk/test-malloc-debug-check later to maint). + + * Double-free fix. + (merge fe17a25905 jk/fetch-prefetch-double-free-fix later to maint). + + * Use of some uninitialized variables in "git difftool" has been + corrected. + + * Object reuse code based on multi-pack-index sent an unwanted copy + of object. + (merge e199290592 tb/multi-pack-reuse-dupfix later to maint). + + * "git fast-import" can be tricked into a replace ref that maps an + object to itself, which is a useless thing to do. + (merge 5e904f1a4a en/fast-import-avoid-self-replace later to maint). + + * The ref-transaction hook triggered for reflog updates, which has + been corrected. + (merge b886db48c6 kn/ref-transaction-hook-with-reflog later to maint). + + * Give a bit of advice/hint message when "git maintenance" stops finding a + lock file left by another instance that still is potentially running. + (merge ba874d1dac ps/gc-stale-lock-warning later to maint). + + * Use the right helper program to measure file size in performance tests. + (merge 3f97f1bce6 tb/use-test-file-size-more later to maint). + + * A double-free that may not trigger in practice by luck has been + corrected in the reference resolution code. + (merge b6318cf23a sj/refs-symref-referent-fix later to maint). + + * The sequencer failed to honor core.commentString in some places. + + * Describe a case where an option value needs to be spelled as a + separate argument, i.e. "--opt val", not "--opt=val". + (merge 1bc1e94091 jc/doc-opt-tilde-expand later to maint). + + * Loosen overly strict ownership check introduced in the recent past, + to keep the promise "cloning a suspicious repository is a safe + first step to inspect it". + (merge 0ffb5a6bf1 bc/allow-upload-pack-from-other-people later to maint). + + * "git fast-import" learned to reject paths with ".." and "." as + their components to avoid creating invalid tree objects. + (merge 8cb4c6e62f en/fast-import-verify-path later to maint). + + * The --ancestry-path option is designed to be given a commit that is + on the path, which was not documented, which has been corrected. + (merge bc1a980759 kk/doc-ancestry-path later to maint). + + * "git tag" has been taught to refuse to create refs/tags/HEAD + since such a tag will be confusing in the context of the UI provided by + the Git Porcelain commands. + (merge bbd445d5ef jc/forbid-head-as-tagname later to maint). + + * The advice messages now tell the newer 'git config set' command to + set the advice.token configuration variable to squelch a message. + (merge 6c397d0104 bf/explicit-config-set-in-advice-messages later to maint). + + * The syntax ":/" to name the latest commit with the matching + text was broken with a recent change, which has been corrected. + (merge 0ff919e87a ps/commit-with-message-syntax-fix later to maint). + + * Fix performance regression of a recent "fatten promisor pack with + local objects" protection against an unwanted gc. + + * "git log -p --remerge-diff --reverse" was completely broken. + (merge f94bfa1516 js/log-remerge-keep-ancestry later to maint). + + * "git bundle create" with an annotated tag on the positive end of + the revision range had a workaround code for older limitation in + the revision walker, which has become unnecessary. + (merge dd1072dfa8 tc/bundle-with-tag-remove-workaround later to maint). + + * GitLab CI updates. + (merge c6b43f663e ps/ci-gitlab-update later to maint). + + * Code to reuse objects based on bitmap contents have been tightened + to avoid race condition even when multiple packs are involved. + (merge 62b3ec8a3f tb/bitmap-fix-pack-reuse later to maint). + + * An earlier "csum-file checksum does not have to be computed with + sha1dc" topic had a few code paths that had initialized an + implementation of a hash function to be used by an unmatching hash + by mistake, which have been corrected. + (merge 599a63409b ps/weak-sha1-for-tail-sum-fix later to maint). + + * Other code cleanup, docfix, build fix, etc. + (merge 77af53f56f aa/t7300-modernize later to maint). + (merge dcd590a39d bf/t-readme-mention-reftable later to maint). + (merge 68e3c69efa kh/trailer-in-glossary later to maint). + (merge 91f88f76e6 tb/boundary-traversal-fix later to maint). + (merge 168ebb7159 jc/doc-error-message-guidelines later to maint). + (merge 18693d7d65 kh/doc-bundle-typofix later to maint). + (merge e2f5d3b491 kh/doc-update-ref-grammofix later to maint). + (merge 8525e92886 mh/doc-windows-home-env later to maint). diff --git a/Documentation/RelNotes/2.48.1.adoc b/Documentation/RelNotes/2.48.1.adoc new file mode 100644 index 00000000000000..26c59b6e3bf31c --- /dev/null +++ b/Documentation/RelNotes/2.48.1.adoc @@ -0,0 +1,7 @@ +Git v2.48.1 Release Notes +========================= + +This release merges up the fix that appears in v2.40.4, v2.41.3, +v2.42.4, v2.43.6, v2.44.3, v2.45.3, v2.46.3, and v2.47.2 to address +the security issues CVE-2024-50349 and CVE-2024-52006; see the release +notes for these versions for details. diff --git a/Documentation/RelNotes/2.49.0.adoc b/Documentation/RelNotes/2.49.0.adoc new file mode 100644 index 00000000000000..494c83096fae8d --- /dev/null +++ b/Documentation/RelNotes/2.49.0.adoc @@ -0,0 +1,288 @@ +Git v2.49 Release Notes +======================= + +UI, Workflows & Features +------------------------ + + * Completion script updates for zsh + + * "git pack-objects" and its wrapper "git repack" learned an option + to use an alternative path-hash function to improve delta-base + selection to produce a packfile with deeper history than window + size. + + * "git gc" learned the "--expire-to" option and passes it down to + underlying "git repack". + + * "[help] autocorrect = 1" used to be a way to say "please wait for + 0.1 second after suggesting a typofix of the command name before + running that command"; now it means "yes, if there is a plausible + typofix for the command name, please run it immediately". + + * "git clone" learned to make a shallow clone for a single commit + that is not necessarily be at the tip of any branch. + + * Lazy-loading missing files in a blobless clone on demand is costly + as it tends to be one-blob-at-a-time. "git backfill" is introduced + to help bulk-download necessary files beforehand. + + * "git push --atomic --porcelain" used to ignore failures from the + other side, losing the error status from the child process, which + has been corrected. + + * "git rev-list --missing=" learned to accept "print-info" that gives + known details expected of the missing objects, like path and type. + + * Comes with an updated "gitk". + + * The documentation of "git commit" and "git rebase" now refer to + commit titles as such, not "subject". + + * The value of "uname -s" is by default sent over the wire as a part + of the "version" capability. + + * "git refs migrate" can optionally be told not to migrate the reflog. + + * The netrc support (via the cURL library) for the HTTP transport has + been re-enabled. + + * Removal of ".git/branches" and ".git/remotes" support in the + BreakingChanges document has been further clarified. + + * What happens to submodules during merge has been documented in a + bit more detail. + + +Performance, Internal Implementation, Development Support etc. +-------------------------------------------------------------- + + * More -Wsign-compare fixes. + + * meson-based build now supports the unsafe-sha1 build knob. + + * The meson-based build procedure covers contrib/ and other places as + well. + + * The code to check LSan results has been simplified and made more + robust. + (merge 164a2516eb jk/lsan-race-ignore-false-positive later to maint). + + * More code paths have a repository passed through the callchain, + instead of assuming the primary the_repository object. + + * Move a few more unit tests to the clar test framework. + + * Introduce a new API to visit objects in batches based on a common + path, or by type. + + * Following the procedure we established to introduce breaking + changes for Git 3.0, allow an early opt-in for removing support of + $GIT_DIR/branches/ and $GIT_DIR/remotes/ directories to configure + remotes. + + * The code paths to interact with zlib has been cleaned up in + preparation for building with zlib-ng. + + * Foreign language interface for Rust into our code base has been added. + + * All the documentation .txt files have been renamed to .adoc to help + content aware editors. + + * "git difftool" code clean-up. + + * Rename processing in the recursive merge backend has seen a micro + optimization. + + * The path.[ch] API takes an explicit repository parameter passed + throughout the callchain, instead of relying on the_repository + singleton instance. + + * Large-object promisor protocol extension has been introduced. + + * The editorconfig file is updated to tell us that bash scripts are + similar to general Bourne shell scripts. + + * Meson-based build procedure forgot to build some docs, which has + been corrected. + + +Fixes since v2.48 +----------------- + + * "git submodule" learned various ways to spell the same option, + e.g. "--branch=B" can be spelled "--branch B" or "-bB". + (merge b86f0f9071 re/submodule-parse-opt later to maint). + + * Tweak the help text used for the option value placeholders by + parse-options API so that translations can customize the "<>" + placeholder signal (e.g. "--option="). + (merge 5b34dd08d0 as/long-option-help-i18n later to maint). + + * CI jobs gave sporadic failures, which turns out that that the + object finalization code was giving an error when it did not have + to. + (merge d7fcbe2c56 ps/object-collision-check later to maint). + + * The code to compute "unique" name used git_rand() which can fail or + get stuck; the callsite does not require cryptographic security. + Introduce the "insecure" mode and use it appropriately. + (merge 0b4f8afef6 ps/reftable-get-random-fix later to maint). + + * A misconfigured "fsck.skiplist" configuration variable was not + diagnosed as an error, which has been corrected. + (merge ca7158076f jt/fsck-skiplist-parse-fix later to maint). + + * Extended SHA-1 expression parser did not work well when a branch + with an unusual name (e.g. "foo{bar") is involved. + (merge 191f0c8db2 en/object-name-with-funny-refname-fix later to maint). + + * The meson build procedure looked for the 'version-def.h' file in a + wrong directory, which has been corrected. + (merge 4771501c0a tc/meson-use-our-version-def-h later to maint). + + * The meson build procedure for Documentation/technical/ hierarchy was + missing necessary dependencies, which has been corrected. + (merge 1dca492edd sj/meson-doc-technical-dependency-fix later to maint). + + * The "instaweb" bound only to local IP address without "--local" and + to all addresses with "--local", which was the other way around, when + using Python's http.server class, which has been corrected. + (merge 76baf97fa1 ak/instaweb-python-port-binding-fix later to maint). + + * Document that it is insecure to use Personal Access Tokens, which + some hosting providers take as username/password, embedded in URLs. + (merge a90ff409f0 mh/doc-credential-helpers-with-pat later to maint). + + * The help text from "git $cmd -h" appear on the standard output for + some $cmd and the standard error for others. The built-in commands + have been fixed to show them on the standard output consistently. + (merge f66d1423f5 jc/show-usage-help later to maint). + + * The meson-driven build is now aware of "git-subtree" housed in + contrib/subtree hierarchy. + (merge 8454b42f94 ps/build-meson-subtree later to maint). + + * It was possible for "git unpack-objects" and "git index-pack" to + make an unaligned access, which has been corrected. + (merge 98046591b9 jk/pack-header-parse-alignment-fix later to maint). + + * The "cache" credential back-end did not handle authtype correctly, + which has been corrected. + (merge 0b43274850 mh/credential-cache-authtype-request-fix later to maint). + + * "git branch --sort=..." and "git for-each-ref --format=... --sort=..." + did not work as expected with some atoms, which has been corrected. + (merge c5490ce9d1 rs/ref-fitler-used-atoms-value-fix later to maint). + + * reflog entries for symbolic ref updates were broken, which has been + corrected. + (merge 3519492430 kn/reflog-symref-fix later to maint). + + * The trace2 code was not prepared to show a configuration variable + that is set to true using the valueless true syntax, which has been + corrected. + (merge 2fd367cf63 am/trace2-with-valueless-true later to maint). + + * The "git refs migrate" command did not migrate the reflog for + refs/stash, which is the contents of the stashes, which has been + corrected. + (merge a0bea0978f ps/reflog-migration-with-logall-fix later to maint). + + * Doc and short-help text for "show-index" has been clarified to + stress that the command reads its data from the standard input. + (merge 49edce4ff9 jc/show-index-h-update later to maint). + + * The API around choosing to use unsafe variant of SHA-1 + implementation has been updated in an attempt to make it harder to + abuse. + (merge 04292c3796 tb/unsafe-hash-cleanup later to maint). + + * Fix bugs in an earlier attempt to fix "git refs migration". + (merge f11f0a5a2d kn/reflog-migration-fix-fix later to maint). + + * The code path used when "git fetch" fetches from a bundle file + closed the same file descriptor twice, which sometimes broke things + unexpectedly when the file descriptor was reused, which has been + corrected. + (merge 9a84794ad8 js/bundle-unbundle-fd-reuse-fix later to maint). + + * "git init" to reinitialize a repository that already exists cannot + change the hash function and ref backends; such a request is + silently ignored now. + (merge 7e88640cd1 ps/setup-reinit-fixes later to maint). + + * "git apply" internally uses unsigned long for line numbers and uses + strtoul() to parse numbers on the hunk headers. It however forgot + to check parse errors. + (merge a206058fda pw/apply-ulong-overflow-check later to maint). + + * Two CI tasks, whitespace check and style check, work on the + difference from the base version and the version being checked, but + the base was computed incorrectly in GitLab CI in some cases, which + has been corrected. + (merge acc4fb302b jt/gitlab-ci-base-fix later to maint). + + * "git repack --keep-unreachable" to send unreachable objects to the + main pack "git repack -ad" produces did not work when there is no + existing packs, which has been corrected. + (merge 414c82300a ps/repack-keep-unreachable-in-unpacked-repo later to maint). + + * Going into a secondary worktree and asking "is the main worktree + bare?" did not work correctly when per-worktree configuration + option was in use, which has been corrected. + + * Fetching into a bare repository incorrectly assumed it always used + a mirror layout when deciding to update remote-tracking HEAD, which + has been corrected. + (merge 93dc16483a bf/fetch-set-head-fix later to maint). + + * A thunderbird helper script lost its bashism. + (merge 59d26bd961 bc/contrib-thunderbird-patch-inline-fix later to maint). + + * The -G/-S options to the "diff" family of commands caused us to hit + a BUG() when they get no values; they have been corrected. + (merge a620046b29 bc/diff-reject-empty-arg-to-pickaxe later to maint). + + * "git merge-tree --stdin" has been improved (including a workaround + for a deadlock). + (merge 6a9ae81015 pw/merge-tree-stdin-deadlock-fix later to maint). + + * Correct the default target in Documentation/Makefile, and + future-proof all Makefiles from similar breakages by declaring the + default target (which happens to be "all") upfront. + (merge 5309c1e9fb ad/set-default-target-in-makefiles later to maint). + + * "git check-mailmap" used to segfault when queried without human + readable name. + (merge bb60c52131 jk/check-mailmap-wo-name-fix later to maint). + + * Support for renaming of symbolic links on Windows has been improved. + + * "git rebase -i" failed to allow rewording an empty commit that has + been fast-forwarded. + (merge af8fc7be10 pw/rebase-i-ff-empty-commit later to maint). + + * The use of "paste" command for aggregating the test results have + been corrected. + (merge ce98863204 dk/test-aggregate-results-paste-fix later to maint). + + * Other code cleanup, docfix, build fix, etc. + (merge ddb5287894 jk/t7407-use-test-grep later to maint). + (merge 21e1b44865 aj/difftool-config-doc-fix later to maint). + (merge 6a63995335 mh/gitattr-doc-markup-fix later to maint). + (merge 43850dcf9c sk/unit-test-hash later to maint). + (merge 4ad47d2de3 jc/cli-doc-option-and-config later to maint). + (merge 2d0ff147e5 jp/t8002-printf-fix later to maint). + (merge 69666e6746 ja/doc-restore-markup-update later to maint). + (merge d11d003ba5 sk/strlen-returns-size_t later to maint). + (merge 77b2d29e91 ja/doc-notes-markup-updates later to maint). + (merge 6979bf6f8f jk/combine-diff-cleanup later to maint). + (merge 8705c9bd13 kn/pack-write-with-reduced-globals later to maint). + (merge 087740d65a ps/leakfixes-0129 later to maint). + (merge 6bba6f604b jp/doc-trailer-config later to maint). + (merge f1cc562b77 lo/t7603-path-is-file-update later to maint). + (merge 45761988ac en/doc-renormalize later to maint). + (merge 832f56f06a jc/doc-boolean-synonyms later to maint). + (merge 3eeed876a9 ac/doc-http-ssl-type-config later to maint). + (merge c268e3285d jc/breaking-changes-early-adopter-option later to maint). + (merge 0d03fda6a5 pb/doc-follow-remote-head later to maint). diff --git a/Documentation/RelNotes/2.5.0.txt b/Documentation/RelNotes/2.5.0.adoc similarity index 100% rename from Documentation/RelNotes/2.5.0.txt rename to Documentation/RelNotes/2.5.0.adoc diff --git a/Documentation/RelNotes/2.5.1.txt b/Documentation/RelNotes/2.5.1.adoc similarity index 100% rename from Documentation/RelNotes/2.5.1.txt rename to Documentation/RelNotes/2.5.1.adoc diff --git a/Documentation/RelNotes/2.5.2.txt b/Documentation/RelNotes/2.5.2.adoc similarity index 100% rename from Documentation/RelNotes/2.5.2.txt rename to Documentation/RelNotes/2.5.2.adoc diff --git a/Documentation/RelNotes/2.5.3.txt b/Documentation/RelNotes/2.5.3.adoc similarity index 100% rename from Documentation/RelNotes/2.5.3.txt rename to Documentation/RelNotes/2.5.3.adoc diff --git a/Documentation/RelNotes/2.5.4.txt b/Documentation/RelNotes/2.5.4.adoc similarity index 100% rename from Documentation/RelNotes/2.5.4.txt rename to Documentation/RelNotes/2.5.4.adoc diff --git a/Documentation/RelNotes/2.5.5.txt b/Documentation/RelNotes/2.5.5.adoc similarity index 100% rename from Documentation/RelNotes/2.5.5.txt rename to Documentation/RelNotes/2.5.5.adoc diff --git a/Documentation/RelNotes/2.5.6.txt b/Documentation/RelNotes/2.5.6.adoc similarity index 100% rename from Documentation/RelNotes/2.5.6.txt rename to Documentation/RelNotes/2.5.6.adoc diff --git a/Documentation/RelNotes/2.6.0.txt b/Documentation/RelNotes/2.6.0.adoc similarity index 100% rename from Documentation/RelNotes/2.6.0.txt rename to Documentation/RelNotes/2.6.0.adoc diff --git a/Documentation/RelNotes/2.6.1.txt b/Documentation/RelNotes/2.6.1.adoc similarity index 100% rename from Documentation/RelNotes/2.6.1.txt rename to Documentation/RelNotes/2.6.1.adoc diff --git a/Documentation/RelNotes/2.6.2.txt b/Documentation/RelNotes/2.6.2.adoc similarity index 100% rename from Documentation/RelNotes/2.6.2.txt rename to Documentation/RelNotes/2.6.2.adoc diff --git a/Documentation/RelNotes/2.6.3.txt b/Documentation/RelNotes/2.6.3.adoc similarity index 100% rename from Documentation/RelNotes/2.6.3.txt rename to Documentation/RelNotes/2.6.3.adoc diff --git a/Documentation/RelNotes/2.6.4.txt b/Documentation/RelNotes/2.6.4.adoc similarity index 100% rename from Documentation/RelNotes/2.6.4.txt rename to Documentation/RelNotes/2.6.4.adoc diff --git a/Documentation/RelNotes/2.6.5.txt b/Documentation/RelNotes/2.6.5.adoc similarity index 100% rename from Documentation/RelNotes/2.6.5.txt rename to Documentation/RelNotes/2.6.5.adoc diff --git a/Documentation/RelNotes/2.6.6.txt b/Documentation/RelNotes/2.6.6.adoc similarity index 100% rename from Documentation/RelNotes/2.6.6.txt rename to Documentation/RelNotes/2.6.6.adoc diff --git a/Documentation/RelNotes/2.6.7.txt b/Documentation/RelNotes/2.6.7.adoc similarity index 100% rename from Documentation/RelNotes/2.6.7.txt rename to Documentation/RelNotes/2.6.7.adoc diff --git a/Documentation/RelNotes/2.7.0.txt b/Documentation/RelNotes/2.7.0.adoc similarity index 100% rename from Documentation/RelNotes/2.7.0.txt rename to Documentation/RelNotes/2.7.0.adoc diff --git a/Documentation/RelNotes/2.7.1.txt b/Documentation/RelNotes/2.7.1.adoc similarity index 100% rename from Documentation/RelNotes/2.7.1.txt rename to Documentation/RelNotes/2.7.1.adoc diff --git a/Documentation/RelNotes/2.7.2.txt b/Documentation/RelNotes/2.7.2.adoc similarity index 100% rename from Documentation/RelNotes/2.7.2.txt rename to Documentation/RelNotes/2.7.2.adoc diff --git a/Documentation/RelNotes/2.7.3.txt b/Documentation/RelNotes/2.7.3.adoc similarity index 100% rename from Documentation/RelNotes/2.7.3.txt rename to Documentation/RelNotes/2.7.3.adoc diff --git a/Documentation/RelNotes/2.7.4.txt b/Documentation/RelNotes/2.7.4.adoc similarity index 100% rename from Documentation/RelNotes/2.7.4.txt rename to Documentation/RelNotes/2.7.4.adoc diff --git a/Documentation/RelNotes/2.7.5.txt b/Documentation/RelNotes/2.7.5.adoc similarity index 100% rename from Documentation/RelNotes/2.7.5.txt rename to Documentation/RelNotes/2.7.5.adoc diff --git a/Documentation/RelNotes/2.7.6.txt b/Documentation/RelNotes/2.7.6.adoc similarity index 100% rename from Documentation/RelNotes/2.7.6.txt rename to Documentation/RelNotes/2.7.6.adoc diff --git a/Documentation/RelNotes/2.8.0.txt b/Documentation/RelNotes/2.8.0.adoc similarity index 100% rename from Documentation/RelNotes/2.8.0.txt rename to Documentation/RelNotes/2.8.0.adoc diff --git a/Documentation/RelNotes/2.8.1.txt b/Documentation/RelNotes/2.8.1.adoc similarity index 100% rename from Documentation/RelNotes/2.8.1.txt rename to Documentation/RelNotes/2.8.1.adoc diff --git a/Documentation/RelNotes/2.8.2.txt b/Documentation/RelNotes/2.8.2.adoc similarity index 100% rename from Documentation/RelNotes/2.8.2.txt rename to Documentation/RelNotes/2.8.2.adoc diff --git a/Documentation/RelNotes/2.8.3.txt b/Documentation/RelNotes/2.8.3.adoc similarity index 100% rename from Documentation/RelNotes/2.8.3.txt rename to Documentation/RelNotes/2.8.3.adoc diff --git a/Documentation/RelNotes/2.8.4.txt b/Documentation/RelNotes/2.8.4.adoc similarity index 100% rename from Documentation/RelNotes/2.8.4.txt rename to Documentation/RelNotes/2.8.4.adoc diff --git a/Documentation/RelNotes/2.8.5.txt b/Documentation/RelNotes/2.8.5.adoc similarity index 100% rename from Documentation/RelNotes/2.8.5.txt rename to Documentation/RelNotes/2.8.5.adoc diff --git a/Documentation/RelNotes/2.8.6.txt b/Documentation/RelNotes/2.8.6.adoc similarity index 100% rename from Documentation/RelNotes/2.8.6.txt rename to Documentation/RelNotes/2.8.6.adoc diff --git a/Documentation/RelNotes/2.9.0.txt b/Documentation/RelNotes/2.9.0.adoc similarity index 100% rename from Documentation/RelNotes/2.9.0.txt rename to Documentation/RelNotes/2.9.0.adoc diff --git a/Documentation/RelNotes/2.9.1.txt b/Documentation/RelNotes/2.9.1.adoc similarity index 100% rename from Documentation/RelNotes/2.9.1.txt rename to Documentation/RelNotes/2.9.1.adoc diff --git a/Documentation/RelNotes/2.9.2.txt b/Documentation/RelNotes/2.9.2.adoc similarity index 100% rename from Documentation/RelNotes/2.9.2.txt rename to Documentation/RelNotes/2.9.2.adoc diff --git a/Documentation/RelNotes/2.9.3.txt b/Documentation/RelNotes/2.9.3.adoc similarity index 100% rename from Documentation/RelNotes/2.9.3.txt rename to Documentation/RelNotes/2.9.3.adoc diff --git a/Documentation/RelNotes/2.9.4.txt b/Documentation/RelNotes/2.9.4.adoc similarity index 100% rename from Documentation/RelNotes/2.9.4.txt rename to Documentation/RelNotes/2.9.4.adoc diff --git a/Documentation/RelNotes/2.9.5.txt b/Documentation/RelNotes/2.9.5.adoc similarity index 100% rename from Documentation/RelNotes/2.9.5.txt rename to Documentation/RelNotes/2.9.5.adoc diff --git a/Documentation/ReviewingGuidelines.txt b/Documentation/ReviewingGuidelines.adoc similarity index 100% rename from Documentation/ReviewingGuidelines.txt rename to Documentation/ReviewingGuidelines.adoc diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index d8a8caa7916980..958e3cc3d54741 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -412,13 +412,13 @@ Also notice that a real name is used in the `Signed-off-by` trailer. Please don't hide your real name. [[commit-trailers]] -If you like, you can put extra tags at the end: +If you like, you can put extra trailers at the end: . `Reported-by:` is used to credit someone who found the bug that the patch attempts to fix. . `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 +. `Reviewed-by:`, unlike the other trailers, can only be offered by the reviewers themselves when they are completely satisfied with the patch after a detailed analysis. . `Tested-by:` is used to indicate that the person applied the patch @@ -436,7 +436,7 @@ While you can also create your own trailer if the situation warrants it, we encourage you to instead use one of the common trailers in this project highlighted above. -Only capitalize the very first letter of tags, i.e. favor +Only capitalize the very first letter of the trailer, i.e. favor "Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By". [[git-tools]] @@ -692,16 +692,17 @@ rebase when I receive your patches). Some parts of the system have dedicated maintainers with their own repositories. -- `git-gui/` comes from git-gui project, maintained by Johannes Sixt: +- `git-gui/` comes from the git-gui project, maintained by Johannes Sixt: https://github.com/j6t/git-gui -- `gitk-git/` comes from Paul Mackerras's gitk project: + Contibutions should go via the git mailing list. - git://git.ozlabs.org/~paulus/gitk +- `gitk-git/` comes from the gitk project, maintained by Johannes Sixt: - Those who are interested in improving gitk can volunteer to help Paul - maintain it, cf. . + https://github.com/j6t/gitk + + Contibutions should go via the git mailing list. - `po/` comes from the localization coordinator, Jiang Xin: diff --git a/Documentation/ToolsForGit.txt b/Documentation/ToolsForGit.adoc similarity index 100% rename from Documentation/ToolsForGit.txt rename to Documentation/ToolsForGit.adoc diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf deleted file mode 100644 index 60f76f43edab75..00000000000000 --- a/Documentation/asciidoc.conf +++ /dev/null @@ -1,59 +0,0 @@ -## linkgit: macro -# -# Usage: linkgit:command[manpage-section] -# -# Note, {0} is the manpage section, while {target} is the command. -# -# Show Git link as: (
); if section is defined, else just show -# the command. - -[macros] -(?su)[\\]?(?Plinkgit):(?P\S*?)\[(?P.*?)\]= - -[attributes] -asterisk=* -plus=+ -caret=^ -startsb=[ -endsb=] -backslash=\ -tilde=~ -apostrophe=' -backtick=` -litdd=-- - -ifdef::backend-docbook[] -[linkgit-inlinemacro] -{0%{target}} -{0#} -{0#{target}{0}} -{0#} -endif::backend-docbook[] - -ifdef::backend-docbook[] -ifdef::doctype-manpage[] -# The following two small workarounds insert a simple paragraph after screen -[listingblock] -{title} - -| - -{title#} - -[verseblock] -{title} -{title%} -{title#} -| - -{title#} -{title%} -endif::doctype-manpage[] -endif::backend-docbook[] - -ifdef::backend-xhtml11[] -[attributes] -git-relative-html-prefix= -[linkgit-inlinemacro] -{target}{0?({0})} -endif::backend-xhtml11[] diff --git a/Documentation/asciidoc.conf.in b/Documentation/asciidoc.conf.in new file mode 100644 index 00000000000000..f2aef6cb79f47c --- /dev/null +++ b/Documentation/asciidoc.conf.in @@ -0,0 +1,92 @@ +## linkgit: macro +# +# Usage: linkgit:command[manpage-section] +# +# Note, {0} is the manpage section, while {target} is the command. +# +# Show Git link as: (
); if section is defined, else just show +# the command. + +[macros] +(?su)[\\]?(?Plinkgit):(?P\S*?)\[(?P.*?)\]= + +[attributes] +asterisk=* +plus=+ +caret=^ +startsb=[ +endsb=] +backslash=\ +tilde=~ +apostrophe=' +backtick=` +litdd=-- +manmanual=Git Manual +mansource=Git @GIT_VERSION@ +revdate=@GIT_DATE@ + +ifdef::doctype-book[] +[titles] + underlines="__","==","--","~~","^^" +endif::doctype-book[] + +ifdef::backend-docbook[] +[linkgit-inlinemacro] +ifndef::doctype-book[] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::doctype-book[] +ifdef::doctype-book[] +{target}{0?({0})} +endif::doctype-book[] + +[literal-inlinemacro] +{eval:re.sub(r'(<[-a-zA-Z0-9.]+>)', r'\1', re.sub(r'([\[\s|()>]|^|\]|>)(\.?([-a-zA-Z0-9:+=~@,\/_^\$]+\.?)+)',r'\1\2', re.sub(r'(\.\.\.?)([^\]$.])', r'\1\2', macros.passthroughs[int(attrs['passtext'][1:-1])] if attrs['passtext'][1:-1].isnumeric() else attrs['passtext'][1:-1])))} + +endif::backend-docbook[] + +ifdef::backend-docbook[] +ifdef::doctype-manpage[] +# The following two small workarounds insert a simple paragraph after screen +[listingblock] +{title} + +| + +{title#} + +[verseblock] +{title} +{title%} +{title#} +| + +{title#} +{title%} +endif::doctype-manpage[] +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[attributes] +git-relative-html-prefix= +[linkgit-inlinemacro] +{target}{0?({0})} + +[literal-inlinemacro] +{eval:re.sub(r'(<[-a-zA-Z0-9.]+>)', r'\1', re.sub(r'([\[\s|()>]|^|\]|>)(\.?([-a-zA-Z0-9:+=~@,\/_^\$]+\.?)+)',r'\1\2', re.sub(r'(\.\.\.?)([^\]$.])', r'\1\2', macros.passthroughs[int(attrs['passtext'][1:-1])] if attrs['passtext'][1:-1].isnumeric() else attrs['passtext'][1:-1])))} + +endif::backend-xhtml11[] + +ifdef::backend-docbook[] +ifdef::doctype-manpage[] +[paradef-default] +synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!\\0!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.]\\+\\|…\\)!\\1\\2!g;s!<[-a-zA-Z0-9.]\\+>!\\0!g'" +endif::doctype-manpage[] +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[paradef-default] +synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!\\0!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.]\\+\\|…\\)!\\1\\2!g;s!<[-a-zA-Z0-9.]\\+>!\\0!g'" +endif::backend-xhtml11[] diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb deleted file mode 100644 index d906a008039cf5..00000000000000 --- a/Documentation/asciidoctor-extensions.rb +++ /dev/null @@ -1,48 +0,0 @@ -require 'asciidoctor' -require 'asciidoctor/extensions' - -module Git - module Documentation - class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor - use_dsl - - named :chrome - - def process(parent, target, attrs) - prefix = parent.document.attr('git-relative-html-prefix') - if parent.document.doctype == 'book' - "" \ - "#{target}(#{attrs[1]})" - elsif parent.document.basebackend? 'html' - %(#{target}(#{attrs[1]})) - elsif parent.document.basebackend? 'docbook' - "\n" \ - "#{target}" \ - "#{attrs[1]}\n" \ - "" - end - end - end - - class DocumentPostProcessor < Asciidoctor::Extensions::Postprocessor - def process document, output - if document.basebackend? 'docbook' - mansource = document.attributes['mansource'] - manversion = document.attributes['manversion'] - manmanual = document.attributes['manmanual'] - new_tags = "" \ - "#{mansource}\n" \ - "#{manversion}\n" \ - "#{manmanual}\n" - output = output.sub(/<\/refmeta>/, new_tags + "") - end - output - end - end - end -end - -Asciidoctor::Extensions.register do - inline_macro Git::Documentation::LinkGitProcessor, :linkgit - postprocessor Git::Documentation::DocumentPostProcessor -end diff --git a/Documentation/asciidoctor-extensions.rb.in b/Documentation/asciidoctor-extensions.rb.in new file mode 100644 index 00000000000000..2494f17a514d9d --- /dev/null +++ b/Documentation/asciidoctor-extensions.rb.in @@ -0,0 +1,134 @@ +require 'asciidoctor' +require 'asciidoctor/extensions' +require 'asciidoctor/converter/docbook5' +require 'asciidoctor/converter/html5' + +module Git + module Documentation + class LinkGitProcessor < Asciidoctor::Extensions::InlineMacroProcessor + use_dsl + + named :chrome + + def process(parent, target, attrs) + prefix = parent.document.attr('git-relative-html-prefix') + if parent.document.doctype == 'book' + "" \ + "#{target}(#{attrs[1]})" + elsif parent.document.basebackend? 'html' + %(#{target}(#{attrs[1]})) + elsif parent.document.basebackend? 'docbook' + "\n" \ + "#{target}" \ + "#{attrs[1]}\n" \ + "" + end + end + end + + class DocumentPostProcessor < Asciidoctor::Extensions::Postprocessor + def process document, output + if document.basebackend? 'docbook' + output = output.sub(/.*?<\/refmiscinfo>/, "") + output = output.sub(/.*?<\/refmiscinfo>/, "") + output = output.sub(/.*?<\/date>/, "@GIT_DATE@") + new_tags = "" \ + "Git @GIT_VERSION@\n" \ + "Git Manual\n" + output = output.sub(/<\/refmeta>/, new_tags + "") + end + output + end + end + + class SynopsisBlock < Asciidoctor::Extensions::BlockProcessor + + use_dsl + named :synopsis + parse_content_as :simple + + def process parent, reader, attrs + outlines = reader.lines.map do |l| + l.gsub(/(\.\.\.?)([^\]$.])/, '`\1`\2') + .gsub(%r{([\[\] |()>]|^)([-a-zA-Z0-9:+=~@,/_^\$]+)}, '\1{empty}`\2`{empty}') + .gsub(/(<[-a-zA-Z0-9.]+>)/, '__\\1__') + .gsub(']', ']{empty}') + end + create_block parent, :verse, outlines, attrs + end + end + + class GitDBConverter < Asciidoctor::Converter::DocBook5Converter + + extend Asciidoctor::Converter::Config + register_for 'docbook5' + + def convert_inline_quoted node + if (type = node.type) == :asciimath + # NOTE fop requires jeuclid to process mathml markup + asciimath_available? ? %(#{(::AsciiMath.parse node.text).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'}) : %() + elsif type == :latexmath + # unhandled math; pass source to alt and required mathphrase element; dblatex will process alt as LaTeX math + %() + elsif type == :monospaced + node.text.gsub(/(\.\.\.?)([^\]$.])/, '\1\2') + .gsub(%r{([\[\s|()>.]|^|\]|>)(\.?([-a-zA-Z0-9:+=~@,/_^\$]+\.{0,2})+)}, '\1\2') + .gsub(/(<[-a-zA-Z0-9.]+>)/, '\1') + else + open, close, supports_phrase = QUOTE_TAGS[type] + text = node.text + if node.role + if supports_phrase + quoted_text = %(#{open}#{text}#{close}) + else + quoted_text = %(#{open.chop} role="#{node.role}">#{text}#{close}) + end + else + quoted_text = %(#{open}#{text}#{close}) + end + node.id ? %(#{quoted_text}) : quoted_text + end + end + end + + # register a html5 converter that takes in charge to convert monospaced text into Git style synopsis + class GitHTMLConverter < Asciidoctor::Converter::Html5Converter + + extend Asciidoctor::Converter::Config + register_for 'html5' + + def convert_inline_quoted node + if node.type == :monospaced + node.text.gsub(/(\.\.\.?)([^\]$.])/, '\1\2') + .gsub(%r{([\[\s|()>.]|^|\]|>)(\.?([-a-zA-Z0-9:+=~@,/_^\$]+\.{0,2})+)}, '\1\2') + .gsub(/(<[-a-zA-Z0-9.]+>)/, '\1') + + else + open, close, tag = QUOTE_TAGS[node.type] + if node.id + class_attr = node.role ? %( class="#{node.role}") : '' + if tag + %(#{open.chop} id="#{node.id}"#{class_attr}>#{node.text}#{close}) + else + %(#{open}#{node.text}#{close}) + end + elsif node.role + if tag + %(#{open.chop} class="#{node.role}">#{node.text}#{close}) + else + %(#{open}#{node.text}#{close}) + end + else + %(#{open}#{node.text}#{close}) + end + end + end + end + end +end + +Asciidoctor::Extensions.register do + inline_macro Git::Documentation::LinkGitProcessor, :linkgit + block Git::Documentation::SynopsisBlock + postprocessor Git::Documentation::DocumentPostProcessor +end diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.adoc similarity index 99% rename from Documentation/blame-options.txt rename to Documentation/blame-options.adoc index 552dcc60f2a41e..aa77406d4ef335 100644 --- a/Documentation/blame-options.txt +++ b/Documentation/blame-options.adoc @@ -18,7 +18,7 @@ '' and '' are optional. `-L ` or `-L ,` spans from '' to end of file. `-L ,` spans from start of file to ''. + -include::line-range-format.txt[] +include::line-range-format.adoc[] -l:: Show long rev (Default: off). diff --git a/Documentation/build-docdep.perl b/Documentation/build-docdep.perl index 1b3ac8fdd95fa1..781da12b2ee8c9 100755 --- a/Documentation/build-docdep.perl +++ b/Documentation/build-docdep.perl @@ -1,16 +1,18 @@ #!/usr/bin/perl +my ($build_dir) = @ARGV; my %include = (); my %included = (); -for my $text (<*.txt>) { - open I, '<', $text || die "cannot read: $text"; +for my $adoc (<*.adoc>) { + open I, '<', $adoc || die "cannot read: $adoc"; while () { if (/^include::/) { chomp; s/^include::\s*//; s/\[\]//; - $include{$text}{$_} = 1; + s/{build_dir}/${build_dir}/; + $include{$adoc}{$_} = 1; $included{$_} = 1; } } @@ -21,14 +23,14 @@ my $changed = 1; while ($changed) { $changed = 0; - while (my ($text, $included) = each %include) { + while (my ($adoc, $included) = each %include) { for my $i (keys %$included) { - # $text has include::$i; if $i includes $j - # $text indirectly includes $j. + # $adoc has include::$i; if $i includes $j + # $adoc indirectly includes $j. if (exists $include{$i}) { for my $j (keys %{$include{$i}}) { - if (!exists $include{$text}{$j}) { - $include{$text}{$j} = 1; + if (!exists $include{$adoc}{$j}) { + $include{$adoc}{$j} = 1; $included{$j} = 1; $changed = 1; } @@ -38,10 +40,10 @@ } } -foreach my $text (sort keys %include) { - my $included = $include{$text}; - if (! exists $included{$text} && - (my $base = $text) =~ s/\.txt$//) { +foreach my $adoc (sort keys %include) { + my $included = $include{$adoc}; + if (! exists $included{$adoc} && + (my $base = $adoc) =~ s/\.adoc$//) { print "$base.html $base.xml : ", join(" ", sort keys %$included), "\n"; } } diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl index 755a110bc48d7e..0a0c1b3f611450 100755 --- a/Documentation/cmd-list.perl +++ b/Documentation/cmd-list.perl @@ -3,12 +3,13 @@ use File::Compare qw(compare); sub format_one { - my ($out, $nameattr) = @_; + my ($source_dir, $out, $nameattr) = @_; my ($name, $attr) = @$nameattr; + my ($path) = "$source_dir/Documentation/$name.adoc"; my ($state, $description); my $mansection; $state = 0; - open I, '<', "$name.txt" or die "No such file $name.txt"; + open I, '<', "$path" or die "No such file $path.adoc"; while () { if (/^(?:git|scalar)[a-z0-9-]*\(([0-9])\)$/) { $mansection = $1; @@ -29,7 +30,7 @@ sub format_one { } close I; if (!defined $description) { - die "No description found in $name.txt"; + die "No description found in $path.adoc"; } if (my ($verify_name, $text) = ($description =~ /^($name) - (.*)/)) { print $out "linkgit:$name\[$mansection\]::\n\t"; @@ -43,9 +44,9 @@ sub format_one { } } -my ($input, @categories) = @ARGV; +my ($source_dir, $build_dir, @categories) = @ARGV; -open IN, "<$input"; +open IN, "<$source_dir/command-list.txt"; while () { last if /^### command list/; } @@ -62,18 +63,18 @@ sub format_one { close IN; for my $out (@categories) { - my ($cat) = $out =~ /^cmds-(.*)\.txt$/; - open O, '>', "$out+" or die "Cannot open output file $out+"; + my ($cat) = $out =~ /^cmds-(.*)\.adoc$/; + my ($path) = "$build_dir/$out"; + open O, '>', "$path+" or die "Cannot open output file $out+"; for (@{$cmds{$cat}}) { - format_one(\*O, $_); + format_one($source_dir, \*O, $_); } close O; - if (-f "$out" && compare("$out", "$out+") == 0) { - unlink "$out+"; + if (-f "$path" && compare("$path", "$path+") == 0) { + unlink "$path+"; } else { - print STDERR "$out\n"; - rename "$out+", "$out"; + rename "$path+", "$path"; } } diff --git a/Documentation/config.txt b/Documentation/config.adoc similarity index 84% rename from Documentation/config.txt rename to Documentation/config.adoc index 8c0b3ed8075214..959274686cd853 100644 --- a/Documentation/config.txt +++ b/Documentation/config.adoc @@ -372,186 +372,190 @@ inventing new variables for use in your own tool, make sure their names do not conflict with those that are used by Git itself and other popular tools, and describe them in your documentation. -include::config/add.txt[] +include::config/add.adoc[] -include::config/advice.txt[] +include::config/advice.adoc[] -include::config/alias.txt[] +include::config/alias.adoc[] -include::config/am.txt[] +include::config/am.adoc[] -include::config/apply.txt[] +include::config/apply.adoc[] -include::config/attr.txt[] +include::config/attr.adoc[] -include::config/bitmap-pseudo-merge.txt[] +include::config/bitmap-pseudo-merge.adoc[] -include::config/blame.txt[] +include::config/blame.adoc[] -include::config/branch.txt[] +include::config/branch.adoc[] -include::config/browser.txt[] +include::config/browser.adoc[] -include::config/bundle.txt[] +include::config/bundle.adoc[] -include::config/checkout.txt[] +include::config/checkout.adoc[] -include::config/clean.txt[] +include::config/clean.adoc[] -include::config/clone.txt[] +include::config/clone.adoc[] -include::config/color.txt[] +include::config/color.adoc[] -include::config/column.txt[] +include::config/column.adoc[] -include::config/commit.txt[] +include::config/commit.adoc[] -include::config/commitgraph.txt[] +include::config/commitgraph.adoc[] -include::config/completion.txt[] +include::config/completion.adoc[] -include::config/core.txt[] +include::config/core.adoc[] -include::config/credential.txt[] +include::config/credential.adoc[] -include::config/diff.txt[] +include::config/diff.adoc[] -include::config/difftool.txt[] +include::config/difftool.adoc[] -include::config/extensions.txt[] +include::config/extensions.adoc[] -include::config/fastimport.txt[] +include::config/fastimport.adoc[] -include::config/feature.txt[] +include::config/feature.adoc[] -include::config/fetch.txt[] +include::config/fetch.adoc[] -include::config/filter.txt[] +include::config/filter.adoc[] -include::config/format.txt[] +include::config/format.adoc[] -include::config/fsck.txt[] +include::config/fsck.adoc[] -include::config/fsmonitor--daemon.txt[] +include::config/fsmonitor--daemon.adoc[] -include::config/gc.txt[] +include::config/gc.adoc[] -include::config/gitcvs.txt[] +include::config/gitcvs.adoc[] -include::config/gitweb.txt[] +include::config/gitweb.adoc[] -include::config/gpg.txt[] +include::config/gpg.adoc[] -include::config/grep.txt[] +include::config/grep.adoc[] -include::config/gui.txt[] +include::config/gui.adoc[] -include::config/guitool.txt[] +include::config/guitool.adoc[] -include::config/help.txt[] +include::config/help.adoc[] -include::config/http.txt[] +include::config/http.adoc[] -include::config/i18n.txt[] +include::config/i18n.adoc[] -include::config/imap.txt[] +include::config/imap.adoc[] -include::config/includeif.txt[] +include::config/includeif.adoc[] -include::config/index.txt[] +include::config/index.adoc[] -include::config/init.txt[] +include::config/init.adoc[] -include::config/instaweb.txt[] +include::config/instaweb.adoc[] -include::config/interactive.txt[] +include::config/interactive.adoc[] -include::config/log.txt[] +include::config/log.adoc[] -include::config/lsrefs.txt[] +include::config/lsrefs.adoc[] -include::config/mailinfo.txt[] +include::config/mailinfo.adoc[] -include::config/mailmap.txt[] +include::config/mailmap.adoc[] -include::config/maintenance.txt[] +include::config/maintenance.adoc[] -include::config/man.txt[] +include::config/man.adoc[] -include::config/merge.txt[] +include::config/merge.adoc[] -include::config/mergetool.txt[] +include::config/mergetool.adoc[] -include::config/notes.txt[] +include::config/notes.adoc[] -include::config/pack.txt[] +include::config/pack.adoc[] -include::config/pager.txt[] +include::config/pager.adoc[] -include::config/pretty.txt[] +include::config/pretty.adoc[] -include::config/promisor.txt[] +include::config/promisor.adoc[] -include::config/protocol.txt[] +include::config/protocol.adoc[] -include::config/pull.txt[] +include::config/pull.adoc[] -include::config/push.txt[] +include::config/push.adoc[] -include::config/rebase.txt[] +include::config/rebase.adoc[] -include::config/receive.txt[] +include::config/receive.adoc[] -include::config/reftable.txt[] +include::config/reftable.adoc[] -include::config/remote.txt[] +include::config/remote.adoc[] -include::config/remotes.txt[] +include::config/remotes.adoc[] -include::config/repack.txt[] +include::config/repack.adoc[] -include::config/rerere.txt[] +include::config/rerere.adoc[] -include::config/revert.txt[] +include::config/revert.adoc[] -include::config/safe.txt[] +include::config/safe.adoc[] -include::config/sendemail.txt[] +include::config/sendemail.adoc[] -include::config/sequencer.txt[] +include::config/sequencer.adoc[] -include::config/showbranch.txt[] +include::config/showbranch.adoc[] -include::config/sparse.txt[] +include::config/sparse.adoc[] -include::config/splitindex.txt[] +include::config/splitindex.adoc[] -include::config/ssh.txt[] +include::config/ssh.adoc[] -include::config/stash.txt[] +include::config/stash.adoc[] -include::config/status.txt[] +include::config/status.adoc[] -include::config/submodule.txt[] +include::config/submodule.adoc[] -include::config/tag.txt[] +include::config/survey.adoc[] -include::config/tar.txt[] +include::config/tag.adoc[] -include::config/trace2.txt[] +include::config/tar.adoc[] -include::config/transfer.txt[] +include::config/trace2.adoc[] -include::config/uploadarchive.txt[] +include::config/trailer.adoc[] -include::config/uploadpack.txt[] +include::config/transfer.adoc[] -include::config/url.txt[] +include::config/uploadarchive.adoc[] -include::config/user.txt[] +include::config/uploadpack.adoc[] -include::config/versionsort.txt[] +include::config/url.adoc[] -include::config/web.txt[] +include::config/user.adoc[] -include::config/worktree.txt[] +include::config/versionsort.adoc[] + +include::config/web.adoc[] + +include::config/worktree.adoc[] diff --git a/Documentation/config/add.adoc b/Documentation/config/add.adoc new file mode 100644 index 00000000000000..7497533cbccf4e --- /dev/null +++ b/Documentation/config/add.adoc @@ -0,0 +1,12 @@ +`add.ignoreErrors`:: +`add.ignore-errors` (deprecated):: + Tells `git add` to continue adding files when some files cannot be + added due to indexing errors. +ifdef::git-add[] + Equivalent to the `--ignore-errors` option. +endif::git-add[] +ifndef::git-add[] + Equivalent to the `--ignore-errors` option of linkgit:git-add[1]. +endif::git-add[] + `add.ignore-errors` is deprecated, as it does not follow the usual + naming convention for configuration variables. diff --git a/Documentation/config/add.txt b/Documentation/config/add.txt deleted file mode 100644 index 4d753f006ec1ef..00000000000000 --- a/Documentation/config/add.txt +++ /dev/null @@ -1,7 +0,0 @@ -add.ignoreErrors:: -add.ignore-errors (deprecated):: - Tells 'git add' to continue adding files when some files cannot be - added due to indexing errors. Equivalent to the `--ignore-errors` - option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, - as it does not follow the usual naming convention for configuration - variables. diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.adoc similarity index 100% rename from Documentation/config/advice.txt rename to Documentation/config/advice.adoc diff --git a/Documentation/config/alias.txt b/Documentation/config/alias.adoc similarity index 100% rename from Documentation/config/alias.txt rename to Documentation/config/alias.adoc diff --git a/Documentation/config/am.txt b/Documentation/config/am.adoc similarity index 100% rename from Documentation/config/am.txt rename to Documentation/config/am.adoc diff --git a/Documentation/config/apply.txt b/Documentation/config/apply.adoc similarity index 100% rename from Documentation/config/apply.txt rename to Documentation/config/apply.adoc diff --git a/Documentation/config/attr.txt b/Documentation/config/attr.adoc similarity index 100% rename from Documentation/config/attr.txt rename to Documentation/config/attr.adoc diff --git a/Documentation/config/bitmap-pseudo-merge.txt b/Documentation/config/bitmap-pseudo-merge.adoc similarity index 100% rename from Documentation/config/bitmap-pseudo-merge.txt rename to Documentation/config/bitmap-pseudo-merge.adoc diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.adoc similarity index 100% rename from Documentation/config/blame.txt rename to Documentation/config/blame.adoc diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.adoc similarity index 100% rename from Documentation/config/branch.txt rename to Documentation/config/branch.adoc diff --git a/Documentation/config/browser.txt b/Documentation/config/browser.adoc similarity index 100% rename from Documentation/config/browser.txt rename to Documentation/config/browser.adoc diff --git a/Documentation/config/bundle.txt b/Documentation/config/bundle.adoc similarity index 100% rename from Documentation/config/bundle.txt rename to Documentation/config/bundle.adoc diff --git a/Documentation/config/checkout.txt b/Documentation/config/checkout.adoc similarity index 100% rename from Documentation/config/checkout.txt rename to Documentation/config/checkout.adoc diff --git a/Documentation/config/clean.txt b/Documentation/config/clean.adoc similarity index 100% rename from Documentation/config/clean.txt rename to Documentation/config/clean.adoc diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.adoc similarity index 100% rename from Documentation/config/clone.txt rename to Documentation/config/clone.adoc diff --git a/Documentation/config/color.txt b/Documentation/config/color.adoc similarity index 100% rename from Documentation/config/color.txt rename to Documentation/config/color.adoc diff --git a/Documentation/config/column.txt b/Documentation/config/column.adoc similarity index 100% rename from Documentation/config/column.txt rename to Documentation/config/column.adoc diff --git a/Documentation/config/commit.txt b/Documentation/config/commit.adoc similarity index 67% rename from Documentation/config/commit.txt rename to Documentation/config/commit.adoc index 62f0d92fda51de..d3f4624fd27811 100644 --- a/Documentation/config/commit.txt +++ b/Documentation/config/commit.adoc @@ -1,29 +1,34 @@ -commit.cleanup:: +ifdef::git-commit[] +:see-git-commit: +endif::git-commit[] +ifndef::git-commit[] +:see-git-commit: See linkgit:git-commit[1] for details. +endif::git-commit[] +`commit.cleanup`:: This setting overrides the default of the `--cleanup` option in - `git commit`. See linkgit:git-commit[1] for details. Changing the - default can be useful when you always want to keep lines that begin + `git commit`. {see-git-commit} Changing the default can be useful + when you always want to keep lines that begin with the comment character `#` in your log message, in which case you would do `git config commit.cleanup whitespace` (note that you will have to remove the help lines that begin with `#` in the commit log template yourself, if you do this). -commit.gpgSign:: - +`commit.gpgSign`:: A boolean to specify whether all commits should be GPG signed. Use of this option when doing operations such as rebase can result in a large number of commits being signed. It may be convenient to use an agent to avoid typing your GPG passphrase several times. -commit.status:: +`commit.status`:: A boolean to enable/disable inclusion of status information in the commit message template when using an editor to prepare the commit - message. Defaults to true. + message. Defaults to `true`. -commit.template:: +`commit.template`:: Specify the pathname of a file to use as the template for new commit messages. -commit.verbose:: +`commit.verbose`:: A boolean or int to specify the level of verbosity with `git commit`. - See linkgit:git-commit[1]. + {see-git-commit} diff --git a/Documentation/config/commitgraph.txt b/Documentation/config/commitgraph.adoc similarity index 100% rename from Documentation/config/commitgraph.txt rename to Documentation/config/commitgraph.adoc diff --git a/Documentation/config/completion.txt b/Documentation/config/completion.adoc similarity index 100% rename from Documentation/config/completion.txt rename to Documentation/config/completion.adoc diff --git a/Documentation/config/core.txt b/Documentation/config/core.adoc similarity index 99% rename from Documentation/config/core.txt rename to Documentation/config/core.adoc index 60ca9f2b686106..8f6d8e77541261 100644 --- a/Documentation/config/core.txt +++ b/Documentation/config/core.adoc @@ -366,7 +366,7 @@ default in a bare repository. core.repositoryFormatVersion:: Internal variable identifying the repository format and layout - version. + version. See linkgit:gitrepository-layout[5]. core.sharedRepository:: When 'group' (or 'true'), the repository is made shareable between diff --git a/Documentation/config/credential.txt b/Documentation/config/credential.adoc similarity index 80% rename from Documentation/config/credential.txt rename to Documentation/config/credential.adoc index 470482ff4c2a38..80a7c777720793 100644 --- a/Documentation/config/credential.txt +++ b/Documentation/config/credential.adoc @@ -22,6 +22,17 @@ credential.useHttpPath:: or https URL to be important. Defaults to false. See linkgit:gitcredentials[7] for more information. +credential.sanitizePrompt:: + By default, user names and hosts that are shown as part of the + password prompt are not allowed to contain control characters (they + will be URL-encoded by default). Configure this setting to `false` to + override that behavior. + +credential.protectProtocol:: + By default, Carriage Return characters are not allowed in the protocol + that is used when Git talks to a credential helper. This setting allows + users to override this default. + credential.username:: If no username is set for a network authentication, use this username by default. See credential..* below, and diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.adoc similarity index 57% rename from Documentation/config/diff.txt rename to Documentation/config/diff.adoc index 190bda17e51c57..1135a62a0ad3de 100644 --- a/Documentation/config/diff.txt +++ b/Documentation/config/diff.adoc @@ -1,18 +1,25 @@ -diff.autoRefreshIndex:: - When using 'git diff' to compare with work tree +`diff.autoRefreshIndex`:: + When using `git diff` to compare with work tree files, do not consider stat-only changes as changed. Instead, silently run `git update-index --refresh` to update the cached stat information for paths whose contents in the work tree match the contents in the - index. This option defaults to true. Note that this - affects only 'git diff' Porcelain, and not lower level - 'diff' commands such as 'git diff-files'. + index. This option defaults to `true`. Note that this + affects only `git diff` Porcelain, and not lower level + `diff` commands such as `git diff-files`. -diff.dirstat:: +`diff.dirstat`:: +ifdef::git-diff[] + A comma separated list of `--dirstat` parameters specifying the + default behavior of the `--dirstat` option to `git diff` and friends. +endif::git-diff[] +ifndef::git-diff[] A comma separated list of `--dirstat` parameters specifying the default behavior of the `--dirstat` option to linkgit:git-diff[1] - and friends. The defaults can be overridden on the command line - (using `--dirstat=`). The fallback defaults + and friends. +endif::git-diff[] + The defaults can be overridden on the command line + (using `--dirstat=,...`). The fallback defaults (when not changed by `diff.dirstat`) are `changes,noncumulative,3`. The following parameters are available: + @@ -41,7 +48,7 @@ diff.dirstat:: Note that when using `cumulative`, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can be specified with the `noncumulative` parameter. -;; +__;; An integer parameter specifies a cut-off percent (3% by default). Directories contributing less than this percentage of the changes are not shown in the output. @@ -52,58 +59,58 @@ directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: `files,10,cumulative`. -diff.statNameWidth:: - Limit the width of the filename part in --stat output. If set, applies - to all commands generating --stat output except format-patch. +`diff.statNameWidth`:: + Limit the width of the filename part in `--stat` output. If set, applies + to all commands generating `--stat` output except `format-patch`. -diff.statGraphWidth:: - Limit the width of the graph part in --stat output. If set, applies - to all commands generating --stat output except format-patch. +`diff.statGraphWidth`:: + Limit the width of the graph part in `--stat` output. If set, applies + to all commands generating `--stat` output except `format-patch`. -diff.context:: - Generate diffs with lines of context instead of the default - of 3. This value is overridden by the -U option. +`diff.context`:: + Generate diffs with __ lines of context instead of the default + of 3. This value is overridden by the `-U` option. -diff.interHunkContext:: +`diff.interHunkContext`:: Show the context between diff hunks, up to the specified number of lines, thereby fusing the hunks that are close to each other. This value serves as the default for the `--inter-hunk-context` command line option. -diff.external:: +`diff.external`:: If this config variable is set, diff generation is not performed using the internal diff machinery, but using the - given command. Can be overridden with the `GIT_EXTERNAL_DIFF' + given command. Can be overridden with the `GIT_EXTERNAL_DIFF` environment variable. The command is called with parameters as described under "git Diffs" in linkgit:git[1]. Note: if you want to use an external diff program only on a subset of your files, you might want to use linkgit:gitattributes[5] instead. -diff.trustExitCode:: - If this boolean value is set to true then the +`diff.trustExitCode`:: + If this boolean value is set to `true` then the `diff.external` command is expected to return exit code 0 if it considers the input files to be equal or 1 if it - considers them to be different, like `diff(1)`. - If it is set to false, which is the default, then the command - is expected to return exit code 0 regardless of equality. + considers them to be different, like `diff`(1). + If it is set to `false`, which is the default, then the command + is expected to return exit code `0` regardless of equality. Any other exit code causes Git to report a fatal error. -diff.ignoreSubmodules:: - Sets the default value of --ignore-submodules. Note that this - affects only 'git diff' Porcelain, and not lower level 'diff' - commands such as 'git diff-files'. 'git checkout' - and 'git switch' also honor +`diff.ignoreSubmodules`:: + Sets the default value of `--ignore-submodules`. Note that this + affects only `git diff` Porcelain, and not lower level `diff` + commands such as `git diff-files`. `git checkout` + and `git switch` also honor this setting when reporting uncommitted changes. Setting it to - 'all' disables the submodule summary normally shown by 'git commit' - and 'git status' when `status.submoduleSummary` is set unless it is - overridden by using the --ignore-submodules command-line option. - The 'git submodule' commands are not affected by this setting. + `all` disables the submodule summary normally shown by `git commit` + and `git status` when `status.submoduleSummary` is set unless it is + overridden by using the `--ignore-submodules` command-line option. + The `git submodule` commands are not affected by this setting. By default this is set to untracked so that any untracked submodules are ignored. -diff.mnemonicPrefix:: - If set, 'git diff' uses a prefix pair that is different from the - standard "a/" and "b/" depending on what is being compared. When +`diff.mnemonicPrefix`:: + If set, `git diff` uses a prefix pair that is different from the + standard `a/` and `b/` depending on what is being compared. When this configuration is in effect, reverse diff output also swaps the order of the prefixes: `git diff`;; @@ -112,111 +119,115 @@ diff.mnemonicPrefix:: compares a (c)ommit and the (w)ork tree; `git diff --cached`;; compares a (c)ommit and the (i)ndex; -`git diff HEAD:file1 file2`;; +`git diff HEAD: `;; compares an (o)bject and a (w)ork tree entity; -`git diff --no-index a b`;; - compares two non-git things (1) and (2). +`git diff --no-index `;; + compares two non-git things __ and __. -diff.noPrefix:: - If set, 'git diff' does not show any source or destination prefix. +`diff.noPrefix`:: + If set, `git diff` does not show any source or destination prefix. -diff.srcPrefix:: - If set, 'git diff' uses this source prefix. Defaults to "a/". +`diff.srcPrefix`:: + If set, `git diff` uses this source prefix. Defaults to `a/`. -diff.dstPrefix:: - If set, 'git diff' uses this destination prefix. Defaults to "b/". +`diff.dstPrefix`:: + If set, `git diff` uses this destination prefix. Defaults to `b/`. -diff.relative:: - If set to 'true', 'git diff' does not show changes outside of the directory +`diff.relative`:: + If set to `true`, `git diff` does not show changes outside of the directory and show pathnames relative to the current directory. -diff.orderFile:: +`diff.orderFile`:: File indicating how to order files within a diff. - See the '-O' option to linkgit:git-diff[1] for details. +ifdef::git-diff[] + See the `-O` option for details. +endif::git-diff[] +ifndef::git-diff[] + See the `-O` option to linkgit:git-diff[1] for details. +endif::git-diff[] If `diff.orderFile` is a relative pathname, it is treated as relative to the top of the working tree. -diff.renameLimit:: +`diff.renameLimit`:: The number of files to consider in the exhaustive portion of - copy/rename detection; equivalent to the 'git diff' option + 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. -diff.renames:: - Whether and how Git detects renames. If set to "false", - rename detection is disabled. If set to "true", basic rename - detection is enabled. If set to "copies" or "copy", Git will - detect copies, as well. Defaults to true. Note that this - affects only 'git diff' Porcelain like linkgit:git-diff[1] and +`diff.renames`:: + Whether and how Git detects renames. If set to `false`, + rename detection is disabled. If set to `true`, basic rename + detection is enabled. If set to `copies` or `copy`, Git will + detect copies, as well. Defaults to `true`. Note that this + affects only `git diff` Porcelain like linkgit:git-diff[1] and linkgit:git-log[1], and not lower level commands such as linkgit:git-diff-files[1]. -diff.suppressBlankEmpty:: +`diff.suppressBlankEmpty`:: A boolean to inhibit the standard behavior of printing a space - before each empty output line. Defaults to false. + before each empty output line. Defaults to `false`. -diff.submodule:: +`diff.submodule`:: Specify the format in which differences in submodules are - shown. The "short" format just shows the names of the commits - at the beginning and end of the range. The "log" format lists + shown. The `short` format just shows the names of the commits + at the beginning and end of the range. The `log` format lists the commits in the range like linkgit:git-submodule[1] `summary` - does. The "diff" format shows an inline diff of the changed - contents of the submodule. Defaults to "short". + does. The `diff` format shows an inline diff of the changed + contents of the submodule. Defaults to `short`. -diff.wordRegex:: +`diff.wordRegex`:: A POSIX Extended Regular Expression used to determine what is a "word" when performing word-by-word difference calculations. Character sequences that match the regular expression are "words", all other characters are *ignorable* whitespace. -diff..command:: +`diff..command`:: The custom diff driver command. See linkgit:gitattributes[5] for details. -diff..trustExitCode:: - If this boolean value is set to true then the +`diff..trustExitCode`:: + If this boolean value is set to `true` then the `diff..command` command is expected to return exit code 0 if it considers the input files to be equal or 1 if it - considers them to be different, like `diff(1)`. - If it is set to false, which is the default, then the command + considers them to be different, like `diff`(1). + If it is set to `false`, which is the default, then the command is expected to return exit code 0 regardless of equality. Any other exit code causes Git to report a fatal error. -diff..xfuncname:: +`diff..xfuncname`:: The regular expression that the diff driver should use to recognize the hunk header. A built-in pattern may also be used. See linkgit:gitattributes[5] for details. -diff..binary:: - Set this option to true to make the diff driver treat files as +`diff..binary`:: + Set this option to `true` to make the diff driver treat files as binary. See linkgit:gitattributes[5] for details. -diff..textconv:: +`diff..textconv`:: The command that the diff driver should call to generate the text-converted version of a file. The result of the conversion is used to generate a human-readable diff. See linkgit:gitattributes[5] for details. -diff..wordRegex:: +`diff..wordRegex`:: The regular expression that the diff driver should use to split words in a line. See linkgit:gitattributes[5] for details. -diff..cachetextconv:: - Set this option to true to make the diff driver cache the text +`diff..cachetextconv`:: + Set this option to `true` to make the diff driver cache the text conversion outputs. See linkgit:gitattributes[5] for details. -include::../mergetools-diff.txt[] - -diff.indentHeuristic:: +`diff.indentHeuristic`:: Set this option to `false` to disable the default heuristics that shift diff hunk boundaries to make patches easier to read. -diff.algorithm:: +`diff.algorithm`:: Choose a diff algorithm. The variants are as follows: + -- -`default`, `myers`;; +`default`;; +`myers`;; The basic greedy diff algorithm. Currently, this is the default. `minimal`;; Spend extra time to make sure the smallest possible diff is @@ -229,7 +240,7 @@ diff.algorithm:: -- + -diff.wsErrorHighlight:: +`diff.wsErrorHighlight`:: Highlight whitespace errors in the `context`, `old` or `new` lines of the diff. Multiple values are separated by comma, `none` resets previous values, `default` reset the list to @@ -238,14 +249,19 @@ diff.wsErrorHighlight:: The command line option `--ws-error-highlight=` overrides this setting. -diff.colorMoved:: - If set to either a valid `` or a true value, moved lines - in a diff are colored differently, for details of valid modes - see '--color-moved' in linkgit:git-diff[1]. If simply set to - true the default color mode will be used. When set to false, - moved lines are not colored. - -diff.colorMovedWS:: +`diff.colorMoved`:: + If set to either a valid __ or a `true` value, moved lines + in a diff are colored differently. +ifdef::git-diff[] + For details of valid modes see `--color-moved`. +endif::git-diff[] +ifndef::git-diff[] + For details of valid modes see `--color-moved` in linkgit:git-diff[1]. +endif::git-diff[] + If simply set to `true` the default color mode will be used. When + set to `false`, moved lines are not colored. + +`diff.colorMovedWS`:: When moved lines are colored using e.g. the `diff.colorMoved` setting, - this option controls the `` how spaces are treated. - For details of valid modes see '--color-moved-ws' in linkgit:git-diff[1]. + this option controls the mode how spaces are treated. + For details of valid modes see `--color-moved-ws` in linkgit:git-diff[1]. diff --git a/Documentation/config/difftool.txt b/Documentation/config/difftool.adoc similarity index 97% rename from Documentation/config/difftool.txt rename to Documentation/config/difftool.adoc index 447c40d85a289d..4f7d40ce242b78 100644 --- a/Documentation/config/difftool.txt +++ b/Documentation/config/difftool.adoc @@ -13,6 +13,8 @@ diff.guitool:: and requires that a corresponding difftool..cmd variable is defined. +include::{build_dir}/mergetools-diff.adoc[] + difftool..cmd:: Specify the command to invoke the specified diff tool. The specified command is evaluated in shell with the following diff --git a/Documentation/config/extensions.txt b/Documentation/config/extensions.adoc similarity index 51% rename from Documentation/config/extensions.txt rename to Documentation/config/extensions.adoc index 38dce3df359761..9e2f321a6d776f 100644 --- a/Documentation/config/extensions.txt +++ b/Documentation/config/extensions.adoc @@ -1,17 +1,13 @@ -extensions.objectFormat:: - Specify the hash algorithm to use. The acceptable values are `sha1` and - `sha256`. If not specified, `sha1` is assumed. It is an error to specify - this key unless `core.repositoryFormatVersion` is 1. +extensions.*:: + Unless otherwise stated, is an error to specify an extension if + `core.repositoryFormatVersion` is not `1`. See + linkgit:gitrepository-layout[5]. + -Note that this setting should only be set by linkgit:git-init[1] or -linkgit:git-clone[1]. Trying to change it after initialization will not -work and will produce hard-to-diagnose issues. - -extensions.compatObjectFormat:: - - Specify a compatitbility hash algorithm to use. The acceptable values +-- +compatObjectFormat:: + Specify a compatibility hash algorithm to use. The acceptable values are `sha1` and `sha256`. The value specified must be different from the - value of extensions.objectFormat. This allows client level + value of `extensions.objectFormat`. This allows client level interoperability between git repositories whose objectFormat matches this compatObjectFormat. In particular when fully implemented the pushes and pulls from a repository in whose objectFormat matches @@ -19,18 +15,61 @@ extensions.compatObjectFormat:: compatObjectFormat in addition to oids encoded with objectFormat to locally specify objects. -extensions.refStorage:: - Specify the ref storage format to use. The acceptable values are: +noop:: + This extension does not change git's behavior at all. It is useful only + for testing format-1 compatibility. ++ +For historical reasons, this extension is respected regardless of the +`core.repositoryFormatVersion` setting. + +noop-v1:: + This extension does not change git's behavior at all. It is useful only + for testing format-1 compatibility. + +objectFormat:: + Specify the hash algorithm to use. The acceptable values are `sha1` and + `sha256`. If not specified, `sha1` is assumed. ++ +Note that this setting should only be set by linkgit:git-init[1] or +linkgit:git-clone[1]. Trying to change it after initialization will not +work and will produce hard-to-diagnose issues. + +partialClone:: + When enabled, indicates that the repo was created with a partial clone + (or later performed a partial fetch) and that the remote may have + omitted sending certain unwanted objects. Such a remote is called a + "promisor remote" and it promises that all such omitted objects can + be fetched from it in the future. ++ +The value of this key is the name of the promisor remote. ++ +For historical reasons, this extension is respected regardless of the +`core.repositoryFormatVersion` setting. + +preciousObjects:: + If enabled, indicates that objects in the repository MUST NOT be deleted + (e.g., by `git-prune` or `git repack -d`). + -include::../ref-storage-format.txt[] +For historical reasons, this extension is respected regardless of the +`core.repositoryFormatVersion` setting. + +refStorage:: + Specify the ref storage format to use. The acceptable values are: + -It is an error to specify this key unless `core.repositoryFormatVersion` is 1. +include::../ref-storage-format.adoc[] + + Note that this setting should only be set by linkgit:git-init[1] or linkgit:git-clone[1]. Trying to change it after initialization will not work and will produce hard-to-diagnose issues. -extensions.worktreeConfig:: +relativeWorktrees:: + If enabled, indicates at least one worktree has been linked with + relative paths. Automatically set if a worktree has been created or + repaired with either the `--relative-paths` option or with the + `worktree.useRelativePaths` config set to `true`. + +worktreeConfig:: If enabled, then worktrees will load config settings from the `$GIT_DIR/config.worktree` file in addition to the `$GIT_COMMON_DIR/config` file. Note that `$GIT_COMMON_DIR` and @@ -40,7 +79,7 @@ extensions.worktreeConfig:: `config.worktree` file will override settings from any other config files. + -When enabling `extensions.worktreeConfig`, you must be careful to move +When enabling this extension, you must be careful to move certain values from the common config file to the main working tree's `config.worktree` file, if present: + @@ -48,15 +87,17 @@ certain values from the common config file to the main working tree's `$GIT_COMMON_DIR/config.worktree`. * If `core.bare` is true, then it must be moved from `$GIT_COMMON_DIR/config` to `$GIT_COMMON_DIR/config.worktree`. + + It may also be beneficial to adjust the locations of `core.sparseCheckout` and `core.sparseCheckoutCone` depending on your desire for customizable sparse-checkout settings for each worktree. By default, the `git -sparse-checkout` builtin enables `extensions.worktreeConfig`, assigns +sparse-checkout` builtin enables this extension, assigns these config values on a per-worktree basis, and uses the `$GIT_DIR/info/sparse-checkout` file to specify the sparsity for each worktree independently. See linkgit:git-sparse-checkout[1] for more details. + -For historical reasons, `extensions.worktreeConfig` is respected -regardless of the `core.repositoryFormatVersion` setting. +For historical reasons, this extension is respected regardless of the +`core.repositoryFormatVersion` setting. +-- diff --git a/Documentation/config/fastimport.txt b/Documentation/config/fastimport.adoc similarity index 100% rename from Documentation/config/fastimport.txt rename to Documentation/config/fastimport.adoc diff --git a/Documentation/config/feature.txt b/Documentation/config/feature.adoc similarity index 100% rename from Documentation/config/feature.txt rename to Documentation/config/feature.adoc diff --git a/Documentation/config/fetch.txt b/Documentation/config/fetch.adoc similarity index 100% rename from Documentation/config/fetch.txt rename to Documentation/config/fetch.adoc diff --git a/Documentation/config/filter.txt b/Documentation/config/filter.adoc similarity index 100% rename from Documentation/config/filter.txt rename to Documentation/config/filter.adoc diff --git a/Documentation/config/fmt-merge-msg.txt b/Documentation/config/fmt-merge-msg.adoc similarity index 100% rename from Documentation/config/fmt-merge-msg.txt rename to Documentation/config/fmt-merge-msg.adoc diff --git a/Documentation/config/format.txt b/Documentation/config/format.adoc similarity index 100% rename from Documentation/config/format.txt rename to Documentation/config/format.adoc diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.adoc similarity index 100% rename from Documentation/config/fsck.txt rename to Documentation/config/fsck.adoc diff --git a/Documentation/config/fsmonitor--daemon.txt b/Documentation/config/fsmonitor--daemon.adoc similarity index 100% rename from Documentation/config/fsmonitor--daemon.txt rename to Documentation/config/fsmonitor--daemon.adoc diff --git a/Documentation/config/gc.txt b/Documentation/config/gc.adoc similarity index 99% rename from Documentation/config/gc.txt rename to Documentation/config/gc.adoc index 1d4f9470ead207..21d56db2798935 100644 --- a/Documentation/config/gc.txt +++ b/Documentation/config/gc.adoc @@ -163,7 +163,7 @@ gc.repackFilterTo:: containing the filtered out objects. **WARNING:** The specified location should be accessible, using for example the Git alternates mechanism, otherwise the repo could be - considered corrupt by Git as it migh not be able to access the + considered corrupt by Git as it might not be able to access the objects in that packfile. See the `--filter-to=` option of linkgit:git-repack[1] and the `objects/info/alternates` section of linkgit:gitrepository-layout[5]. diff --git a/Documentation/config/gitcvs.txt b/Documentation/config/gitcvs.adoc similarity index 100% rename from Documentation/config/gitcvs.txt rename to Documentation/config/gitcvs.adoc diff --git a/Documentation/config/gitweb.txt b/Documentation/config/gitweb.adoc similarity index 100% rename from Documentation/config/gitweb.txt rename to Documentation/config/gitweb.adoc diff --git a/Documentation/config/gpg.txt b/Documentation/config/gpg.adoc similarity index 100% rename from Documentation/config/gpg.txt rename to Documentation/config/gpg.adoc diff --git a/Documentation/config/grep.txt b/Documentation/config/grep.adoc similarity index 100% rename from Documentation/config/grep.txt rename to Documentation/config/grep.adoc diff --git a/Documentation/config/gui.txt b/Documentation/config/gui.adoc similarity index 100% rename from Documentation/config/gui.txt rename to Documentation/config/gui.adoc diff --git a/Documentation/config/guitool.txt b/Documentation/config/guitool.adoc similarity index 100% rename from Documentation/config/guitool.txt rename to Documentation/config/guitool.adoc diff --git a/Documentation/config/help.txt b/Documentation/config/help.adoc similarity index 81% rename from Documentation/config/help.txt rename to Documentation/config/help.adoc index 610701f9a3745e..b369589cec9474 100644 --- a/Documentation/config/help.txt +++ b/Documentation/config/help.adoc @@ -11,13 +11,14 @@ help.autoCorrect:: If git detects typos and can identify exactly one valid command similar to the error, git will try to suggest the correct command or even run the suggestion automatically. Possible config values are: - - 0 (default): show the suggested command. - - positive number: run the suggested command after specified + - 0, "false", "off", "no", "show": show the suggested command (default). + - 1, "true", "on", "yes", "immediate": run the suggested command +immediately. + - positive number > 1: run the suggested command after specified deciseconds (0.1 sec). - - "immediate": run the suggested command immediately. + - "never": don't run or show any suggested command. - "prompt": show the suggestion and prompt for confirmation to run the command. - - "never": don't run or show any suggested command. help.htmlPath:: Specify the path where the HTML documentation resides. File system paths diff --git a/Documentation/config/http.txt b/Documentation/config/http.adoc similarity index 95% rename from Documentation/config/http.txt rename to Documentation/config/http.adoc index a14371b5c96a51..22a8803deaf964 100644 --- a/Documentation/config/http.txt +++ b/Documentation/config/http.adoc @@ -216,6 +216,21 @@ http.sslBackend:: This option is ignored if cURL lacks support for choosing the SSL backend at runtime. +http.sslCertType:: + Type of client certificate used when fetching or pushing over HTTPS. + "PEM", "DER" are supported when using openssl or gnutls backends. "P12" + is supported on "openssl", "schannel", "securetransport", and gnutls 8.11+. + See also libcurl `CURLOPT_SSLCERTTYPE`. Can be overridden by the + `GIT_SSL_CERT_TYPE` environment variable. + +http.sslKeyType:: + Type of client private key used when fetching or pushing over HTTPS. (e.g. + "PEM", "DER", or "ENG"). Only applicable when using "openssl" backend. "DER" + is not supported with openssl. Particularly useful when set to "ENG" for + authenticating with PKCS#11 tokens, with a PKCS#11 URL in sslCert option. + See also libcurl `CURLOPT_SSLKEYTYPE`. Can be overridden by the + `GIT_SSL_KEY_TYPE` environment variable. + http.schannelCheckRevoke:: Used to enforce or disable certificate revocation checks in cURL when http.sslBackend is set to "schannel". Defaults to `true` if diff --git a/Documentation/config/i18n.txt b/Documentation/config/i18n.adoc similarity index 100% rename from Documentation/config/i18n.txt rename to Documentation/config/i18n.adoc diff --git a/Documentation/config/imap.txt b/Documentation/config/imap.adoc similarity index 100% rename from Documentation/config/imap.txt rename to Documentation/config/imap.adoc diff --git a/Documentation/config/includeif.txt b/Documentation/config/includeif.adoc similarity index 100% rename from Documentation/config/includeif.txt rename to Documentation/config/includeif.adoc diff --git a/Documentation/config/index.txt b/Documentation/config/index.adoc similarity index 100% rename from Documentation/config/index.txt rename to Documentation/config/index.adoc diff --git a/Documentation/config/init.txt b/Documentation/config/init.adoc similarity index 100% rename from Documentation/config/init.txt rename to Documentation/config/init.adoc diff --git a/Documentation/config/instaweb.txt b/Documentation/config/instaweb.adoc similarity index 100% rename from Documentation/config/instaweb.txt rename to Documentation/config/instaweb.adoc diff --git a/Documentation/config/interactive.txt b/Documentation/config/interactive.adoc similarity index 100% rename from Documentation/config/interactive.txt rename to Documentation/config/interactive.adoc diff --git a/Documentation/config/log.txt b/Documentation/config/log.adoc similarity index 100% rename from Documentation/config/log.txt rename to Documentation/config/log.adoc diff --git a/Documentation/config/lsrefs.txt b/Documentation/config/lsrefs.adoc similarity index 100% rename from Documentation/config/lsrefs.txt rename to Documentation/config/lsrefs.adoc diff --git a/Documentation/config/mailinfo.txt b/Documentation/config/mailinfo.adoc similarity index 100% rename from Documentation/config/mailinfo.txt rename to Documentation/config/mailinfo.adoc diff --git a/Documentation/config/mailmap.txt b/Documentation/config/mailmap.adoc similarity index 100% rename from Documentation/config/mailmap.txt rename to Documentation/config/mailmap.adoc diff --git a/Documentation/config/maintenance.txt b/Documentation/config/maintenance.adoc similarity index 100% rename from Documentation/config/maintenance.txt rename to Documentation/config/maintenance.adoc diff --git a/Documentation/config/man.txt b/Documentation/config/man.adoc similarity index 100% rename from Documentation/config/man.txt rename to Documentation/config/man.adoc diff --git a/Documentation/config/merge.txt b/Documentation/config/merge.adoc similarity index 96% rename from Documentation/config/merge.txt rename to Documentation/config/merge.adoc index 8851b6cedef980..d2d0f21a712daf 100644 --- a/Documentation/config/merge.txt +++ b/Documentation/config/merge.adoc @@ -37,7 +37,7 @@ merge.verifySignatures:: If true, this is equivalent to the --verify-signatures command line option. See linkgit:git-merge[1] for details. -include::fmt-merge-msg.txt[] +include::fmt-merge-msg.adoc[] merge.renameLimit:: The number of files to consider in the exhaustive portion of @@ -69,7 +69,8 @@ merge.renormalize:: Tell Git that canonical representation of files in the repository has changed over time (e.g. earlier commits record text files with CRLF line endings, but recent ones use LF line - endings). In such a repository, Git can convert the data + endings). In such a repository, for each file where a + three-way content merge is needed, Git can convert the data recorded in commits to a canonical form before performing a merge to reduce unnecessary conflicts. For more information, see section "Merging branches with differing checkin/checkout @@ -101,7 +102,7 @@ merge.guitool:: Any other value is treated as a custom merge tool and requires that a corresponding mergetool..cmd variable is defined. -include::../mergetools-merge.txt[] +include::{build_dir}/mergetools-merge.adoc[] merge.verbosity:: Controls the amount of output shown by the recursive merge diff --git a/Documentation/config/mergetool.txt b/Documentation/config/mergetool.adoc similarity index 100% rename from Documentation/config/mergetool.txt rename to Documentation/config/mergetool.adoc diff --git a/Documentation/config/notes.txt b/Documentation/config/notes.adoc similarity index 73% rename from Documentation/config/notes.txt rename to Documentation/config/notes.adoc index 43db8e808d7ab7..b7e536496f51b7 100644 --- a/Documentation/config/notes.txt +++ b/Documentation/config/notes.adoc @@ -1,4 +1,4 @@ -notes.mergeStrategy:: +`notes.mergeStrategy`:: Which merge strategy to choose by default when resolving notes conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or `cat_sort_uniq`. Defaults to `manual`. See the "NOTES MERGE STRATEGIES" @@ -7,17 +7,17 @@ notes.mergeStrategy:: This setting can be overridden by passing the `--strategy` option to linkgit:git-notes[1]. -notes..mergeStrategy:: +`notes..mergeStrategy`:: Which merge strategy to choose when doing a notes merge into - refs/notes/. This overrides the more general - "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in + `refs/notes/`. This overrides the more general + `notes.mergeStrategy`. See the "NOTES MERGE STRATEGIES" section in linkgit:git-notes[1] for more information on the available strategies. -notes.displayRef:: +`notes.displayRef`:: Which ref (or refs, if a glob or specified more than once), in addition to the default set by `core.notesRef` or `GIT_NOTES_REF`, to read notes from when showing commit - messages with the 'git log' family of commands. + messages with the `git log` family of commands. + This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` environment variable, which must be a colon separated list of refs or @@ -26,27 +26,27 @@ globs. A warning will be issued for refs that do not exist, but a glob that does not match any refs is silently ignored. + -This setting can be disabled by the `--no-notes` option to the 'git -log' family of commands, or by the `--notes=` option accepted by +This setting can be disabled by the `--no-notes` option to the linkgit:git-log[1] +family of commands, or by the `--notes=` option accepted by those commands. + -The effective value of "core.notesRef" (possibly overridden by -GIT_NOTES_REF) is also implicitly added to the list of refs to be +The effective value of `core.notesRef` (possibly overridden by +`GIT_NOTES_REF`) is also implicitly added to the list of refs to be displayed. -notes.rewrite.:: - When rewriting commits with (currently `amend` or +`notes.rewrite.`:: + When rewriting commits with __ (currently `amend` or `rebase`), if this variable is `false`, git will not copy notes from the original to the rewritten commit. Defaults to - `true`. See also "`notes.rewriteRef`" below. + `true`. See also `notes.rewriteRef` below. + This setting can be overridden with the `GIT_NOTES_REWRITE_REF` environment variable, which must be a colon separated list of refs or globs. -notes.rewriteMode:: +`notes.rewriteMode`:: When copying notes during a rewrite (see the - "notes.rewrite." option), determines what to do if + `notes.rewrite.` option), determines what to do if the target commit already has a note. Must be one of `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`. Defaults to `concatenate`. @@ -54,7 +54,7 @@ notes.rewriteMode:: This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` environment variable. -notes.rewriteRef:: +`notes.rewriteRef`:: When copying notes during a rewrite, specifies the (fully qualified) ref whose notes should be copied. May be a glob, in which case notes in all matching refs will be copied. You diff --git a/Documentation/config/pack.txt b/Documentation/config/pack.adoc similarity index 100% rename from Documentation/config/pack.txt rename to Documentation/config/pack.adoc diff --git a/Documentation/config/pager.txt b/Documentation/config/pager.adoc similarity index 100% rename from Documentation/config/pager.txt rename to Documentation/config/pager.adoc diff --git a/Documentation/config/pretty.txt b/Documentation/config/pretty.adoc similarity index 100% rename from Documentation/config/pretty.txt rename to Documentation/config/pretty.adoc diff --git a/Documentation/config/promisor.adoc b/Documentation/config/promisor.adoc new file mode 100644 index 00000000000000..9192acfd243097 --- /dev/null +++ b/Documentation/config/promisor.adoc @@ -0,0 +1,30 @@ +promisor.quiet:: + If set to "true" assume `--quiet` when fetching additional + objects for a partial clone. + +promisor.advertise:: + If set to "true", a server will use the "promisor-remote" + capability, see linkgit:gitprotocol-v2[5], to advertise the + promisor remotes it is using, if it uses some. Default is + "false", which means the "promisor-remote" capability is not + advertised. + +promisor.acceptFromServer:: + If set to "all", a client will accept all the promisor remotes + a server might advertise using the "promisor-remote" + capability. If set to "knownName" the client will accept + promisor remotes which are already configured on the client + and have the same name as those advertised by the client. This + is not very secure, but could be used in a corporate setup + where servers and clients are trusted to not switch name and + URLs. If set to "knownUrl", the client will accept promisor + remotes which have both the same name and the same URL + configured on the client as the name and URL advertised by the + server. This is more secure than "all" or "knownName", so it + should be used if possible instead of those options. Default + is "none", which means no promisor remote advertised by a + server will be accepted. By accepting a promisor remote, the + client agrees that the server might omit objects that are + lazily fetchable from this promisor remote from its responses + to "fetch" and "clone" requests from the client. See + linkgit:gitprotocol-v2[5]. diff --git a/Documentation/config/promisor.txt b/Documentation/config/promisor.txt deleted file mode 100644 index 98c5cb2ec20d34..00000000000000 --- a/Documentation/config/promisor.txt +++ /dev/null @@ -1,3 +0,0 @@ -promisor.quiet:: - If set to "true" assume `--quiet` when fetching additional - objects for a partial clone. diff --git a/Documentation/config/protocol.txt b/Documentation/config/protocol.adoc similarity index 100% rename from Documentation/config/protocol.txt rename to Documentation/config/protocol.adoc diff --git a/Documentation/config/pull.txt b/Documentation/config/pull.adoc similarity index 100% rename from Documentation/config/pull.txt rename to Documentation/config/pull.adoc diff --git a/Documentation/config/push.txt b/Documentation/config/push.adoc similarity index 100% rename from Documentation/config/push.txt rename to Documentation/config/push.adoc diff --git a/Documentation/config/rebase.txt b/Documentation/config/rebase.adoc similarity index 100% rename from Documentation/config/rebase.txt rename to Documentation/config/rebase.adoc diff --git a/Documentation/config/receive.txt b/Documentation/config/receive.adoc similarity index 100% rename from Documentation/config/receive.txt rename to Documentation/config/receive.adoc diff --git a/Documentation/config/reftable.txt b/Documentation/config/reftable.adoc similarity index 100% rename from Documentation/config/reftable.txt rename to Documentation/config/reftable.adoc diff --git a/Documentation/config/remote.txt b/Documentation/config/remote.adoc similarity index 76% rename from Documentation/config/remote.txt rename to Documentation/config/remote.adoc index 36e771556c67aa..25fe219d103cc4 100644 --- a/Documentation/config/remote.txt +++ b/Documentation/config/remote.adoc @@ -50,7 +50,7 @@ remote..skipFetchAll:: If true, this remote will be skipped when updating using linkgit:git-fetch[1], the `update` subcommand of linkgit:git-remote[1], and ignored by the prefetch task - of `git maitenance`. + of `git maintenance`. remote..receivepack:: The default program to execute on the remote side when pushing. See @@ -96,3 +96,26 @@ remote..partialclonefilter:: Changing or clearing this value will only affect fetches for new commits. To fetch associated objects for commits already present in the local object database, use the `--refetch` option of linkgit:git-fetch[1]. + +remote..serverOption:: + The default set of server options used when fetching from this remote. + These server options can be overridden by the `--server-option=` command + line arguments. ++ +This is a multi-valued variable, and an empty value can be used in a higher +priority configuration file (e.g. `.git/config` in a repository) to clear +the values inherited from a lower priority configuration files (e.g. +`$HOME/.gitconfig`). + +remote..followRemoteHEAD:: + How linkgit:git-fetch[1] should handle updates to `remotes//HEAD`. + The default value is "create", which will create `remotes//HEAD` + if it exists on the remote, but not locally; this will not touch an + already existing local reference. Setting it to "warn" will print + a message if the remote has a different value than the local one; + in case there is no local reference, it behaves like "create". + A variant on "warn" is "warn-if-not-$branch", which behaves like + "warn", but if `HEAD` on the remote is `$branch` it will be silent. + Setting it to "always" will silently update `remotes//HEAD` to + the value on the remote. Finally, setting it to "never" will never + change or create the local reference. diff --git a/Documentation/config/remotes.txt b/Documentation/config/remotes.adoc similarity index 100% rename from Documentation/config/remotes.txt rename to Documentation/config/remotes.adoc diff --git a/Documentation/config/repack.txt b/Documentation/config/repack.adoc similarity index 100% rename from Documentation/config/repack.txt rename to Documentation/config/repack.adoc diff --git a/Documentation/config/rerere.txt b/Documentation/config/rerere.adoc similarity index 100% rename from Documentation/config/rerere.txt rename to Documentation/config/rerere.adoc diff --git a/Documentation/config/revert.txt b/Documentation/config/revert.adoc similarity index 100% rename from Documentation/config/revert.txt rename to Documentation/config/revert.adoc diff --git a/Documentation/config/safe.txt b/Documentation/config/safe.adoc similarity index 100% rename from Documentation/config/safe.txt rename to Documentation/config/safe.adoc diff --git a/Documentation/config/sendemail.txt b/Documentation/config/sendemail.adoc similarity index 100% rename from Documentation/config/sendemail.txt rename to Documentation/config/sendemail.adoc diff --git a/Documentation/config/sequencer.txt b/Documentation/config/sequencer.adoc similarity index 100% rename from Documentation/config/sequencer.txt rename to Documentation/config/sequencer.adoc diff --git a/Documentation/config/showbranch.txt b/Documentation/config/showbranch.adoc similarity index 100% rename from Documentation/config/showbranch.txt rename to Documentation/config/showbranch.adoc diff --git a/Documentation/config/sparse.txt b/Documentation/config/sparse.adoc similarity index 100% rename from Documentation/config/sparse.txt rename to Documentation/config/sparse.adoc diff --git a/Documentation/config/splitindex.txt b/Documentation/config/splitindex.adoc similarity index 100% rename from Documentation/config/splitindex.txt rename to Documentation/config/splitindex.adoc diff --git a/Documentation/config/ssh.txt b/Documentation/config/ssh.adoc similarity index 100% rename from Documentation/config/ssh.txt rename to Documentation/config/ssh.adoc diff --git a/Documentation/config/stash.txt b/Documentation/config/stash.adoc similarity index 100% rename from Documentation/config/stash.txt rename to Documentation/config/stash.adoc diff --git a/Documentation/config/status.txt b/Documentation/config/status.adoc similarity index 100% rename from Documentation/config/status.txt rename to Documentation/config/status.adoc diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.adoc similarity index 100% rename from Documentation/config/submodule.txt rename to Documentation/config/submodule.adoc diff --git a/Documentation/config/survey.adoc b/Documentation/config/survey.adoc new file mode 100644 index 00000000000000..ab2217c7d54eb8 --- /dev/null +++ b/Documentation/config/survey.adoc @@ -0,0 +1,14 @@ +survey.*:: + These variables adjust the default behavior of the `git survey` + command. The intention is that this command could be run in the + background with these options. ++ +---- + verbose:: + This boolean value implies the `--[no-]verbose` option. + progress:: + This boolean value implies the `--[no-]progress` option. + top:: + This integer value implies `--top=`, specifying the + number of entries in the detail tables. +---- diff --git a/Documentation/config/tag.txt b/Documentation/config/tag.adoc similarity index 100% rename from Documentation/config/tag.txt rename to Documentation/config/tag.adoc diff --git a/Documentation/config/tar.txt b/Documentation/config/tar.adoc similarity index 100% rename from Documentation/config/tar.txt rename to Documentation/config/tar.adoc diff --git a/Documentation/config/trace2.txt b/Documentation/config/trace2.adoc similarity index 98% rename from Documentation/config/trace2.txt rename to Documentation/config/trace2.adoc index 3b6bca2b7ae44c..05639ce33f908a 100644 --- a/Documentation/config/trace2.txt +++ b/Documentation/config/trace2.adoc @@ -17,7 +17,7 @@ trace2.eventTarget:: It may be overridden by the `GIT_TRACE2_EVENT` environment variable. The following table shows possible values. + -include::../trace2-target-values.txt[] +include::../trace2-target-values.adoc[] trace2.normalBrief:: Boolean. When true `time`, `filename`, and `line` fields are diff --git a/Documentation/config/trailer.adoc b/Documentation/config/trailer.adoc new file mode 100644 index 00000000000000..60bc221c88b801 --- /dev/null +++ b/Documentation/config/trailer.adoc @@ -0,0 +1,136 @@ +trailer.separators:: + This option tells which characters are recognized as trailer + separators. By default only ':' is recognized as a trailer + separator, except that '=' is always accepted on the command + line for compatibility with other git commands. ++ +The first character given by this option will be the default character +used when another separator is not specified in the config for this +trailer. ++ +For example, if the value for this option is "%=$", then only lines +using the format '' with containing '%', '=' +or '$' and then spaces will be considered trailers. And '%' will be +the default separator used, so by default trailers will appear like: +'% ' (one percent sign and one space will appear between +the key and the value). + +trailer.where:: + This option tells where a new trailer will be added. ++ +This can be `end`, which is the default, `start`, `after` or `before`. ++ +If it is `end`, then each new trailer will appear at the end of the +existing trailers. ++ +If it is `start`, then each new trailer will appear at the start, +instead of the end, of the existing trailers. ++ +If it is `after`, then each new trailer will appear just after the +last trailer with the same . ++ +If it is `before`, then each new trailer will appear just before the +first trailer with the same . + +trailer.ifexists:: + This option makes it possible to choose what action will be + performed when there is already at least one trailer with the + same in the input. ++ +The valid values for this option are: `addIfDifferentNeighbor` (this +is the default), `addIfDifferent`, `add`, `replace` or `doNothing`. ++ +With `addIfDifferentNeighbor`, a new trailer will be added only if no +trailer with the same (, ) pair is above or below the line +where the new trailer will be added. ++ +With `addIfDifferent`, a new trailer will be added only if no trailer +with the same (, ) pair is already in the input. ++ +With `add`, a new trailer will be added, even if some trailers with +the same (, ) pair are already in the input. ++ +With `replace`, an existing trailer with the same will be +deleted and the new trailer will be added. The deleted trailer will be +the closest one (with the same ) to the place where the new one +will be added. ++ +With `doNothing`, nothing will be done; that is no new trailer will be +added if there is already one with the same in the input. + +trailer.ifmissing:: + This option makes it possible to choose what action will be + performed when there is not yet any trailer with the same + in the input. ++ +The valid values for this option are: `add` (this is the default) and +`doNothing`. ++ +With `add`, a new trailer will be added. ++ +With `doNothing`, nothing will be done. + +trailer..key:: + Defines a for the . The must be a + prefix (case does not matter) of the . For example, in `git + config trailer.ack.key "Acked-by"` the "Acked-by" is the and + the "ack" is the . This configuration allows the shorter + `--trailer "ack:..."` invocation on the command line using the "ack" + instead of the longer `--trailer "Acked-by:..."`. ++ +At the end of the , a separator can appear and then some +space characters. By default the only valid separator is ':', +but this can be changed using the `trailer.separators` config +variable. ++ +If there is a separator in the key, then it overrides the default +separator when adding the trailer. + +trailer..where:: + This option takes the same values as the 'trailer.where' + configuration variable and it overrides what is specified by + that option for trailers with the specified . + +trailer..ifexists:: + This option takes the same values as the 'trailer.ifexists' + configuration variable and it overrides what is specified by + that option for trailers with the specified . + +trailer..ifmissing:: + This option takes the same values as the 'trailer.ifmissing' + configuration variable and it overrides what is specified by + that option for trailers with the specified . + +trailer..command:: + Deprecated in favor of 'trailer..cmd'. + This option behaves in the same way as 'trailer..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 + that would be passed as argument. ++ +Note that $ARG in the user's command is +only replaced once and that the original way of replacing $ARG is not safe. ++ +When both 'trailer..cmd' and 'trailer..command' are given +for the same , 'trailer..cmd' is used and +'trailer..command' is ignored. + +trailer..cmd:: + This option can be used to specify a shell command that will be called + once to automatically add a trailer with the specified , and then + called each time a '--trailer =' argument is specified to + modify the of the trailer that this option would produce. ++ +When the specified command is first called to add a trailer +with the specified , the behavior is as if a special +'--trailer =' argument was added at the beginning +of the "git interpret-trailers" command, where +is taken to be the standard output of the command with any +leading and trailing whitespace trimmed off. ++ +If some '--trailer =' arguments are also passed +on the command line, the command is called again once for each +of these arguments with the same . And the part +of these arguments, if any, will be passed to the command as its +first argument. This way the command can produce a computed +from the passed in the '--trailer =' argument. diff --git a/Documentation/config/transfer.txt b/Documentation/config/transfer.adoc similarity index 100% rename from Documentation/config/transfer.txt rename to Documentation/config/transfer.adoc diff --git a/Documentation/config/uploadarchive.txt b/Documentation/config/uploadarchive.adoc similarity index 100% rename from Documentation/config/uploadarchive.txt rename to Documentation/config/uploadarchive.adoc diff --git a/Documentation/config/uploadpack.txt b/Documentation/config/uploadpack.adoc similarity index 95% rename from Documentation/config/uploadpack.txt rename to Documentation/config/uploadpack.adoc index 16264d82a722ec..0e1dda944a5490 100644 --- a/Documentation/config/uploadpack.txt +++ b/Documentation/config/uploadpack.adoc @@ -25,7 +25,11 @@ uploadpack.allowReachableSHA1InWant:: uploadpack.allowAnySHA1InWant:: Allow `upload-pack` to accept a fetch request that asks for any object at all. - Defaults to `false`. + It implies `uploadpack.allowTipSHA1InWant` and + `uploadpack.allowReachableSHA1InWant`. If set to `true` it will + enable both of them, it set to `false` it will disable both of + them. + By default not set. uploadpack.keepAlive:: When `upload-pack` has started `pack-objects`, there may be a diff --git a/Documentation/config/url.txt b/Documentation/config/url.adoc similarity index 100% rename from Documentation/config/url.txt rename to Documentation/config/url.adoc diff --git a/Documentation/config/user.txt b/Documentation/config/user.adoc similarity index 100% rename from Documentation/config/user.txt rename to Documentation/config/user.adoc diff --git a/Documentation/config/versionsort.txt b/Documentation/config/versionsort.adoc similarity index 100% rename from Documentation/config/versionsort.txt rename to Documentation/config/versionsort.adoc diff --git a/Documentation/config/web.txt b/Documentation/config/web.adoc similarity index 100% rename from Documentation/config/web.txt rename to Documentation/config/web.adoc diff --git a/Documentation/config/worktree.txt b/Documentation/config/worktree.adoc similarity index 51% rename from Documentation/config/worktree.txt rename to Documentation/config/worktree.adoc index 048e349482df6c..5e35c7d018aecd 100644 --- a/Documentation/config/worktree.txt +++ b/Documentation/config/worktree.adoc @@ -7,3 +7,13 @@ worktree.guessRemote:: such a branch exists, it is checked out and set as "upstream" for the new branch. If no such match can be found, it falls back to creating a new branch from the current HEAD. + +worktree.useRelativePaths:: + Link worktrees using relative paths (when "true") or absolute + paths (when "false"). This is particularly useful for setups + where the repository and worktrees may be moved between + different locations or environments. Defaults to "false". ++ +Note that setting `worktree.useRelativePaths` to "true" implies enabling the +`extension.relativeWorktrees` config (see linkgit:git-config[1]), +thus making it incompatible with older versions of Git. diff --git a/Documentation/date-formats.txt b/Documentation/date-formats.adoc similarity index 100% rename from Documentation/date-formats.txt rename to Documentation/date-formats.adoc diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.adoc similarity index 82% rename from Documentation/diff-format.txt rename to Documentation/diff-format.adoc index a3ae8747a226fc..80e36e153dac88 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.adoc @@ -1,25 +1,25 @@ Raw output format ----------------- -The raw output format from "git-diff-index", "git-diff-tree", -"git-diff-files" and "git diff --raw" are very similar. +The raw output format from `git-diff-index`, `git-diff-tree`, +`git-diff-files` and `git diff --raw` are very similar. These commands all compare two sets of things; what is compared differs: -git-diff-index :: - compares the and the files on the filesystem. +`git-diff-index `:: + compares the __ and the files on the filesystem. -git-diff-index --cached :: - compares the and the index. +`git-diff-index --cached `:: + compares the __ and the index. -git-diff-tree [-r] [...]:: +`git-diff-tree [-r] [...]`:: compares the trees named by the two arguments. -git-diff-files [...]:: +`git-diff-files [...]`:: compares the index and the files on the filesystem. -The "git-diff-tree" command begins its output by printing the hash of +The `git-diff-tree` command begins its output by printing the hash of what is being compared. After that, all the commands print one output line per changed file. @@ -54,19 +54,19 @@ That is, from the left to the right: Possible status letters are: -- A: addition of a file -- C: copy of a file into a new one -- D: deletion of a file -- M: modification of the contents or mode of a file -- R: renaming of a file -- T: change in the type of the file (regular file, symbolic link or submodule) -- U: file is unmerged (you must complete the merge before it can +- `A`: addition of a file +- `C`: copy of a file into a new one +- `D`: deletion of a file +- `M`: modification of the contents or mode of a file +- `R`: renaming of a file +- `T`: change in the type of the file (regular file, symbolic link or submodule) +- `U`: file is unmerged (you must complete the merge before it can be committed) -- X: "unknown" change type (most probably a bug, please report it) +- `X`: "unknown" change type (most probably a bug, please report it) -Status letters C and R are always followed by a score (denoting the +Status letters `C` and `R` are always followed by a score (denoting the percentage of similarity between the source and target of the move or -copy). Status letter M may be followed by a score (denoting the +copy). Status letter `M` may be followed by a score (denoting the percentage of dissimilarity) for file rewrites. The sha1 for "dst" is shown as all 0's if a file on the filesystem @@ -86,7 +86,7 @@ verbatim and the line is terminated by a NUL byte. diff format for merges ---------------------- -"git-diff-tree", "git-diff-files" and "git-diff --raw" +`git-diff-tree`, `git-diff-files` and `git-diff --raw` can take `-c` or `--cc` option to generate diff output also for merge commits. The output differs from the format described above in the following way: @@ -121,14 +121,14 @@ Note that 'combined diff' lists only files which were modified from all parents. -include::diff-generate-patch.txt[] +include::diff-generate-patch.adoc[] other diff formats ------------------ The `--summary` option describes newly added, deleted, renamed and -copied files. The `--stat` option adds diffstat(1) graph to the +copied files. The `--stat` option adds `diffstat`(1) graph to the output. These options can be combined with other options, such as `-p`, and are meant for human consumption. diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.adoc similarity index 90% rename from Documentation/diff-generate-patch.txt rename to Documentation/diff-generate-patch.adoc index 4b5aa5c2e045f5..e5c813c96f3ac4 100644 --- a/Documentation/diff-generate-patch.txt +++ b/Documentation/diff-generate-patch.adoc @@ -14,7 +14,7 @@ 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]). -What the -p option produces is slightly different from the traditional +What the `-p` option produces is slightly different from the traditional diff format: 1. It is preceded by a "git diff" header that looks like this: @@ -30,20 +30,21 @@ name of the source file of the rename/copy and the name of the file that the rename/copy produces, respectively. 2. It is followed by one or more extended header lines: - - old mode - new mode - deleted file mode - new file mode - copy from - copy to - rename from - rename to - similarity index - dissimilarity index - index .. + -File modes are printed as 6-digit octal numbers including the file type +[synopsis] +old mode +new mode +deleted file mode +new file mode +copy from +copy to +rename from +rename to +similarity index +dissimilarity index +index .. ++ +File modes __ are printed as 6-digit octal numbers including the file type and file permission bits. + Path names in extended headers do not include the `a/` and `b/` prefixes. @@ -56,7 +57,7 @@ files, while 100% dissimilarity means that no line from the old file made it into the new one. + The index line includes the blob object names before and after the change. -The is included if the file mode does not change; otherwise, +The __ is included if the file mode does not change; otherwise, separate lines indicate the old and the new mode. 3. Pathnames with "unusual" characters are quoted as explained for @@ -134,17 +135,18 @@ or like this (when the `--cc` option is used): 2. It is followed by one or more extended header lines (this example shows a merge with two parents): - - index ,.. - mode ,.. - new file mode - deleted file mode , ++ +[synopsis] +index ,.. +mode ,`..` +new file mode +deleted file mode , + The `mode ,..` line appears only if at least one of the is different from the rest. Extended headers with information about detected content movement (renames and copying detection) are designed to work with the diff of two - and are not used by combined diff format. +__ and are not used by combined diff format. 3. It is followed by a two-line from-file/to-file header: diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.adoc similarity index 78% rename from Documentation/diff-options.txt rename to Documentation/diff-options.adoc index cd0b81adbb69d1..640eb6e7db58a5 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.adoc @@ -19,16 +19,16 @@ ifdef::git-format-patch[] endif::git-format-patch[] ifndef::git-format-patch[] --p:: --u:: ---patch:: +`-p`:: +`-u`:: +`--patch`:: Generate patch (see <>). ifdef::git-diff[] This is the default. endif::git-diff[] --s:: ---no-patch:: +`-s`:: +`--no-patch`:: Suppress all output from the diff machinery. Useful for commands like `git show` that show the patch by default to squelch their output, or to cancel the effect of options like @@ -39,28 +39,28 @@ endif::git-format-patch[] ifdef::git-log[] -m:: Show diffs for merge commits in the default format. This is - similar to '--diff-merges=on', except `-m` will + similar to `--diff-merges=on`, except `-m` will produce no output unless `-p` is given as well. -c:: Produce combined diff output for merge commits. - Shortcut for '--diff-merges=combined -p'. + Shortcut for `--diff-merges=combined -p`. --cc:: Produce dense combined diff output for merge commits. - Shortcut for '--diff-merges=dense-combined -p'. + Shortcut for `--diff-merges=dense-combined -p`. --dd:: Produce diff with respect to first parent for both merge and regular commits. - Shortcut for '--diff-merges=first-parent -p'. + Shortcut for `--diff-merges=first-parent -p`. --remerge-diff:: Produce remerge-diff output for merge commits. - Shortcut for '--diff-merges=remerge -p'. + Shortcut for `--diff-merges=remerge -p`. --no-diff-merges:: - Synonym for '--diff-merges=off'. + Synonym for `--diff-merges=off`. --diff-merges=:: Specify diff format to be used for merge commits. Default is @@ -73,33 +73,33 @@ The following formats are supported: off, none:: Disable output of diffs for merge commits. Useful to override implied value. -+ + on, m:: Make diff output for merge commits to be shown in the default format. The default format can be changed using `log.diffMerges` configuration variable, whose default value is `separate`. -+ + first-parent, 1:: Show full diff with respect to first parent. This is the same format as `--patch` produces for non-merge commits. -+ + separate:: Show full diff with respect to each of parents. Separate log entry and diff is generated for each parent. -+ + combined, c:: Show differences from each of the parents to the merge result simultaneously instead of showing pairwise diff between a parent and the result one at a time. Furthermore, it lists only files which were modified from all parents. -+ + dense-combined, cc:: Further compress output produced by `--diff-merges=combined` by omitting uninteresting hunks whose contents in the parents have only two variants and the merge result picks one of them without modification. -+ + remerge, r:: Remerge two-parent merge commits to create a temporary tree object--potentially containing files with conflict markers @@ -112,33 +112,33 @@ documented). -- --combined-all-paths:: - This flag causes combined diffs (used for merge commits) to + Cause combined diffs (used for merge commits) to list the name of the file from all parents. It thus only has effect when `--diff-merges=[dense-]combined` is in use, and is likely only useful if filename changes are detected (i.e. when either rename or copy detection have been requested). endif::git-log[] --U:: ---unified=:: - Generate diffs with lines of context instead of +`-U`:: +`--unified=`:: + Generate diffs with __ lines of context instead of the usual three. ifndef::git-format-patch[] Implies `--patch`. endif::git-format-patch[] ---output=:: +`--output=`:: Output to a specific file instead of stdout. ---output-indicator-new=:: ---output-indicator-old=:: ---output-indicator-context=:: +`--output-indicator-new=`:: +`--output-indicator-old=`:: +`--output-indicator-context=`:: Specify the character used to indicate new, old or context - lines in the generated patch. Normally they are '+', '-' and + lines in the generated patch. Normally they are `+`, `-` and ' ' respectively. ifndef::git-format-patch[] ---raw:: +`--raw`:: ifndef::git-log[] Generate the diff in raw format. ifdef::git-diff-core[] @@ -155,54 +155,55 @@ endif::git-log[] endif::git-format-patch[] ifndef::git-format-patch[] ---patch-with-raw:: +`--patch-with-raw`:: Synonym for `-p --raw`. endif::git-format-patch[] ifdef::git-log[] --t:: +`-t`:: Show the tree objects in the diff output. endif::git-log[] ---indent-heuristic:: +`--indent-heuristic`:: Enable the heuristic that shifts diff hunk boundaries to make patches easier to read. This is the default. ---no-indent-heuristic:: +`--no-indent-heuristic`:: Disable the indent heuristic. ---minimal:: +`--minimal`:: Spend extra time to make sure the smallest possible diff is produced. ---patience:: +`--patience`:: Generate a diff using the "patience diff" algorithm. ---histogram:: +`--histogram`:: Generate a diff using the "histogram diff" algorithm. ---anchored=:: +`--anchored=`:: Generate a diff using the "anchored diff" algorithm. + This option may be specified more than once. + If a line exists in both the source and destination, exists only once, -and starts with this text, this algorithm attempts to prevent it from +and starts with __, this algorithm attempts to prevent it from appearing as a deletion or addition in the output. It uses the "patience diff" algorithm internally. ---diff-algorithm={patience|minimal|histogram|myers}:: +`--diff-algorithm=(patience|minimal|histogram|myers)`:: Choose a diff algorithm. The variants are as follows: + -- -`default`, `myers`;; + `default`;; + `myers`;; The basic greedy diff algorithm. Currently, this is the default. -`minimal`;; + `minimal`;; Spend extra time to make sure the smallest possible diff is produced. -`patience`;; + `patience`;; Use "patience diff" algorithm when generating patches. -`histogram`;; + `histogram`;; This algorithm extends the patience algorithm to "support low-occurrence common elements". -- @@ -211,47 +212,47 @@ For instance, if you configured the `diff.algorithm` variable to a non-default value and want to use the default one, then you have to use `--diff-algorithm=default` option. ---stat[=[,[,]]]:: +`--stat[=[,[,]]]`:: Generate a diffstat. By default, as much space as necessary will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - ``. The width of the filename part can be limited by - giving another width `` after a comma or by setting - `diff.statNameWidth=`. The width of the graph part can be - limited by using `--stat-graph-width=` or by setting - `diff.statGraphWidth=`. Using `--stat` or + __. The width of the filename part can be limited by + giving another width __ after a comma or by setting + `diff.statNameWidth=`. The width of the graph part can be + limited by using `--stat-graph-width=` or by setting + `diff.statGraphWidth=`. Using `--stat` or `--stat-graph-width` affects all commands generating a stat graph, while setting `diff.statNameWidth` or `diff.statGraphWidth` does not affect `git format-patch`. - By giving a third parameter ``, you can limit the output to - the first `` lines, followed by `...` if there are more. + By giving a third parameter __, you can limit the output to + the first __ lines, followed by `...` if there are more. + These parameters can also be set individually with `--stat-width=`, `--stat-name-width=` and `--stat-count=`. ---compact-summary:: +`--compact-summary`:: Output a condensed summary of extended header information such - as file creations or deletions ("new" or "gone", optionally "+l" - if it's a symlink) and mode changes ("+x" or "-x" for adding + as file creations or deletions ("new" or "gone", optionally `+l` + if it's a symlink) and mode changes (`+x` or `-x` for adding or removing executable bit respectively) in diffstat. The information is put between the filename part and the graph part. Implies `--stat`. ---numstat:: +`--numstat`:: Similar to `--stat`, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For binary files, outputs two `-` instead of saying `0 0`. ---shortstat:: +`--shortstat`:: Output only the last line of the `--stat` format containing total number of modified files, as well as number of added and deleted lines. --X[]:: ---dirstat[=]:: +`-X [,...]`:: +`--dirstat[=,...]`:: Output the distribution of relative amount of changes for each sub-directory. The behavior of `--dirstat` can be customized by passing it a comma separated list of parameters. @@ -284,7 +285,7 @@ These parameters can also be set individually with `--stat-width=`, Note that when using `cumulative`, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can be specified with the `noncumulative` parameter. -;; +__;; An integer parameter specifies a cut-off percent (3% by default). Directories contributing less than this percentage of the changes are not shown in the output. @@ -295,29 +296,29 @@ directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: `--dirstat=files,10,cumulative`. ---cumulative:: - Synonym for --dirstat=cumulative +`--cumulative`:: + Synonym for `--dirstat=cumulative`. ---dirstat-by-file[=...]:: - Synonym for --dirstat=files,,... +`--dirstat-by-file[=,...]`:: + Synonym for `--dirstat=files,,...`. ---summary:: +`--summary`:: Output a condensed summary of extended header information such as creations, renames and mode changes. ifndef::git-format-patch[] ---patch-with-stat:: +`--patch-with-stat`:: Synonym for `-p --stat`. endif::git-format-patch[] ifndef::git-format-patch[] --z:: +`-z`:: ifdef::git-log[] - Separate the commits with NULs instead of newlines. + Separate the commits with __NUL__s instead of newlines. + Also, when `--raw` or `--numstat` has been given, do not munge -pathnames and use NULs as output field terminators. +pathnames and use __NUL__s as output field terminators. endif::git-log[] ifndef::git-log[] When `--raw`, `--numstat`, `--name-only` or `--name-status` has been @@ -328,89 +329,89 @@ Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). ---name-only:: +`--name-only`:: Show only the name of each changed file in the post-image tree. 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. ---name-status:: +`--name-status`:: Show only the name(s) and status of each changed file. 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[=]:: +`--submodule[=]`:: Specify how differences in submodules are shown. When specifying - `--submodule=short` the 'short' format is used. This format just + `--submodule=short` the `short` format is used. This format just shows the names of the commits at the beginning and end of the range. - When `--submodule` or `--submodule=log` is specified, the 'log' + When `--submodule` or `--submodule=log` is specified, the `log` format is used. This format lists the commits in the range like linkgit:git-submodule[1] `summary` does. When `--submodule=diff` - is specified, the 'diff' format is used. This format shows an + is specified, the `diff` format is used. This format shows an inline diff of the changes in the submodule contents between the - commit range. Defaults to `diff.submodule` or the 'short' format + commit range. Defaults to `diff.submodule` or the `short` format if the config option is unset. ---color[=]:: +`--color[=]`:: Show colored diff. - `--color` (i.e. without '=') is the same as `--color=always`. - '' can be one of `always`, `never`, or `auto`. + `--color` (i.e. without `=`) is the same as `--color=always`. + __ can be one of `always`, `never`, or `auto`. ifdef::git-diff[] It can be changed by the `color.ui` and `color.diff` configuration settings. endif::git-diff[] ---no-color:: +`--no-color`:: Turn off colored diff. ifdef::git-diff[] This can be used to override configuration settings. endif::git-diff[] It is the same as `--color=never`. ---color-moved[=]:: +`--color-moved[=]`:: Moved lines of code are colored differently. ifdef::git-diff[] It can be changed by the `diff.colorMoved` configuration setting. endif::git-diff[] - The defaults to 'no' if the option is not given - and to 'zebra' if the option with no mode is given. + The __ defaults to `no` if the option is not given + and to `zebra` if the option with no mode is given. The mode must be one of: + -- -no:: +`no`:: Moved lines are not highlighted. -default:: +`default`:: Is a synonym for `zebra`. This may change to a more sensible mode in the future. -plain:: +`plain`:: Any line that is added in one location and was removed - in another location will be colored with 'color.diff.newMoved'. - Similarly 'color.diff.oldMoved' will be used for removed lines + in another location will be colored with `color.diff.newMoved`. + Similarly `color.diff.oldMoved` will be used for removed lines that are added somewhere else in the diff. This mode picks up any moved line, but it is not very useful in a review to determine if a block of code was moved without permutation. -blocks:: +`blocks`:: Blocks of moved text of at least 20 alphanumeric characters are detected greedily. The detected blocks are - painted using either the 'color.diff.{old,new}Moved' color. + painted using either the `color.diff.(old|new)Moved` color. Adjacent blocks cannot be told apart. -zebra:: - Blocks of moved text are detected as in 'blocks' mode. The blocks - are painted using either the 'color.diff.{old,new}Moved' color or - 'color.diff.{old,new}MovedAlternative'. The change between +`zebra`:: + Blocks of moved text are detected as in `blocks` mode. The blocks + are painted using either the `color.diff.(old|new)Moved` color or + `color.diff.(old|new)MovedAlternative`. The change between the two colors indicates that a new block was detected. -dimmed-zebra:: - Similar to 'zebra', but additional dimming of uninteresting parts +`dimmed-zebra`:: + Similar to `zebra`, but additional dimming of uninteresting parts of moved code is performed. The bordering lines of two adjacent blocks are considered interesting, the rest is uninteresting. `dimmed_zebra` is a deprecated synonym. -- ---no-color-moved:: +`--no-color-moved`:: Turn off move detection. This can be used to override configuration settings. It is the same as `--color-moved=no`. ---color-moved-ws=:: +`--color-moved-ws=,...`:: This configures how whitespace is ignored when performing the move detection for `--color-moved`. ifdef::git-diff[] @@ -419,63 +420,62 @@ endif::git-diff[] These modes can be given as a comma separated list: + -- -no:: +`no`:: Do not ignore whitespace when performing move detection. -ignore-space-at-eol:: +`ignore-space-at-eol`:: Ignore changes in whitespace at EOL. -ignore-space-change:: +`ignore-space-change`:: Ignore changes in amount of whitespace. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent. -ignore-all-space:: +`ignore-all-space`:: Ignore whitespace when comparing lines. This ignores differences even if one line has whitespace where the other line has none. -allow-indentation-change:: +`allow-indentation-change`:: Initially ignore any whitespace in the move detection, then group the moved code blocks only into a block if the change in whitespace is the same per line. This is incompatible with the other modes. -- ---no-color-moved-ws:: +`--no-color-moved-ws`:: Do not ignore whitespace when performing move detection. This can be used to override configuration settings. It is the same as `--color-moved-ws=no`. ---word-diff[=]:: - Show a word diff, using the to delimit changed words. +`--word-diff[=]`:: By default, words are delimited by whitespace; see - `--word-diff-regex` below. The defaults to 'plain', and + `--word-diff-regex` below. The __ defaults to `plain`, and must be one of: + -- -color:: +`color`:: Highlight changed words using only colors. Implies `--color`. -plain:: - Show words as `[-removed-]` and `{+added+}`. Makes no +`plain`:: + Show words as ++[-removed-]++ and ++{+added+}++. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. -porcelain:: +`porcelain`:: Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the usual unified diff format, starting with a `+`/`-`/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a tilde `~` on a line of its own. -none:: +`none`:: Disable word diff again. -- + Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled. ---word-diff-regex=:: - Use to decide what a word is, instead of considering +`--word-diff-regex=`:: + Use __ to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies `--word-diff` unless it was already enabled. + Every non-overlapping match of the - is considered a word. Anything between these matches is +__ is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding differences. You may want to append `|[^[:space:]]` to your regular expression to make sure that it matches all non-whitespace characters. @@ -490,20 +490,20 @@ linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly overrides any diff driver or configuration setting. Diff drivers override configuration settings. ---color-words[=]:: +`--color-words[=]`:: Equivalent to `--word-diff=color` plus (if a regex was specified) `--word-diff-regex=`. endif::git-format-patch[] ---no-renames:: +`--no-renames`:: Turn off rename detection, even when the configuration file gives the default to do so. ---[no-]rename-empty:: +`--[no-]rename-empty`:: Whether to use empty blobs as rename source. ifndef::git-format-patch[] ---check:: +`--check`:: Warn if changes introduce conflict markers or whitespace errors. What are considered whitespace errors is controlled by `core.whitespace` configuration. By default, trailing whitespaces (including @@ -511,9 +511,9 @@ ifndef::git-format-patch[] that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors. Exits with non-zero status if problems are found. Not compatible - with --exit-code. + with `--exit-code`. ---ws-error-highlight=:: +`--ws-error-highlight=`:: Highlight whitespace errors in the `context`, `old` or `new` lines of the diff. Multiple values are separated by comma, `none` resets previous values, `default` reset the list to @@ -525,30 +525,30 @@ ifndef::git-format-patch[] endif::git-format-patch[] ---full-index:: +`--full-index`:: Instead of the first handful of characters, show the full pre- and post-image blob object names on the "index" line when generating patch format output. ---binary:: +`--binary`:: In addition to `--full-index`, output a binary diff that can be applied with `git-apply`. ifndef::git-format-patch[] Implies `--patch`. endif::git-format-patch[] ---abbrev[=]:: +`--abbrev[=]`:: Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header - lines, show the shortest prefix that is at least '' + lines, show the shortest prefix that is at least __ hexdigits long that uniquely refers the object. In diff-patch output format, `--full-index` takes higher precedence, i.e. if `--full-index` is specified, full blob names will be shown regardless of `--abbrev`. Non default number of digits can be specified with `--abbrev=`. --B[][/]:: ---break-rewrites[=[][/]]:: +`-B[][/]`:: +`--break-rewrites[=[][/]]`:: Break complete rewrite changes into pairs of delete and create. This serves two purposes: + @@ -556,22 +556,22 @@ It affects the way a change that amounts to a total rewrite of a file not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number `m` controls this aspect of the -B +everything new, and the number __ controls this aspect of the `-B` option (defaults to 60%). `-B/70%` specifies that less than 30% of the original should remain in the result for Git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines). + -When used with -M, a totally-rewritten file is also considered as the -source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number `n` controls this aspect of -the -B option (defaults to 50%). `-B20%` specifies that a change with +When used with `-M`, a totally-rewritten file is also considered as the +source of a rename (usually `-M` only considers a file that disappeared +as the source of a rename), and the number __ controls this aspect of +the `-B` option (defaults to 50%). `-B20%` specifies that a change with addition and deletion compared to 20% or more of the file's size are eligible for being picked up as a possible source of a rename to another file. --M[]:: ---find-renames[=]:: +`-M[]`:: +`--find-renames[=]`:: ifndef::git-log[] Detect renames. endif::git-log[] @@ -580,7 +580,7 @@ ifdef::git-log[] For following files across renames while traversing history, see `--follow`. endif::git-log[] - If `n` is specified, it is a threshold on the similarity + If __ is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the file's size). For example, `-M90%` means Git should consider a delete/add pair to be a rename if more than 90% of the file @@ -590,12 +590,12 @@ endif::git-log[] the same as `-M5%`. To limit detection to exact renames, use `-M100%`. The default similarity index is 50%. --C[]:: ---find-copies[=]:: +`-C[]`:: +`--find-copies[=]`:: Detect copies as well as renames. See also `--find-copies-harder`. - If `n` is specified, it has the same meaning as for `-M`. + If __ is specified, it has the same meaning as for `-M`. ---find-copies-harder:: +`--find-copies-harder`:: For performance reasons, by default, `-C` option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command @@ -604,8 +604,8 @@ endif::git-log[] projects, so use it with caution. Giving more than one `-C` option has the same effect. --D:: ---irreversible-delete:: +`-D`:: +`--irreversible-delete`:: Omit the preimage for deletes, i.e. print only the header but not the diff between the preimage and `/dev/null`. The resulting patch is not meant to be applied with `patch` or `git apply`; this is @@ -617,7 +617,7 @@ endif::git-log[] When used together with `-B`, omit also the preimage in the deletion part of a delete/create pair. --l:: +`-l`:: 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 @@ -627,11 +627,11 @@ of a delete/create pair. 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. + exceeds the specified number. Defaults to `diff.renameLimit`. Note that a value of 0 is treated as unlimited. ifndef::git-format-patch[] ---diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]:: +`--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]`:: Select only files that are Added (`A`), Copied (`C`), Deleted (`D`), Modified (`M`), Renamed (`R`), have their type (i.e. regular file, symlink, submodule, ...) changed (`T`), @@ -649,9 +649,9 @@ Also, these upper-case letters can be downcased to exclude. E.g. Note that not all diffs can feature all types. For instance, copied and renamed entries cannot appear if detection for those types is disabled. --S:: +`-S`:: Look for differences that change the number of occurrences of - the specified string (i.e. addition/deletion) in a file. + the specified __ (i.e. addition/deletion) in a file. Intended for the scripter's use. + It is useful when you're looking for an exact block of code (like a @@ -662,11 +662,11 @@ very first version of the block. + Binary files are searched as well. --G:: +`-G`:: Look for differences whose patch text contains added/removed - lines that match . + lines that match __. + -To illustrate the difference between `-S --pickaxe-regex` and +To illustrate the difference between `-S` `--pickaxe-regex` and `-G`, consider a commit with the following diff in the same file: + @@ -686,7 +686,7 @@ filter will be ignored. See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more information. ---find-object=:: +`--find-object=`:: Look for differences that change the number of occurrences of the specified object. Similar to `-S`, just the argument is different in that it doesn't search for a specific string but for a specific @@ -695,25 +695,25 @@ information. The object can be a blob or a submodule commit. It implies the `-t` option in `git-log` to also find trees. ---pickaxe-all:: +`--pickaxe-all`:: When `-S` or `-G` finds a change, show all the changes in that changeset, not just the files that contain the change - in . + in __. ---pickaxe-regex:: - Treat the given to `-S` as an extended POSIX regular +`--pickaxe-regex`:: + Treat the __ given to `-S` as an extended POSIX regular expression to match. endif::git-format-patch[] --O:: +`-O`:: Control the order in which files appear in the output. This overrides the `diff.orderFile` configuration variable (see linkgit:git-config[1]). To cancel `diff.orderFile`, use `-O/dev/null`. + The output order is determined by the order of glob patterns in -. +__. All files with pathnames that match the first pattern are output first, all files with pathnames that match the second pattern (but not the first) are output next, and so on. @@ -724,7 +724,7 @@ If multiple pathnames have the same rank (they match the same pattern but no earlier patterns), their output order relative to each other is the normal order. + - is parsed as follows: +__ is parsed as follows: + -- - Blank lines are ignored, so they can be used as separators for @@ -738,106 +738,107 @@ the normal order. -- + Patterns have the same syntax and semantics as patterns used for -fnmatch(3) without the FNM_PATHNAME flag, except a pathname also +`fnmatch`(3) without the `FNM_PATHNAME` flag, except a pathname also matches a pattern if removing any number of the final pathname components matches the pattern. For example, the pattern "`foo*bar`" matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`". ---skip-to=:: ---rotate-to=:: - Discard the files before the named from the output +`--skip-to=`:: +`--rotate-to=`:: + Discard the files before the named __ from the output (i.e. 'skip to'), or move them to the end of the output (i.e. 'rotate to'). These options were invented primarily for the use of the `git difftool` command, and may not be very useful otherwise. ifndef::git-format-patch[] --R:: +`-R`:: Swap two inputs; that is, show differences from index or on-disk file to tree contents. endif::git-format-patch[] ---relative[=]:: ---no-relative:: +`--relative[=]`:: +`--no-relative`:: When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. When you are not in a subdirectory (e.g. in a bare repository), you can name which subdirectory to make the output relative - to by giving a as an argument. + to by giving a __ as an argument. `--no-relative` can be used to countermand both `diff.relative` config option and previous `--relative`. --a:: ---text:: +`-a`:: +`--text`:: Treat all files as text. ---ignore-cr-at-eol:: +`--ignore-cr-at-eol`:: Ignore carriage-return at the end of line when doing a comparison. ---ignore-space-at-eol:: +`--ignore-space-at-eol`:: Ignore changes in whitespace at EOL. --b:: ---ignore-space-change:: +`-b`:: +`--ignore-space-change`:: Ignore changes in amount of whitespace. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent. --w:: ---ignore-all-space:: +`-w`:: +`--ignore-all-space`:: Ignore whitespace when comparing lines. This ignores differences even if one line has whitespace where the other line has none. ---ignore-blank-lines:: +`--ignore-blank-lines`:: Ignore changes whose lines are all blank. --I:: ---ignore-matching-lines=:: - Ignore changes whose all lines match . This option may + +`-I`:: +`--ignore-matching-lines=`:: + Ignore changes whose all lines match __. This option may be specified more than once. ---inter-hunk-context=:: - Show the context between diff hunks, up to the specified number +`--inter-hunk-context=`:: + Show the context between diff hunks, up to the specified __ of lines, thereby fusing hunks that are close to each other. Defaults to `diff.interHunkContext` or 0 if the config option is unset. --W:: ---function-context:: +`-W`:: +`--function-context`:: Show whole function as context lines for each change. The function names are determined in the same way as - `git diff` works out patch hunk headers (see 'Defining a - custom hunk-header' in linkgit:gitattributes[5]). + `git diff` works out patch hunk headers (see "Defining a + custom hunk-header" in linkgit:gitattributes[5]). ifndef::git-format-patch[] ifndef::git-log[] ---exit-code:: - Make the program exit with codes similar to diff(1). +`--exit-code`:: + Make the program exit with codes similar to `diff`(1). That is, it exits with 1 if there were differences and 0 means no differences. ---quiet:: +`--quiet`:: Disable all output of the program. Implies `--exit-code`. Disables execution of external diff helpers whose exit code is not trusted, i.e. their respective configuration option - `diff.trustExitCode` or `diff..trustExitCode` or + `diff.trustExitCode` or ++diff.++____++.trustExitCode++ or environment variable `GIT_EXTERNAL_DIFF_TRUST_EXIT_CODE` is false. endif::git-log[] endif::git-format-patch[] ---ext-diff:: +`--ext-diff`:: Allow an external diff helper to be executed. If you set an external diff driver with linkgit:gitattributes[5], you need to use this option with linkgit:git-log[1] and friends. ---no-ext-diff:: +`--no-ext-diff`:: Disallow external diff drivers. ---textconv:: ---no-textconv:: +`--textconv`:: +`--no-textconv`:: Allow (or disallow) external text conversion filters to be run when comparing binary files. See linkgit:gitattributes[5] for details. Because textconv filters are typically a one-way @@ -847,42 +848,42 @@ endif::git-format-patch[] linkgit:git-log[1], but not for linkgit:git-format-patch[1] or diff plumbing commands. ---ignore-submodules[=]:: - Ignore changes to submodules in the diff generation. can be - either "none", "untracked", "dirty" or "all", which is the default. - Using "none" will consider the submodule modified when it either contains - untracked or modified files or its HEAD differs from the commit recorded + +`--ignore-submodules[=(none|untracked|dirty|all)]`:: + Ignore changes to submodules in the diff generation. `all` is the default. + Using `none` will consider the submodule modified when it either contains + untracked or modified files or its `HEAD` differs from the commit recorded in the superproject and can be used to override any settings of the - 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When - "untracked" is used submodules are not considered dirty when they only + `ignore` option in linkgit:git-config[1] or linkgit:gitmodules[5]. When + `untracked` is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified - content). Using "dirty" ignores all changes to the work tree of submodules, + content). Using `dirty` ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was - the behavior until 1.7.0). Using "all" hides all changes to submodules. + the behavior until 1.7.0). Using `all` hides all changes to submodules. ---src-prefix=:: - Show the given source prefix instead of "a/". +`--src-prefix=`:: + Show the given source __ instead of "a/". ---dst-prefix=:: - Show the given destination prefix instead of "b/". +`--dst-prefix=`:: + Show the given destination __ instead of "b/". ---no-prefix:: +`--no-prefix`:: Do not show any source or destination prefix. ---default-prefix:: +`--default-prefix`:: Use the default source and destination prefixes ("a/" and "b/"). This overrides configuration variables such as `diff.noprefix`, `diff.srcPrefix`, `diff.dstPrefix`, and `diff.mnemonicPrefix` - (see `git-config`(1)). + (see linkgit:git-config[1]). ---line-prefix=:: - Prepend an additional prefix to every line of output. +`--line-prefix=`:: + Prepend an additional __ to every line of output. ---ita-invisible-in-index:: - By default entries added by "git add -N" appear as an existing - empty file in "git diff" and a new file in "git diff --cached". - This option makes the entry appear as a new file in "git diff" - and non-existent in "git diff --cached". This option could be +`--ita-invisible-in-index`:: + By default entries added by `git add -N` appear as an existing + empty file in `git diff` and a new file in `git diff --cached`. + This option makes the entry appear as a new file in `git diff` + and non-existent in `git diff --cached`. This option could be reverted with `--ita-visible-in-index`. Both options are experimental and could be removed in future. diff --git a/Documentation/everyday.txto b/Documentation/everyday.adoco similarity index 100% rename from Documentation/everyday.txto rename to Documentation/everyday.adoco diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.adoc similarity index 98% rename from Documentation/fetch-options.txt rename to Documentation/fetch-options.adoc index 80838fe37ef30e..b01372e4b3c659 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.adoc @@ -29,7 +29,7 @@ Deepen or shorten the history of a shallow repository to include all reachable commits after . ---shallow-exclude=:: +--shallow-exclude=:: Deepen or shorten the history of a shallow repository to exclude commits reachable from a specified remote branch or tag. This option can be specified multiple times. @@ -305,6 +305,9 @@ endif::git-pull[] unknown ones, is server-specific. When multiple `--server-option=