MyFirstContribution: *.txt -> *.adoc fixes
Signed-off-by: Todd Zullinger <tmz@pobox.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Todd Zullinger committed
Mar 3, 2025 at 15:44 UTC
8b4b41aefb87c9b3dbdf40bb65686cb37038cb71
1 file changed
+12
-12
Documentation/MyFirstContribution.adoc
+12
-12
@@ -21,7 +21,7 @@ This tutorial aims to summarize the following documents, but the reader may find
21
useful additional context:
22
23
- `Documentation/SubmittingPatches`
24
-- `Documentation/howto/new-command.txt`
24
+- `Documentation/howto/new-command.adoc`
25
26
[[getting-help]]
27
=== Getting Help
@@ -331,7 +331,7 @@ function body:
331
apply standard precedence rules. `git_config_get_string_tmp()` will look up
332
a specific key ("user.name") and give you the value. There are a number of
333
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`.
335
336
You should see that the name printed matches the one you see when you run:
337
@@ -461,10 +461,10 @@ $ ./bin-wrappers/git help psuh
461
462
Your new command is undocumented! Let's fix that.
463
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
465
subcommands that Git knows about. You can open these up and take a look to get
466
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
468
project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing
469
Documentation" section). Use the following template to fill out your own
470
manpage:
@@ -543,7 +543,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
543
That's because `-h` is a special case which your command should handle by
544
printing usage.
545
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
547
tool for pulling out options you need to be able to handle, and it takes a
548
usage string.
549
@@ -1088,14 +1088,14 @@ This gives reviewers a summary of what they're in for when reviewing your topic.
1088
The one generated for `psuh` from the sample implementation looks like this:
1089
1090
----
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 +++++++
1097
6 files changed, 128 insertions(+)
1098
- create mode 100644 Documentation/git-psuh.txt
1098
+ create mode 100644 Documentation/git-psuh.adoc
1099
create mode 100644 builtin/psuh.c
1100
create mode 100755 t/t9999-psuh-tutorial.sh
1101
----