diff mbox series

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

Message ID pull.1757.v2.git.1720259599119.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series [v2] doc: fix the max number of git show-branches shown | expand

Commit Message

Rikita Ishikawa July 6, 2024, 9:53 a.m. UTC 
From: wonda-tea-coffee <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.

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

Range-diff vs v1:

 1:  b809d610a36 ! 1:  6fc335807d2 doc: fix the max number of git show-branches shown
     @@ Metadata
       ## Commit message ##
          doc: fix the max number of git show-branches shown
      
     -    Contrary to the number listed in the current document,
     -    only 26 are actually shown.
     +    The number to be displayed is calculated by the
     +    following defined in object.h.
      
     -    Signed-off-by: wonda-tea-coffee <lagrange.resolvent@gmail.com>
     +    ```
     +      #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>
      
       ## Documentation/git-show-branch.txt ##
      @@ Documentation/git-show-branch.txt: Shows the commit ancestry graph starting from the commits named


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


base-commit: 06e570c0dfb2a2deb64d217db78e2ec21672f558

Comments

Jeff King July 6, 2024, 11:14 p.m. UTC | #1 
On Sat, Jul 06, 2024 at 09:53:18AM +0000, wonda-tea-coffee via GitGitGadget wrote:

> From: wonda-tea-coffee <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>

Thanks, this version looks good to me. As Junio noted, we'd generally
want the "From" to match the Sign-off (where the former is coming from
the author name in the commit). You can either re-send, or if you give
the OK, he might just fix it up as he applies.

-Peff
diff mbox series

Patch

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.