From: Junio C Hamano Date: Sat, 15 Feb 2025 01:53:47 +0000 (-0800) Subject: Merge branch 'bc/doc-adoc-not-txt' X-Git-Tag: v2.49.0-rc0~31 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0cc13007e5d50b096c95047680ace56749c18789;p=thirdparty%2Fgit.git Merge branch 'bc/doc-adoc-not-txt' All the documentation .txt files have been renamed to .adoc to help content aware editors. * bc/doc-adoc-not-txt: Remove obsolete ".txt" extensions for AsciiDoc files doc: use .adoc extension for AsciiDoc files gitattributes: mark AsciiDoc files as LF-only editorconfig: add .adoc extension doc: update gitignore for .adoc extension --- 0cc13007e5d50b096c95047680ace56749c18789 diff --cc Documentation/config.adoc index 1b86323ca3,812b43c43d..cc769251be --- a/Documentation/config.adoc +++ b/Documentation/config.adoc @@@ -372,188 -372,186 +372,188 @@@ inventing new variables for use in you 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/tag.adoc[] - include::config/tar.txt[] + include::config/tar.adoc[] - include::config/trace2.txt[] + include::config/trace2.adoc[] - include::config/trailer.txt[] ++include::config/trailer.adoc[] + - include::config/transfer.txt[] + include::config/transfer.adoc[] - include::config/uploadarchive.txt[] + include::config/uploadarchive.adoc[] - include::config/uploadpack.txt[] + include::config/uploadpack.adoc[] - include::config/url.txt[] + include::config/url.adoc[] - include::config/user.txt[] + include::config/user.adoc[] - include::config/versionsort.txt[] + include::config/versionsort.adoc[] - include::config/web.txt[] + include::config/web.adoc[] - include::config/worktree.txt[] + include::config/worktree.adoc[] diff --cc Documentation/config/difftool.adoc index 6cd47331a9,447c40d85a..4f7d40ce24 --- a/Documentation/config/difftool.adoc +++ b/Documentation/config/difftool.adoc @@@ -13,8 -13,6 +13,8 @@@ diff.guitool: and requires that a corresponding difftool..cmd variable is defined. - include::{build_dir}/mergetools-diff.txt[] ++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 --cc Documentation/config/trailer.adoc index 60bc221c88,0000000000..60bc221c88 mode 100644,000000..100644 --- a/Documentation/config/trailer.adoc +++ b/Documentation/config/trailer.adoc diff --cc Documentation/git-commit.adoc index 602e2f1200,33ac5c4185..dfb78169cb --- a/Documentation/git-commit.adoc +++ b/Documentation/git-commit.adoc @@@ -198,14 -198,14 +198,14 @@@ The `-m` option is mutually exclusive w message, the commit is aborted. This has no effect when a message is given by other means, e.g. with the `-m` or `-F` options. - include::signoff-option.txt[] + include::signoff-option.adoc[] ---trailer [(=|:)]:: - Specify a (, ) pair that should be applied as a +`--trailer [(=|:)]`:: + Specify a (__, __) pair that should be applied as a trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \ " --trailer "Helped-by:C O Mitter \ - "` will add the "Signed-off-by" trailer - and the "Helped-by" trailer to the commit message.) + "` will add the `Signed-off-by` trailer + and the `Helped-by` trailer to the commit message.) The `trailer.*` configuration variables (linkgit:git-interpret-trailers[1]) can be used to define if a duplicated trailer is omitted, where in the run of trailers diff --cc Documentation/git-interpret-trailers.adoc index c9435d549a,d9dfb75fef..82c8780d93 --- a/Documentation/git-interpret-trailers.adoc +++ b/Documentation/git-interpret-trailers.adoc @@@ -186,9 -186,142 +186,9 @@@ OPTION CONFIGURATION VARIABLES ----------------------- - include::includes/cmd-config-section-all.txt[] -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 . ++include::includes/cmd-config-section-all.adoc[] - include::config/trailer.txt[] -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. ++include::config/trailer.adoc[] EXAMPLES -------- diff --cc Documentation/technical/api-path-walk.adoc index 7075d0d5ab,0000000000..7075d0d5ab mode 100644,000000..100644 --- a/Documentation/technical/api-path-walk.adoc +++ b/Documentation/technical/api-path-walk.adoc diff --cc meson.build index 30ed401899,26e6779770..0df3872c6a --- a/meson.build +++ b/meson.build @@@ -642,8 -625,8 +642,8 @@@ builtin_sources += custom_target env: script_environment, ) -libgit_sources += custom_target( +builtin_sources += custom_target( - input: 'Documentation/githooks.txt', + input: 'Documentation/githooks.adoc', output: 'hook-list.h', command: [ shell,