From: Kazuo Yagi <kazuo.yagi@xxxxxxxxx>
ec14d4e had moved documentation from api-builtin.txt to builtin.h.
This patch updates new-command.txt to reflect that change.
Signed-off-by: Kazuo Yagi <kazuo.yagi@xxxxxxxxx>
---
Fixed unavailable link in Documentation/howto/new-command.txt along…
… with the changeset history.
Signed-off-by: Kazuo Yagi kazuo.yagi@xxxxxxxxx [kazuo.yagi@xxxxxxxxx]
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-647%2Fkyagi%2Ffix-unavailable-link-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-647/kyagi/fix-unavailable-link-v1
Pull-Request: https://github.com/git/git/pull/647
Documentation/howto/new-command.txt | 6 +++---
builtin.h | 25 +++++++++++++++++++++++++
2 files changed, 28 insertions(+), 3 deletions(-)
diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
index 15a4c8031f1..ac73c98be72 100644
--- a/Documentation/howto/new-command.txt
+++ b/Documentation/howto/new-command.txt
@@ -1,13 +1,13 @@
From: Eric S. Raymond <esr@xxxxxxxxxxx>
Abstract: This is how-to documentation for people who want to add extension
- commands to Git. It should be read alongside api-builtin.txt.
+ commands to Git. It should be read alongside builtin.h.
Content-type: text/asciidoc
How to integrate new subcommands
================================
This is how-to documentation for people who want to add extension
-commands to Git. It should be read alongside api-builtin.txt.
+commands to Git. It should be read alongside builtin.h.
Runtime environment
-------------------
@@ -48,7 +48,7 @@ binary); this organization makes it easy for people reading the code
to find things.
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.
What every extension command needs
diff --git a/builtin.h b/builtin.h
index 5cf5df69f72..101ef8edc4d 100644
--- a/builtin.h
+++ b/builtin.h
@@ -92,6 +92,31 @@
*
* The return value from `cmd_foo()` becomes the exit status of the
* command.
+ *
+ * Changeset History
+ * -----------------
+ *
+ * The following describes how the documentation has finally been placed
+ * in this file, over the related changesets.
+ *
+ * +-----------------+ *OLD LINK* +-----------------+
+ * | api-builtin.txt | <~~~~~~~~~~ | api-command.txt |
+ * +-----------------+ +-----------------+
+ * | ~ * |
+ * | deleted, ~ N | moved and renamed from
+ * | contents is taken over ~ E | Documentation/technical/
+ * | by builtin.h ~ W | to
+ * | (this file) ~ | Documentation/howto/
+ * | ~ L |
+ * | ~ I |
+ * v ~ N v
+ * +-----------+ ~ K +-----------------+
+ * | builtin.h | <~~~~~~~~~~~~ * | new-command.txt |
+ * +-----------+ +-----------------+
+ *
+ * ---> moved to(or renamed to)
+ * ~~~> refers to
+ *
*/
#define DEFAULT_MERGE_LOG_LEN 20
base-commit: 3cb8921f74354a3a4aeaa932869acb7e6aabe630
--
gitgitgadget
