Skip to content

Commit 62c5889

Browse files
committed
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 ...
2 parents e969bc8 + 61cd812 commit 62c5889

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+119
-120
lines changed

.gitattributes

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ CODE_OF_CONDUCT.md -whitespace
1212
/GIT-VERSION-GEN text eol=lf
1313
/mergetools/* text eol=lf
1414
/t/oid-info/* text eol=lf
15-
/Documentation/git-merge.txt conflict-marker-size=32
16-
/Documentation/gitk.txt conflict-marker-size=32
17-
/Documentation/user-manual.txt conflict-marker-size=32
15+
/Documentation/git-merge.adoc conflict-marker-size=32
16+
/Documentation/gitk.adoc conflict-marker-size=32
17+
/Documentation/user-manual.adoc conflict-marker-size=32
1818
/t/t????-*.sh conflict-marker-size=32

Documentation/.gitattributes

Lines changed: 0 additions & 1 deletion
This file was deleted.

Documentation/CodingGuidelines

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ code are expected to match the style the surrounding code already
4444
uses (even if it doesn't match the overall style of existing code).
4545

4646
But if you must have a list of rules, here are some language
47-
specific ones. Note that Documentation/ToolsForGit.txt document
47+
specific ones. Note that Documentation/ToolsForGit.adoc document
4848
has a collection of tips to help you use some external tools
4949
to conform to these guidelines.
5050

@@ -755,7 +755,7 @@ Externally Visible Names
755755
Writing Documentation:
756756

757757
Most (if not all) of the documentation pages are written in the
758-
AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and
758+
AsciiDoc format in *.adoc files (e.g. Documentation/git.adoc), and
759759
processed into HTML and manpages (e.g. git.html and git.1 in the
760760
same directory).
761761

Documentation/MyFirstContribution.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This tutorial aims to summarize the following documents, but the reader may find
2121
useful additional context:
2222

2323
- `Documentation/SubmittingPatches`
24-
- `Documentation/howto/new-command.txt`
24+
- `Documentation/howto/new-command.adoc`
2525

2626
[[getting-help]]
2727
=== Getting Help
@@ -331,7 +331,7 @@ function body:
331331
apply standard precedence rules. `git_config_get_string_tmp()` will look up
332332
a specific key ("user.name") and give you the value. There are a number of
333333
single-key lookup functions like this one; you can see them all (and more info
334-
about how to use `git_config()`) in `Documentation/technical/api-config.txt`.
334+
about how to use `git_config()`) in `Documentation/technical/api-config.adoc`.
335335

336336
You should see that the name printed matches the one you see when you run:
337337

@@ -461,10 +461,10 @@ $ ./bin-wrappers/git help psuh
461461

462462
Your new command is undocumented! Let's fix that.
463463

464-
Take a look at `Documentation/git-*.txt`. These are the manpages for the
464+
Take a look at `Documentation/git-*.adoc`. These are the manpages for the
465465
subcommands that Git knows about. You can open these up and take a look to get
466466
acquainted with the format, but then go ahead and make a new file
467-
`Documentation/git-psuh.txt`. Like with most of the documentation in the Git
467+
`Documentation/git-psuh.adoc`. Like with most of the documentation in the Git
468468
project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing
469469
Documentation" section). Use the following template to fill out your own
470470
manpage:
@@ -543,7 +543,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
543543
That's because `-h` is a special case which your command should handle by
544544
printing usage.
545545

546-
Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy
546+
Take a look at `Documentation/technical/api-parse-options.adoc`. This is a handy
547547
tool for pulling out options you need to be able to handle, and it takes a
548548
usage string.
549549

@@ -1088,14 +1088,14 @@ This gives reviewers a summary of what they're in for when reviewing your topic.
10881088
The one generated for `psuh` from the sample implementation looks like this:
10891089

10901090
----
1091-
Documentation/git-psuh.txt | 40 +++++++++++++++++++++
1092-
Makefile | 1 +
1093-
builtin.h | 1 +
1094-
builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++
1095-
git.c | 1 +
1096-
t/t9999-psuh-tutorial.sh | 12 +++++++
1091+
Documentation/git-psuh.adoc | 40 +++++++++++++++++++++
1092+
Makefile | 1 +
1093+
builtin.h | 1 +
1094+
builtin/psuh.c | 73 ++++++++++++++++++++++++++++++++++++++
1095+
git.c | 1 +
1096+
t/t9999-psuh-tutorial.sh | 12 +++++++
10971097
6 files changed, 128 insertions(+)
1098-
create mode 100644 Documentation/git-psuh.txt
1098+
create mode 100644 Documentation/git-psuh.adoc
10991099
create mode 100644 builtin/psuh.c
11001100
create mode 100755 t/t9999-psuh-tutorial.sh
11011101
----

Documentation/MyFirstObjectWalk.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ revision walk is used for operations like `git log`.
1515

1616
=== Related Reading
1717

18-
- `Documentation/user-manual.txt` under "Hacking Git" contains some coverage of
18+
- `Documentation/user-manual.adoc` under "Hacking Git" contains some coverage of
1919
the revision walker in its various incarnations.
2020
- `revision.h`
2121
- https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists]
@@ -112,7 +112,7 @@ $ GIT_TRACE=1 ./bin-wrappers/git walken
112112
----
113113

114114
NOTE: For a more exhaustive overview of the new command process, take a look at
115-
`Documentation/MyFirstContribution.txt`.
115+
`Documentation/MyFirstContribution.adoc`.
116116

117117
NOTE: A reference implementation can be found at
118118
https://github.com/nasamuffin/git/tree/revwalk.
@@ -132,7 +132,7 @@ used to track the allocated size of the list.
132132
Per entry, we find:
133133

134134
`item` is the object provided upon which to base the object walk. Items in Git
135-
can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.txt`.)
135+
can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.adoc`.)
136136

137137
`name` is the object ID (OID) of the object - a hex string you may be familiar
138138
with from using Git to organize your source in the past. Check the tutorial
@@ -141,7 +141,7 @@ from.
141141

142142
`whence` indicates some information about what to do with the parents of the
143143
specified object. We'll explore this flag more later on; take a look at
144-
`Documentation/revisions.txt` to get an idea of what could set the `whence`
144+
`Documentation/revisions.adoc` to get an idea of what could set the `whence`
145145
value.
146146

147147
`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.
153153

154154
This one is quite a bit longer, and many fields are only used during the walk
155155
by `revision.c` - not configuration options. Most of the configurable flags in
156-
`struct rev_info` have a mirror in `Documentation/rev-list-options.txt`. It's a
156+
`struct rev_info` have a mirror in `Documentation/rev-list-options.adoc`. It's a
157157
good idea to take some time and read through that document.
158158

159159
== Basic Commit Walk
@@ -710,7 +710,7 @@ objects grows along with the Git project.
710710
=== Adding a Filter
711711

712712
There are a handful of filters that we can apply to the object walk laid out in
713-
`Documentation/rev-list-options.txt`. These filters are typically useful for
713+
`Documentation/rev-list-options.adoc`. These filters are typically useful for
714714
operations such as creating packfiles or performing a partial clone. They are
715715
defined in `list-objects-filter-options.h`. For the purposes of this tutorial we
716716
will use the "tree:1" filter, which causes the walk to omit all trees and blobs

Documentation/build-docdep.perl

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
my %include = ();
55
my %included = ();
66

7-
for my $text (<*.txt>) {
8-
open I, '<', $text || die "cannot read: $text";
7+
for my $adoc (<*.adoc>) {
8+
open I, '<', $adoc || die "cannot read: $adoc";
99
while (<I>) {
1010
if (/^include::/) {
1111
chomp;
1212
s/^include::\s*//;
1313
s/\[\]//;
1414
s/{build_dir}/${build_dir}/;
15-
$include{$text}{$_} = 1;
15+
$include{$adoc}{$_} = 1;
1616
$included{$_} = 1;
1717
}
1818
}
@@ -23,14 +23,14 @@
2323
my $changed = 1;
2424
while ($changed) {
2525
$changed = 0;
26-
while (my ($text, $included) = each %include) {
26+
while (my ($adoc, $included) = each %include) {
2727
for my $i (keys %$included) {
28-
# $text has include::$i; if $i includes $j
29-
# $text indirectly includes $j.
28+
# $adoc has include::$i; if $i includes $j
29+
# $adoc indirectly includes $j.
3030
if (exists $include{$i}) {
3131
for my $j (keys %{$include{$i}}) {
32-
if (!exists $include{$text}{$j}) {
33-
$include{$text}{$j} = 1;
32+
if (!exists $include{$adoc}{$j}) {
33+
$include{$adoc}{$j} = 1;
3434
$included{$j} = 1;
3535
$changed = 1;
3636
}
@@ -40,10 +40,10 @@
4040
}
4141
}
4242

43-
foreach my $text (sort keys %include) {
44-
my $included = $include{$text};
45-
if (! exists $included{$text} &&
46-
(my $base = $text) =~ s/\.txt$//) {
43+
foreach my $adoc (sort keys %include) {
44+
my $included = $include{$adoc};
45+
if (! exists $included{$adoc} &&
46+
(my $base = $adoc) =~ s/\.adoc$//) {
4747
print "$base.html $base.xml : ", join(" ", sort keys %$included), "\n";
4848
}
4949
}

Documentation/gitattributes.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ If the filter command (a string value) is defined via
513513
`filter.<driver>.process` then Git can process all blobs with a
514514
single filter invocation for the entire life of a single Git
515515
command. This is achieved by using the long-running process protocol
516-
(described in technical/long-running-process-protocol.txt).
516+
(described in Documentation/technical/long-running-process-protocol.adoc).
517517

518518
When Git encounters the first file that needs to be cleaned or smudged,
519519
it starts the filter and performs the handshake. In the handshake, the
@@ -1177,11 +1177,11 @@ integer has a meaningful effect.
11771177

11781178
For example, this line in `.gitattributes` can be used to tell the merge
11791179
machinery to leave much longer (instead of the usual 7-character-long)
1180-
conflict markers when merging the file `Documentation/git-merge.txt`
1180+
conflict markers when merging the file `Documentation/git-merge.adoc`
11811181
results in a conflict.
11821182

11831183
------------------------
1184-
Documentation/git-merge.txt conflict-marker-size=32
1184+
Documentation/git-merge.adoc conflict-marker-size=32
11851185
------------------------
11861186

11871187

Documentation/howto/howto-index.sh

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ people describing how they use Git in their workflow.
99
1010
EOF
1111

12-
for txt
12+
for adoc
1313
do
14-
title=$(expr "$txt" : '.*/\(.*\)\.txt$')
14+
title=$(expr "$adoc" : '.*/\(.*\)\.adoc$')
1515
from=$(sed -ne '
1616
/^$/q
1717
/^From:[ ]/{
@@ -21,7 +21,7 @@ do
2121
s/^/by /
2222
p
2323
}
24-
' "$txt")
24+
' "$adoc")
2525

2626
abstract=$(sed -ne '
2727
/^Abstract:[ ]/{
@@ -39,13 +39,13 @@ do
3939
x
4040
p
4141
q
42-
}' "$txt")
42+
}' "$adoc")
4343

44-
if grep 'Content-type: text/asciidoc' >/dev/null $txt
44+
if grep 'Content-type: text/asciidoc' >/dev/null $adoc
4545
then
46-
file=$(expr "$txt" : '\(.*\)\.txt$').html
46+
file=$(expr "$adoc" : '\(.*\)\.adoc$').html
4747
else
48-
file="$txt"
48+
file="$adoc"
4949
fi
5050

5151
echo "* link:howto/$(basename "$file")[$title] $from

Documentation/howto/new-command.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ binary); this organization makes it easy for people reading the code
4848
to find things.
4949

5050
See the CodingGuidelines document for other guidance on what we consider
51-
good practice in C and shell, and api-builtin.txt for the support
51+
good practice in C and shell, and builtin.h for the support
5252
functions available to built-in commands written in C.
5353

5454
What every extension command needs

Documentation/technical/api-simple-ipc.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Comparison with sub-process model
3636
---------------------------------
3737

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

Documentation/technical/hash-function-transition.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ inflated again in step 3, for a total of two inflations.
394394

395395
Step 4 is probably necessary for good read-time performance. "git
396396
pack-objects" on the server optimizes the pack file for good data
397-
locality (see Documentation/technical/pack-heuristics.txt).
397+
locality (see Documentation/technical/pack-heuristics.adoc).
398398

399399
Details of this process are likely to change. It will take some
400400
experimenting to get this to perform well.

Documentation/technical/partial-clone.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ See "filter" in linkgit:gitprotocol-pack[5].
8585
server to request filtering during packfile construction.
8686
+
8787
There are various filters available to accommodate different situations.
88-
See "--filter=<filter-spec>" in Documentation/rev-list-options.txt.
88+
See "--filter=<filter-spec>" in Documentation/rev-list-options.adoc.
8989
9090
- On the server pack-objects applies the requested filter-spec as it
9191
creates "filtered" packfiles for the client.

Makefile

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

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Please read the file [INSTALL][] for installation instructions.
1717
Many Git online resources are accessible from <https://git-scm.com/>
1818
including full documentation and Git related tools.
1919

20-
See [Documentation/gittutorial.txt][] to get started, then see
21-
[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
22-
`Documentation/git-<commandname>.txt` for documentation of each command.
20+
See [Documentation/gittutorial.adoc][] to get started, then see
21+
[Documentation/giteveryday.adoc][] for a useful minimum set of commands, and
22+
`Documentation/git-<commandname>.adoc` for documentation of each command.
2323
If git has been correctly installed, then the tutorial can also be
2424
read with `man gittutorial` or `git help tutorial`, and the
2525
documentation of each command with `man git-<commandname>` or `git help
2626
<commandname>`.
2727

28-
CVS users may also want to read [Documentation/gitcvs-migration.txt][]
28+
CVS users may also want to read [Documentation/gitcvs-migration.adoc][]
2929
(`man gitcvs-migration` or `git help cvs-migration` if git is
3030
installed).
3131

@@ -66,9 +66,9 @@ and the name as (depending on your mood):
6666
- "goddamn idiotic truckload of sh*t": when it breaks
6767

6868
[INSTALL]: INSTALL
69-
[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
70-
[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
71-
[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
69+
[Documentation/gittutorial.adoc]: Documentation/gittutorial.adoc
70+
[Documentation/giteveryday.adoc]: Documentation/giteveryday.adoc
71+
[Documentation/gitcvs-migration.adoc]: Documentation/gitcvs-migration.adoc
7272
[Documentation/SubmittingPatches]: Documentation/SubmittingPatches
7373
[Documentation/CodingGuidelines]: Documentation/CodingGuidelines
7474
[po/README.md]: po/README.md

advice.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ struct string_list;
77
* To add a new advice, you need to:
88
* Define a new advice_type.
99
* Add a new entry to advice_setting array.
10-
* Add the new config variable to Documentation/config/advice.txt.
10+
* Add the new config variable to Documentation/config/advice.adoc.
1111
* Call advise_if_enabled to print your advice.
1212
*/
1313
enum advice_type {

apply.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ static int parse_whitespace_option(struct apply_state *state, const char *option
8282
}
8383
/*
8484
* Please update $__git_whitespacelist in git-completion.bash,
85-
* Documentation/git-apply.txt, and Documentation/git-am.txt
85+
* Documentation/git-apply.adoc, and Documentation/git-am.adoc
8686
* when you add new options.
8787
*/
8888
return error(_("unrecognized whitespace option '%s'"), option);

builtin.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
*
6464
* . Add tests to `t/` directory.
6565
*
66-
* . Write documentation in `Documentation/git-foo.txt`.
66+
* . Write documentation in `Documentation/git-foo.adoc`.
6767
*
6868
* . Add an entry for `git-foo` to `command-list.txt`.
6969
*

0 commit comments

Comments
 (0)