diff mbox series

new-command.txt: update reference to builtin docs

Message ID pull.1451.git.git.1675477659972.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit d85e9448dd539032b05eb1d79531b65af1937b80
Headers show
Series new-command.txt: update reference to builtin docs | expand

Commit Message

Wes Lord Feb. 4, 2023, 2:27 a.m. UTC 
From: Wes Lord <weslord@gmail.com>

Commit ec14d4ecb5 (builtin.h: take over documentation from
api-builtin.txt, 2017-08-02) deleted api-builtin.txt and moved the
contents into builtin.h, but new-command.txt still references the old
file.

Signed-off-by: Wes Lord <weslord@gmail.com>
---
    new-command.txt: update reference to builtin docs

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1451%2Fweslord%2Fdoc-builtin-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1451/weslord/doc-builtin-v1
Pull-Request: https://github.com/git/git/pull/1451

 Documentation/howto/new-command.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: 2fc9e9ca3c7505bc60069f11e7ef09b1aeeee473

Comments

Junio C Hamano Feb. 6, 2023, 10:07 p.m. UTC | #1 
"Wes Lord via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Wes Lord <weslord@gmail.com>
>
> Commit ec14d4ecb5 (builtin.h: take over documentation from
> api-builtin.txt, 2017-08-02) deleted api-builtin.txt and moved the
> contents into builtin.h, but new-command.txt still references the old
> file.
>
> Signed-off-by: Wes Lord <weslord@gmail.com>
> ---
>     new-command.txt: update reference to builtin docs

I was sort of hoping that this document has outlived its usefulness
and been taken over by more recently written guies, but it does not
appear to be the case.  A more recently written MyFirstContribution
references this, so keeping its contents fresh does have value.

Thanks, will queue.

> diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
> index 15a4c8031f1..880c51112ba 100644
> --- a/Documentation/howto/new-command.txt
> +++ b/Documentation/howto/new-command.txt
> @@ -1,13 +1,13 @@
>  From: Eric S. Raymond <esr@thyrsus.com>
>  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
>  -------------------
>
> base-commit: 2fc9e9ca3c7505bc60069f11e7ef09b1aeeee473
diff mbox series

Patch

diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
index 15a4c8031f1..880c51112ba 100644
--- a/Documentation/howto/new-command.txt
+++ b/Documentation/howto/new-command.txt
@@ -1,13 +1,13 @@ 
 From: Eric S. Raymond <esr@thyrsus.com>
 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
 -------------------