Merge branch 'tz/doc-txt-to-adoc-fixes'

Fallouts from recent renaming of documentation files from .txt
suffix to the new .adoc suffix have been corrected.

* tz/doc-txt-to-adoc-fixes: (38 commits)
  xdiff: *.txt -> *.adoc fixes
  unpack-trees.c: *.txt -> *.adoc fixes
  transport.h: *.txt -> *.adoc fixes
  trace2/tr2_sysenv.c: *.txt -> *.adoc fixes
  trace2.h: *.txt -> *.adoc fixes
  t6434: *.txt -> *.adoc fixes
  t6012: *.txt -> *.adoc fixes
  t/helper/test-rot13-filter.c: *.txt -> *.adoc fixes
  simple-ipc.h: *.txt -> *.adoc fixes
  setup.c: *.txt -> *.adoc fixes
  refs.h: *.txt -> *.adoc fixes
  pseudo-merge.h: *.txt -> *.adoc fixes
  parse-options.h: *.txt -> *.adoc fixes
  object-name.c: *.txt -> *.adoc fixes
  list-objects-filter-options.h: *.txt -> *.adoc fixes
  fsck.h: *.txt -> *.adoc fixes
  diffcore.h: *.txt -> *.adoc fixes
  diff.h: *.txt -> *.adoc fixes
  contrib/long-running-filter: *.txt -> *.adoc fixes
  config.c: *.txt -> *.adoc fixes
  ...
This commit is contained in:
Junio C Hamano
2025-03-06 14:06:31 -08:00
46 changed files with 119 additions and 120 deletions

6
.gitattributes vendored
View File

@@ -12,7 +12,7 @@ CODE_OF_CONDUCT.md -whitespace
/GIT-VERSION-GEN text eol=lf /GIT-VERSION-GEN text eol=lf
/mergetools/* text eol=lf /mergetools/* text eol=lf
/t/oid-info/* text eol=lf /t/oid-info/* text eol=lf
/Documentation/git-merge.txt conflict-marker-size=32 /Documentation/git-merge.adoc conflict-marker-size=32
/Documentation/gitk.txt conflict-marker-size=32 /Documentation/gitk.adoc conflict-marker-size=32
/Documentation/user-manual.txt conflict-marker-size=32 /Documentation/user-manual.adoc conflict-marker-size=32
/t/t????-*.sh conflict-marker-size=32 /t/t????-*.sh conflict-marker-size=32

View File

@@ -1 +0,0 @@
*.txt whitespace

View File

@@ -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). 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 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 has a collection of tips to help you use some external tools
to conform to these guidelines. to conform to these guidelines.
@@ -755,7 +755,7 @@ Externally Visible Names
Writing Documentation: Writing Documentation:
Most (if not all) of the documentation pages are written in the 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 processed into HTML and manpages (e.g. git.html and git.1 in the
same directory). same directory).

View File

@@ -21,7 +21,7 @@ This tutorial aims to summarize the following documents, but the reader may find
useful additional context: useful additional context:
- `Documentation/SubmittingPatches` - `Documentation/SubmittingPatches`
- `Documentation/howto/new-command.txt` - `Documentation/howto/new-command.adoc`
[[getting-help]] [[getting-help]]
=== Getting Help === Getting Help
@@ -331,7 +331,7 @@ function body:
apply standard precedence rules. `git_config_get_string_tmp()` will look up 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 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 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: 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. 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 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 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 project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing
Documentation" section). Use the following template to fill out your own Documentation" section). Use the following template to fill out your own
manpage: 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 That's because `-h` is a special case which your command should handle by
printing usage. 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 tool for pulling out options you need to be able to handle, and it takes a
usage string. 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: The one generated for `psuh` from the sample implementation looks like this:
---- ----
Documentation/git-psuh.txt | 40 +++++++++++++++++++++ Documentation/git-psuh.adoc | 40 +++++++++++++++++++++
Makefile | 1 + Makefile | 1 +
builtin.h | 1 + builtin.h | 1 +
builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++ builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++
git.c | 1 + git.c | 1 +
t/t9999-psuh-tutorial.sh | 12 +++++++ t/t9999-psuh-tutorial.sh | 12 +++++++
6 files changed, 128 insertions(+) 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 100644 builtin/psuh.c
create mode 100755 t/t9999-psuh-tutorial.sh create mode 100755 t/t9999-psuh-tutorial.sh
---- ----

View File

@@ -15,7 +15,7 @@ revision walk is used for operations like `git log`.
=== Related Reading === 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. the revision walker in its various incarnations.
- `revision.h` - `revision.h`
- https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists] - 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 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 NOTE: A reference implementation can be found at
https://github.com/nasamuffin/git/tree/revwalk. https://github.com/nasamuffin/git/tree/revwalk.
@@ -132,7 +132,7 @@ used to track the allocated size of the list.
Per entry, we find: Per entry, we find:
`item` is the object provided upon which to base the object walk. Items in Git `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 `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 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 `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 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. value.
`flags` are used to hint the beginning of the revision walk and are the first `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 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 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. good idea to take some time and read through that document.
== Basic Commit Walk == Basic Commit Walk
@@ -710,7 +710,7 @@ objects grows along with the Git project.
=== Adding a Filter === Adding a Filter
There are a handful of filters that we can apply to the object walk laid out in 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 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 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 will use the "tree:1" filter, which causes the walk to omit all trees and blobs

View File

@@ -4,15 +4,15 @@ my ($build_dir) = @ARGV;
my %include = (); my %include = ();
my %included = (); my %included = ();
for my $text (<*.txt>) { for my $adoc (<*.adoc>) {
open I, '<', $text || die "cannot read: $text"; open I, '<', $adoc || die "cannot read: $adoc";
while (<I>) { while (<I>) {
if (/^include::/) { if (/^include::/) {
chomp; chomp;
s/^include::\s*//; s/^include::\s*//;
s/\[\]//; s/\[\]//;
s/{build_dir}/${build_dir}/; s/{build_dir}/${build_dir}/;
$include{$text}{$_} = 1; $include{$adoc}{$_} = 1;
$included{$_} = 1; $included{$_} = 1;
} }
} }
@@ -23,14 +23,14 @@ for my $text (<*.txt>) {
my $changed = 1; my $changed = 1;
while ($changed) { while ($changed) {
$changed = 0; $changed = 0;
while (my ($text, $included) = each %include) { while (my ($adoc, $included) = each %include) {
for my $i (keys %$included) { for my $i (keys %$included) {
# $text has include::$i; if $i includes $j # $adoc has include::$i; if $i includes $j
# $text indirectly includes $j. # $adoc indirectly includes $j.
if (exists $include{$i}) { if (exists $include{$i}) {
for my $j (keys %{$include{$i}}) { for my $j (keys %{$include{$i}}) {
if (!exists $include{$text}{$j}) { if (!exists $include{$adoc}{$j}) {
$include{$text}{$j} = 1; $include{$adoc}{$j} = 1;
$included{$j} = 1; $included{$j} = 1;
$changed = 1; $changed = 1;
} }
@@ -40,10 +40,10 @@ while ($changed) {
} }
} }
foreach my $text (sort keys %include) { foreach my $adoc (sort keys %include) {
my $included = $include{$text}; my $included = $include{$adoc};
if (! exists $included{$text} && if (! exists $included{$adoc} &&
(my $base = $text) =~ s/\.txt$//) { (my $base = $adoc) =~ s/\.adoc$//) {
print "$base.html $base.xml : ", join(" ", sort keys %$included), "\n"; print "$base.html $base.xml : ", join(" ", sort keys %$included), "\n";
} }
} }

View File

@@ -513,7 +513,7 @@ If the filter command (a string value) is defined via
`filter.<driver>.process` then Git can process all blobs with a `filter.<driver>.process` then Git can process all blobs with a
single filter invocation for the entire life of a single Git single filter invocation for the entire life of a single Git
command. This is achieved by using the long-running process protocol command. This is achieved by using the long-running process protocol
(described in technical/long-running-process-protocol.txt). (described in Documentation/technical/long-running-process-protocol.adoc).
When Git encounters the first file that needs to be cleaned or smudged, When Git encounters the first file that needs to be cleaned or smudged,
it starts the filter and performs the handshake. In the handshake, the it starts the filter and performs the handshake. In the handshake, the
@@ -1177,11 +1177,11 @@ integer has a meaningful effect.
For example, this line in `.gitattributes` can be used to tell the merge For example, this line in `.gitattributes` can be used to tell the merge
machinery to leave much longer (instead of the usual 7-character-long) machinery to leave much longer (instead of the usual 7-character-long)
conflict markers when merging the file `Documentation/git-merge.txt` conflict markers when merging the file `Documentation/git-merge.adoc`
results in a conflict. results in a conflict.
------------------------ ------------------------
Documentation/git-merge.txt conflict-marker-size=32 Documentation/git-merge.adoc conflict-marker-size=32
------------------------ ------------------------

View File

@@ -9,9 +9,9 @@ people describing how they use Git in their workflow.
EOF EOF
for txt for adoc
do do
title=$(expr "$txt" : '.*/\(.*\)\.txt$') title=$(expr "$adoc" : '.*/\(.*\)\.adoc$')
from=$(sed -ne ' from=$(sed -ne '
/^$/q /^$/q
/^From:[ ]/{ /^From:[ ]/{
@@ -21,7 +21,7 @@ do
s/^/by / s/^/by /
p p
} }
' "$txt") ' "$adoc")
abstract=$(sed -ne ' abstract=$(sed -ne '
/^Abstract:[ ]/{ /^Abstract:[ ]/{
@@ -39,13 +39,13 @@ do
x x
p p
q q
}' "$txt") }' "$adoc")
if grep 'Content-type: text/asciidoc' >/dev/null $txt if grep 'Content-type: text/asciidoc' >/dev/null $adoc
then then
file=$(expr "$txt" : '\(.*\)\.txt$').html file=$(expr "$adoc" : '\(.*\)\.adoc$').html
else else
file="$txt" file="$adoc"
fi fi
echo "* link:howto/$(basename "$file")[$title] $from echo "* link:howto/$(basename "$file")[$title] $from

View File

@@ -48,7 +48,7 @@ binary); this organization makes it easy for people reading the code
to find things. to find things.
See the CodingGuidelines document for other guidance on what we consider See the CodingGuidelines document for other guidance on what we consider
good practice in C and shell, and api-builtin.txt for the support good practice in C and shell, and builtin.h for the support
functions available to built-in commands written in C. functions available to built-in commands written in C.
What every extension command needs What every extension command needs

View File

@@ -36,7 +36,7 @@ Comparison with sub-process model
--------------------------------- ---------------------------------
The Simple-IPC mechanism differs from the existing `sub-process.c` The Simple-IPC mechanism differs from the existing `sub-process.c`
model (Documentation/technical/long-running-process-protocol.txt) and model (Documentation/technical/long-running-process-protocol.adoc) and
used by applications like Git-LFS. In the LFS-style sub-process model, used by applications like Git-LFS. In the LFS-style sub-process model,
the helper is started by the foreground process, communication happens the helper is started by the foreground process, communication happens
via a pair of file descriptors bound to the stdin/stdout of the via a pair of file descriptors bound to the stdin/stdout of the

View File

@@ -394,7 +394,7 @@ inflated again in step 3, for a total of two inflations.
Step 4 is probably necessary for good read-time performance. "git Step 4 is probably necessary for good read-time performance. "git
pack-objects" on the server optimizes the pack file for good data pack-objects" on the server optimizes the pack file for good data
locality (see Documentation/technical/pack-heuristics.txt). locality (see Documentation/technical/pack-heuristics.adoc).
Details of this process are likely to change. It will take some Details of this process are likely to change. It will take some
experimenting to get this to perform well. experimenting to get this to perform well.

View File

@@ -85,7 +85,7 @@ See "filter" in linkgit:gitprotocol-pack[5].
server to request filtering during packfile construction. server to request filtering during packfile construction.
+ +
There are various filters available to accommodate different situations. There are various filters available to accommodate different situations.
See "--filter=<filter-spec>" in Documentation/rev-list-options.txt. See "--filter=<filter-spec>" in Documentation/rev-list-options.adoc.
- On the server pack-objects applies the requested filter-spec as it - On the server pack-objects applies the requested filter-spec as it
creates "filtered" packfiles for the client. creates "filtered" packfiles for the client.

View File

@@ -194,7 +194,7 @@ include shared.mak
# Linux, kernel 2.6.11 or newer is required for reliable sub-second file times # Linux, kernel 2.6.11 or newer is required for reliable sub-second file times
# on file systems with exactly 1 ns or 1 s resolution. If you intend to use Git # on file systems with exactly 1 ns or 1 s resolution. If you intend to use Git
# on other file systems (e.g. CEPH, CIFS, NTFS, UDF), don't enable USE_NSEC. See # on other file systems (e.g. CEPH, CIFS, NTFS, UDF), don't enable USE_NSEC. See
# Documentation/technical/racy-git.txt for details. # Documentation/technical/racy-git.adoc for details.
# #
# Define USE_ST_TIMESPEC if your "struct stat" uses "st_ctimespec" instead of # Define USE_ST_TIMESPEC if your "struct stat" uses "st_ctimespec" instead of
# "st_ctim" # "st_ctim"

View File

@@ -17,15 +17,15 @@ Please read the file [INSTALL][] for installation instructions.
Many Git online resources are accessible from <https://git-scm.com/> Many Git online resources are accessible from <https://git-scm.com/>
including full documentation and Git related tools. including full documentation and Git related tools.
See [Documentation/gittutorial.txt][] to get started, then see See [Documentation/gittutorial.adoc][] to get started, then see
[Documentation/giteveryday.txt][] for a useful minimum set of commands, and [Documentation/giteveryday.adoc][] for a useful minimum set of commands, and
`Documentation/git-<commandname>.txt` for documentation of each command. `Documentation/git-<commandname>.adoc` for documentation of each command.
If git has been correctly installed, then the tutorial can also be If git has been correctly installed, then the tutorial can also be
read with `man gittutorial` or `git help tutorial`, and the read with `man gittutorial` or `git help tutorial`, and the
documentation of each command with `man git-<commandname>` or `git help documentation of each command with `man git-<commandname>` or `git help
<commandname>`. <commandname>`.
CVS users may also want to read [Documentation/gitcvs-migration.txt][] CVS users may also want to read [Documentation/gitcvs-migration.adoc][]
(`man gitcvs-migration` or `git help cvs-migration` if git is (`man gitcvs-migration` or `git help cvs-migration` if git is
installed). installed).
@@ -66,9 +66,9 @@ and the name as (depending on your mood):
- "goddamn idiotic truckload of sh*t": when it breaks - "goddamn idiotic truckload of sh*t": when it breaks
[INSTALL]: INSTALL [INSTALL]: INSTALL
[Documentation/gittutorial.txt]: Documentation/gittutorial.txt [Documentation/gittutorial.adoc]: Documentation/gittutorial.adoc
[Documentation/giteveryday.txt]: Documentation/giteveryday.txt [Documentation/giteveryday.adoc]: Documentation/giteveryday.adoc
[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt [Documentation/gitcvs-migration.adoc]: Documentation/gitcvs-migration.adoc
[Documentation/SubmittingPatches]: Documentation/SubmittingPatches [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
[Documentation/CodingGuidelines]: Documentation/CodingGuidelines [Documentation/CodingGuidelines]: Documentation/CodingGuidelines
[po/README.md]: po/README.md [po/README.md]: po/README.md

View File

@@ -7,7 +7,7 @@ struct string_list;
* To add a new advice, you need to: * To add a new advice, you need to:
* Define a new advice_type. * Define a new advice_type.
* Add a new entry to advice_setting array. * Add a new entry to advice_setting array.
* Add the new config variable to Documentation/config/advice.txt. * Add the new config variable to Documentation/config/advice.adoc.
* Call advise_if_enabled to print your advice. * Call advise_if_enabled to print your advice.
*/ */
enum advice_type { enum advice_type {

View File

@@ -82,7 +82,7 @@ static int parse_whitespace_option(struct apply_state *state, const char *option
} }
/* /*
* Please update $__git_whitespacelist in git-completion.bash, * Please update $__git_whitespacelist in git-completion.bash,
* Documentation/git-apply.txt, and Documentation/git-am.txt * Documentation/git-apply.adoc, and Documentation/git-am.adoc
* when you add new options. * when you add new options.
*/ */
return error(_("unrecognized whitespace option '%s'"), option); return error(_("unrecognized whitespace option '%s'"), option);

View File

@@ -63,7 +63,7 @@
* *
* . Add tests to `t/` directory. * . Add tests to `t/` directory.
* *
* . Write documentation in `Documentation/git-foo.txt`. * . Write documentation in `Documentation/git-foo.adoc`.
* *
* . Add an entry for `git-foo` to `command-list.txt`. * . Add an entry for `git-foo` to `command-list.txt`.
* *

View File

@@ -1647,7 +1647,7 @@ static int git_default_core_config(const char *var, const char *value,
return 0; return 0;
} }
/* Add other config variables here and to Documentation/config.txt. */ /* Add other config variables here and to Documentation/config.adoc. */
return platform_core_config(var, value, ctx, cb); return platform_core_config(var, value, ctx, cb);
} }
@@ -1658,7 +1658,7 @@ static int git_default_sparse_config(const char *var, const char *value)
return 0; return 0;
} }
/* Add other config variables here and to Documentation/config/sparse.txt. */ /* Add other config variables here and to Documentation/config/sparse.adoc. */
return 0; return 0;
} }
@@ -1674,7 +1674,7 @@ static int git_default_i18n_config(const char *var, const char *value)
return git_config_string(&git_log_output_encoding, var, value); return git_config_string(&git_log_output_encoding, var, value);
} }
/* Add other config variables here and to Documentation/config.txt. */ /* Add other config variables here and to Documentation/config.adoc. */
return 0; return 0;
} }
@@ -1710,7 +1710,7 @@ static int git_default_branch_config(const char *var, const char *value)
return 0; return 0;
} }
/* Add other config variables here and to Documentation/config.txt. */ /* Add other config variables here and to Documentation/config.adoc. */
return 0; return 0;
} }
@@ -1739,7 +1739,7 @@ static int git_default_push_config(const char *var, const char *value)
return 0; return 0;
} }
/* Add other config variables here and to Documentation/config.txt. */ /* Add other config variables here and to Documentation/config.adoc. */
return 0; return 0;
} }
@@ -1755,7 +1755,7 @@ static int git_default_mailmap_config(const char *var, const char *value)
return git_config_string(&git_mailmap_blob, var, value); return git_config_string(&git_mailmap_blob, var, value);
} }
/* Add other config variables here and to Documentation/config.txt. */ /* Add other config variables here and to Documentation/config.adoc. */
return 0; return 0;
} }
@@ -1768,7 +1768,7 @@ static int git_default_attr_config(const char *var, const char *value)
/* /*
* Add other attribute related config variables here and to * Add other attribute related config variables here and to
* Documentation/config/attr.txt. * Documentation/config/attr.adoc.
*/ */
return 0; return 0;
} }
@@ -1826,7 +1826,7 @@ int git_default_config(const char *var, const char *value,
if (starts_with(var, "sparse.")) if (starts_with(var, "sparse."))
return git_default_sparse_config(var, value); return git_default_sparse_config(var, value);
/* Add other config variables here and to Documentation/config.txt. */ /* Add other config variables here and to Documentation/config.adoc. */
return 0; return 0;
} }

View File

@@ -34,7 +34,7 @@ GIT_CONTACTS := git-contacts
GIT_CONTACTS_DOC := git-contacts.1 GIT_CONTACTS_DOC := git-contacts.1
GIT_CONTACTS_XML := git-contacts.xml GIT_CONTACTS_XML := git-contacts.xml
GIT_CONTACTS_TXT := git-contacts.txt GIT_CONTACTS_TXT := git-contacts.adoc
GIT_CONTACTS_HTML := git-contacts.html GIT_CONTACTS_HTML := git-contacts.html
doc: $(GIT_CONTACTS_DOC) $(GIT_CONTACTS_HTML) doc: $(GIT_CONTACTS_DOC) $(GIT_CONTACTS_HTML)

View File

@@ -16,7 +16,7 @@ if get_option('docs').contains('man')
'@INPUT@', '@INPUT@',
], ],
depends: documentation_deps, depends: documentation_deps,
input: 'git-contacts.txt', input: 'git-contacts.adoc',
output: 'git-contacts.xml', output: 'git-contacts.xml',
) )
@@ -47,7 +47,7 @@ if get_option('docs').contains('html')
'@INPUT@', '@INPUT@',
], ],
depends: documentation_deps, depends: documentation_deps,
input: 'git-contacts.txt', input: 'git-contacts.adoc',
output: 'git-contacts.html', output: 'git-contacts.html',
install: true, install: true,
install_dir: get_option('datadir') / 'doc/git-doc', install_dir: get_option('datadir') / 'doc/git-doc',

View File

@@ -1,7 +1,7 @@
#!/usr/bin/perl #!/usr/bin/perl
# #
# Example implementation for the Git filter protocol version 2 # Example implementation for the Git filter protocol version 2
# See Documentation/gitattributes.txt, section "Filter Protocol" # See Documentation/gitattributes.adoc, section "Filter Protocol"
# #
# Please note, this pass-thru filter is a minimal skeleton. No proper # Please note, this pass-thru filter is a minimal skeleton. No proper
# error handling was implemented. # error handling was implemented.

View File

@@ -50,7 +50,7 @@ GIT_SUBTREE := git-subtree
GIT_SUBTREE_DOC := git-subtree.1 GIT_SUBTREE_DOC := git-subtree.1
GIT_SUBTREE_XML := git-subtree.xml GIT_SUBTREE_XML := git-subtree.xml
GIT_SUBTREE_TXT := git-subtree.txt GIT_SUBTREE_TXT := git-subtree.adoc
GIT_SUBTREE_HTML := git-subtree.html GIT_SUBTREE_HTML := git-subtree.html
GIT_SUBTREE_TEST := ../../git-subtree GIT_SUBTREE_TEST := ../../git-subtree

View File

@@ -32,7 +32,7 @@ if get_option('docs').contains('man')
'@INPUT@', '@INPUT@',
], ],
depends: documentation_deps, depends: documentation_deps,
input: 'git-subtree.txt', input: 'git-subtree.adoc',
output: 'git-subtree.xml', output: 'git-subtree.xml',
) )
@@ -63,7 +63,7 @@ if get_option('docs').contains('html')
'@INPUT@', '@INPUT@',
], ],
depends: documentation_deps, depends: documentation_deps,
input: 'git-subtree.txt', input: 'git-subtree.adoc',
output: 'git-subtree.html', output: 'git-subtree.html',
install: true, install: true,
install_dir: get_option('datadir') / 'doc/git-doc', install_dir: get_option('datadir') / 'doc/git-doc',

2
diff.h
View File

@@ -333,7 +333,7 @@ struct diff_options {
int xdl_opts; int xdl_opts;
int ignore_driver_algorithm; int ignore_driver_algorithm;
/* see Documentation/diff-options.txt */ /* see Documentation/diff-options.adoc */
char **anchors; char **anchors;
size_t anchors_nr, anchors_alloc; size_t anchors_nr, anchors_alloc;

View File

@@ -107,7 +107,7 @@ struct diff_filepair {
struct diff_filespec *one; struct diff_filespec *one;
struct diff_filespec *two; struct diff_filespec *two;
unsigned short int score; unsigned short int score;
char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */ char status; /* M C R A D U etc. (see Documentation/diff-format.adoc or DIFF_STATUS_* in diff.h) */
unsigned broken_pair : 1; unsigned broken_pair : 1;
unsigned renamed_pair : 1; unsigned renamed_pair : 1;
unsigned is_unmerged : 1; unsigned is_unmerged : 1;

2
fsck.h
View File

@@ -15,7 +15,7 @@ enum fsck_msg_type {
}; };
/* /*
* Documentation/fsck-msgids.txt documents these; when * Documentation/fsck-msgids.adoc documents these; when
* modifying this list in any way, make sure to keep the * modifying this list in any way, make sure to keep the
* two in sync. * two in sync.
*/ */

View File

@@ -82,7 +82,7 @@ void list_objects_filter_init(struct list_objects_filter_options *filter_options
* "filter" SP <arg> * "filter" SP <arg>
* *
* The filter keyword will be used by many commands. * The filter keyword will be used by many commands.
* See Documentation/rev-list-options.txt for allowed values for <arg>. * See Documentation/rev-list-options.adoc for allowed values for <arg>.
* *
* Capture the given arg as the "filter_spec". This can be forwarded to * Capture the given arg as the "filter_spec". This can be forwarded to
* subordinate commands when necessary (although it's better to pass it through * subordinate commands when necessary (although it's better to pass it through

View File

@@ -1273,7 +1273,7 @@ static int peel_onion(struct repository *r, const char *name, int len,
} }
/* /*
* Documentation/revisions.txt says: * Documentation/revisions.adoc says:
* '<describeOutput>', e.g. 'v1.7.4.2-679-g3bee7fb':: * '<describeOutput>', e.g. 'v1.7.4.2-679-g3bee7fb'::
* Output from `git describe`; i.e. a closest tag, optionally * Output from `git describe`; i.e. a closest tag, optionally
* followed by a dash and a number of commits, followed by a dash, a * followed by a dash and a number of commits, followed by a dash, a

View File

@@ -6,7 +6,7 @@
struct repository; struct repository;
/** /**
* Refer to Documentation/technical/api-parse-options.txt for the API doc. * Refer to Documentation/technical/api-parse-options.adoc for the API doc.
*/ */
enum parse_opt_type { enum parse_opt_type {

View File

@@ -101,7 +101,7 @@ void select_pseudo_merges(struct bitmap_writer *writer);
/* /*
* Represents a serialized view of a file containing pseudo-merge(s) * Represents a serialized view of a file containing pseudo-merge(s)
* (see Documentation/technical/bitmap-format.txt for a specification * (see Documentation/technical/bitmap-format.adoc for a specification
* of the format). * of the format).
*/ */
struct pseudo_merge_map { struct pseudo_merge_map {

2
refs.h
View File

@@ -577,7 +577,7 @@ int refs_for_each_reflog(struct ref_store *refs, each_reflog_fn fn, void *cb_dat
/* /*
* Return 0 iff refname has the correct format for a refname according * Return 0 iff refname has the correct format for a refname according
* to the rules described in Documentation/git-check-ref-format.txt. * to the rules described in Documentation/git-check-ref-format.adoc.
* If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
* reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
* allow a single "*" wildcard character in the refspec. No leading or * allow a single "*" wildcard character in the refspec. No leading or

View File

@@ -1822,7 +1822,7 @@ const char *setup_git_directory_gently(int *nongit_ok)
* *
* Regardless of the state of nongit_ok, startup_info->prefix and * Regardless of the state of nongit_ok, startup_info->prefix and
* the GIT_PREFIX environment variable must always match. For details * the GIT_PREFIX environment variable must always match. For details
* see Documentation/config/alias.txt. * see Documentation/config/alias.adoc.
*/ */
if (nongit_ok && *nongit_ok) if (nongit_ok && *nongit_ok)
startup_info->have_repository = 0; startup_info->have_repository = 0;

View File

@@ -2,7 +2,7 @@
#define GIT_SIMPLE_IPC_H #define GIT_SIMPLE_IPC_H
/* /*
* See Documentation/technical/api-simple-ipc.txt * See Documentation/technical/api-simple-ipc.adoc
*/ */
enum ipc_active_state { enum ipc_active_state {

View File

@@ -1,6 +1,6 @@
/* /*
* Example implementation for the Git filter protocol version 2 * Example implementation for the Git filter protocol version 2
* See Documentation/gitattributes.txt, section "Filter Protocol" * See Documentation/gitattributes.adoc, section "Filter Protocol"
* *
* Usage: test-tool rot13-filter [--always-delay] --log=<path> <capabilities> * Usage: test-tool rot13-filter [--always-delay] --log=<path> <capabilities>
* *

View File

@@ -1,6 +1,6 @@
#!/bin/sh #!/bin/sh
test_description='assert (unbuilt) Documentation/*.txt and -h output test_description='assert (unbuilt) Documentation/*.adoc and -h output
Run this with --debug to see a summary of where we still fail to make Run this with --debug to see a summary of where we still fail to make
the two versions consistent with one another.' the two versions consistent with one another.'
@@ -11,11 +11,11 @@ test_expect_success 'setup: list of builtins' '
git --list-cmds=builtins >builtins git --list-cmds=builtins >builtins
' '
test_expect_success 'list of txt and help mismatches is sorted' ' test_expect_success 'list of adoc and help mismatches is sorted' '
sort -u "$TEST_DIRECTORY"/t0450/txt-help-mismatches >expect && sort -u "$TEST_DIRECTORY"/t0450/adoc-help-mismatches >expect &&
if ! test_cmp expect "$TEST_DIRECTORY"/t0450/txt-help-mismatches if ! test_cmp expect "$TEST_DIRECTORY"/t0450/adoc-help-mismatches
then then
BUG "please keep the list of txt and help mismatches sorted" BUG "please keep the list of adoc and help mismatches sorted"
fi fi
' '
@@ -40,20 +40,20 @@ help_to_synopsis () {
echo "$out" echo "$out"
} }
builtin_to_txt () { builtin_to_adoc () {
echo "$GIT_BUILD_DIR/Documentation/git-$1.txt" echo "$GIT_BUILD_DIR/Documentation/git-$1.adoc"
} }
txt_to_synopsis () { adoc_to_synopsis () {
builtin="$1" && builtin="$1" &&
out_dir="out/$builtin" && out_dir="out/$builtin" &&
out="$out_dir/txt.synopsis" && out="$out_dir/adoc.synopsis" &&
if test -f "$out" if test -f "$out"
then then
echo "$out" && echo "$out" &&
return 0 return 0
fi && fi &&
b2t="$(builtin_to_txt "$builtin")" && b2t="$(builtin_to_adoc "$builtin")" &&
sed -n \ sed -n \
-E '/^\[(verse|synopsis)\]$/,/^$/ { -E '/^\[(verse|synopsis)\]$/,/^$/ {
/^$/d; /^$/d;
@@ -109,29 +109,29 @@ do
fi fi
' '
txt="$(builtin_to_txt "$builtin")" && adoc="$(builtin_to_adoc "$builtin")" &&
preq="$(echo BUILTIN_TXT_$builtin | tr '[:lower:]-' '[:upper:]_')" && preq="$(echo BUILTIN_ADOC_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
if test -f "$txt" if test -f "$adoc"
then then
test_set_prereq "$preq" test_set_prereq "$preq"
fi && fi &&
# *.txt output assertions # *.adoc output assertions
test_expect_success "$preq" "$builtin *.txt SYNOPSIS has dashed labels" ' test_expect_success "$preq" "$builtin *.adoc SYNOPSIS has dashed labels" '
check_dashed_labels "$(txt_to_synopsis "$builtin")" check_dashed_labels "$(adoc_to_synopsis "$builtin")"
' '
# *.txt output consistency assertions # *.adoc output consistency assertions
result= result=
if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/txt-help-mismatches if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/adoc-help-mismatches
then then
result=failure result=failure
else else
result=success result=success
fi && fi &&
test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" ' test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" '
t2s="$(txt_to_synopsis "$builtin")" && t2s="$(adoc_to_synopsis "$builtin")" &&
if test "$builtin" = "merge-tree" if test "$builtin" = "merge-tree"
then then
test_when_finished "rm -f t2s.new" && test_when_finished "rm -f t2s.new" &&
@@ -140,17 +140,17 @@ do
fi && fi &&
h2s="$(help_to_synopsis "$builtin")" && h2s="$(help_to_synopsis "$builtin")" &&
# The *.txt and -h use different spacing for the # The *.adoc and -h use different spacing for the
# alignment of continued usage output, normalize it. # alignment of continued usage output, normalize it.
align_after_nl "$builtin" <"$t2s" >txt && align_after_nl "$builtin" <"$t2s" >adoc &&
align_after_nl "$builtin" <"$h2s" >help && align_after_nl "$builtin" <"$h2s" >help &&
test_cmp txt help test_cmp adoc help
' '
if test_have_prereq "$preq" && test -e txt && test -e help if test_have_prereq "$preq" && test -e adoc && test -e help
then then
test_debug ' test_debug '
if test_cmp txt help >cmp 2>/dev/null if test_cmp adoc help >cmp 2>/dev/null
then then
echo "=== DONE: $builtin ===" echo "=== DONE: $builtin ==="
else else
@@ -161,7 +161,7 @@ do
# Not in test_expect_success in case --run is being # Not in test_expect_success in case --run is being
# used with --debug # used with --debug
rm -f txt help tmp 2>/dev/null rm -f adoc help tmp 2>/dev/null
fi fi
done <builtins done <builtins

View File

@@ -177,7 +177,7 @@ test_expect_success '--full-diff is not affected by --parents' '
# \ / /\ / # \ / /\ /
# `---X--' `---Y--' # `---X--' `---Y--'
# #
# This example is explained in Documentation/rev-list-options.txt # This example is explained in Documentation/rev-list-options.adoc
test_expect_success 'setup rebuild repo' ' test_expect_success 'setup rebuild repo' '
rm -rf .git * && rm -rf .git * &&

View File

@@ -22,7 +22,7 @@ R075 2-old 2-new
R100 3-old 3-new R100 3-old 3-new
Actual similarity indices are parsed from diff output. We rely on the fact that Actual similarity indices are parsed from diff output. We rely on the fact that
they are rounded down (see, e.g., Documentation/diff-generate-patch.txt, which they are rounded down (see, e.g., Documentation/diff-generate-patch.adoc, which
mentions this in a different context). mentions this in a different context).
' '

View File

@@ -31,7 +31,7 @@
* *
* For more info about: trace2 targets, conventions for public functions and * For more info about: trace2 targets, conventions for public functions and
* macros, trace2 target formats and examples on trace2 API usage refer to * macros, trace2 target formats and examples on trace2 API usage refer to
* Documentation/technical/api-trace2.txt * Documentation/technical/api-trace2.adoc
* *
*/ */

View File

@@ -7,7 +7,7 @@
/* /*
* Each entry represents a trace2 setting. * Each entry represents a trace2 setting.
* See Documentation/technical/api-trace2.txt * See Documentation/technical/api-trace2.adoc
*/ */
struct tr2_sysenv_entry { struct tr2_sysenv_entry {
const char *env_var_name; const char *env_var_name;

View File

@@ -168,7 +168,7 @@ struct transport *transport_get(struct remote *, const char *);
* Check whether a transport is allowed by the environment. * Check whether a transport is allowed by the environment.
* *
* Type should generally be the URL scheme, as described in * Type should generally be the URL scheme, as described in
* Documentation/git.txt * Documentation/git.adoc
* *
* from_user specifies if the transport was given by the user. If unknown pass * from_user specifies if the transport was given by the user. If unknown pass
* a -1 to read from the environment to determine if the transport was given by * a -1 to read from the environment to determine if the transport was given by

View File

@@ -2904,7 +2904,7 @@ int threeway_merge(const struct cache_entry * const *stages,
* The rule is to "carry forward" what is in the index without losing * The rule is to "carry forward" what is in the index without losing
* information across a "fast-forward", favoring a successful merge * information across a "fast-forward", favoring a successful merge
* over a merge failure when it makes sense. For details of the * over a merge failure when it makes sense. For details of the
* "carry forward" rule, please see <Documentation/git-read-tree.txt>. * "carry forward" rule, please see <Documentation/git-read-tree.adoc>.
* *
*/ */
int twoway_merge(const struct cache_entry * const *src, int twoway_merge(const struct cache_entry * const *src,

View File

@@ -85,7 +85,7 @@ typedef struct s_xpparam {
regex_t **ignore_regex; regex_t **ignore_regex;
size_t ignore_regex_nr; size_t ignore_regex_nr;
/* See Documentation/diff-options.txt. */ /* See Documentation/diff-options.adoc. */
char **anchors; char **anchors;
size_t anchors_nr; size_t anchors_nr;
} xpparam_t; } xpparam_t;

View File

@@ -64,7 +64,7 @@ struct hashmap {
/* /*
* If 1, this entry can serve as an anchor. See * If 1, this entry can serve as an anchor. See
* Documentation/diff-options.txt for more information. * Documentation/diff-options.adoc for more information.
*/ */
unsigned anchor : 1; unsigned anchor : 1;
} *entries, *first, *last; } *entries, *first, *last;