[PATCH v5] doc: fix the max number of git show-branches shown

From: Rikita Ishikawa via GitGitGadget <gitgitgadget@gmail.com>
Date: Jul 8, 2024, 13:07 UTC
Message-ID: <pull.1757.v5.git.1720444080034.gitgitgadget@gmail.com>
In-Reply-To: <pull.1757.v4.git.1720319311301.gitgitgadget@gmail.com>

From: Rikita Ishikawa <lagrange.resolvent@gmail.com>

The number to be displayed is calculated by the following defined in object.h.

    #define REV_SHIFT        2
    #define MAX_REVS        (FLAG_BITS - REV_SHIFT)

FLAG_BITS is currently 28, so 26 is the correct number.

Signed-off-by: Rikita Ishikawa <lagrange.resolvent@gmail.com>
---
    doc: fix the max number of git show-branches shown
    
    Changes since v1:
    
     * Explain in the commit message why "26" is the correct number.
     * No change (to rename GitHub and re-send).
     * Change the author of the commit.
     * Fixed code block in commit message.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1757%2Fwonda-tea-coffee%2Fupdate-git-show-branch-description-v5
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1757/wonda-tea-coffee/update-git-show-branch-description-v5
Pull-Request: https://github.com/gitgitgadget/git/pull/1757

Range-diff vs v4:

 1:  76ab2f17015 ! 1:  7c0af41794f doc: fix the max number of git show-branches shown
     @@ Commit message
          The number to be displayed is calculated by the
          following defined in object.h.
      
     -    ```
     -      #define REV_SHIFT        2
     -      #define MAX_REVS        (FLAG_BITS - REV_SHIFT)
     -    ```
     +        #define REV_SHIFT        2
     +        #define MAX_REVS        (FLAG_BITS - REV_SHIFT)
      
          FLAG_BITS is currently 28, so 26 is the correct
          number.

 Documentation/git-show-branch.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index c771c897707..bc31d8b6d33 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -22,7 +22,7 @@ Shows the commit ancestry graph starting from the commits named
 with <rev>s or <glob>s (or all refs under refs/heads
 and/or refs/tags) semi-visually.
 
-It cannot show more than 29 branches and commits at a time.
+It cannot show more than 26 branches and commits at a time.
 
 It uses `showbranch.default` multi-valued configuration items if
 no <rev> or <glob> is given on the command line.

base-commit: 06e570c0dfb2a2deb64d217db78e2ec21672f558

-- 
gitgitgadget