Subject: Re: [PATCH v3 12/12] builtin/refs: new command to migrate ref storage formats

From: Junio C Hamano <[email-masked]>
Date: Sat, 01 Jun 2024 18:03:27 -0700

Junio C Hamano <[email-masked]> writes:

> One thing missing is an entry in command-list.
>
> If you ran "make check-docs", you would have seen
>
>     $ make check-docs
>     no link: git-refs
>
> The Documentation/MyFirstContribution.txt file does mention
> command-list, but it is rather messy and unorganized.  I think the
> checklist at the top of <builtin.h> would be the best source of
> information at this moment.
>
> Thanks.

You'd need something like this.  

With the command missing from command-list.txt, git.1 (which has the
list of commands) will fail to mention the command, of course.

The fix to the documentation file itself is also crucial, as the
name section is where we grab the list of command descriptions used
in "git help -a", and with the extra blank line, git.1 will fail to
build.

--- >8 ---
Subject: SQUASH???

diff --git a/Documentation/git-refs.txt b/Documentation/git-refs.txt
index 3e9c05185a..5b99e04385 100644
--- a/Documentation/git-refs.txt
+++ b/Documentation/git-refs.txt
@@ -3,12 +3,11 @@ git-refs(1)
 
 NAME
 ----
-
 git-refs - Low-level access to refs
 
+
 SYNOPSIS
 --------
-
 [verse]
 'git refs migrate' --ref-format=<format> [--dry-run]
 
diff --git a/command-list.txt b/command-list.txt
index c4cd0f352b..e0bb87b3b5 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -157,6 +157,7 @@ git-read-tree                           plumbingmanipulators
 git-rebase                              mainporcelain           history
 git-receive-pack                        synchelpers
 git-reflog                              ancillarymanipulators           complete
+git-refs                                ancillarymanipulators           complete
 git-remote                              ancillarymanipulators           complete
 git-repack                              ancillarymanipulators           complete
 git-replace                             ancillarymanipulators           complete