commit-graph-format.txt: fix no-parent value

Commit Message

Phillip Wood via GitGitGadget Sept. 15, 2020, 4:03 a.m. UTC

From: Conor Davis <[e-mail]>

The correct value from commit-graph.c:

    #define GRAPH_PARENT_NONE 0x70000000

Signed-off-by: Conor Davis <[e-mail]>
---
    commit-graph-format.txt: fix no-parent value
    
    The correct value from commit-graph.c:
    
    #define GRAPH_PARENT_NONE 0x70000000
    
    Signed-off-by: Conor Davis [e-mail] [[e-mail]]

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-733%2Favoidscorn%2Fgraph-parent-none-doc-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-733/avoidscorn/graph-parent-none-doc-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/733

 Documentation/technical/commit-graph-format.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 47ae905ffb98cc4d4fd90083da6bc8dab55d9ecc

Comments

Taylor Blau Sept. 15, 2020, 4:26 a.m. UTC | #1

Hi Conor,

On Tue, Sep 15, 2020 at 04:03:53AM +0000, Conor Davis via GitGitGadget wrote:
> -      of the ith commit. Stores value 0x7000000 if no parent in that
> +      of the ith commit. Stores value 0x70000000 if no parent in that

Thnaks for fixing this up. This dates back to a9aa3c0927 (commit-graph:
fix documentation inconsistencies, 2018-06-28) which mentions the
correct value in the commit message, but uses the incorrect value in the
patch itself.

For what it's worth, I can hardly blame the author of a9aa3c0927, since
I had to flip back and forth between the two a couple of times to
convince myself which one was which.

Anyway, this is obviously correct. Thank you for your contribution!

  Reviewed-by: Taylor Blau <[e-mail]>

Thanks,
Taylor

Derrick Stolee Sept. 15, 2020, 12:16 p.m. UTC | #2

On 9/15/2020 12:26 AM, Taylor Blau wrote:
> For what it's worth, I can hardly blame the author of a9aa3c0927,

I can!

Thanks for noticing the doc bug. May I ask why you were looking
at the format document so closely? Are you working on a new
implementation?

Thanks,
-Stolee

Conor Davis Sept. 15, 2020, 11:12 p.m. UTC | #3

On 9/15/20 7:16 AM, Derrick Stolee wrote:
> On 9/15/2020 12:26 AM, Taylor Blau wrote:
>> For what it's worth, I can hardly blame the author of a9aa3c0927,
> I can!
>
> Thanks for noticing the doc bug. May I ask why you were looking
> at the format document so closely? Are you working on a new
> implementation?

Yes, I'm adding commit-graph support to gitoxide: 
https://github.com/Byron/gitoxide/pull/21

-Conor

Patch

diff --git a/Documentation/technical/commit-graph-format.txt b/Documentation/technical/commit-graph-format.txt
index 1beef17182..002a480c9c 100644
--- a/Documentation/technical/commit-graph-format.txt
+++ b/Documentation/technical/commit-graph-format.txt
@@ -77,7 +77,7 @@  CHUNK DATA:
   Commit Data (ID: {'C', 'D', 'A', 'T' }) (N * (H + 16) bytes)
     * The first H bytes are for the OID of the root tree.
     * The next 8 bytes are for the positions of the first two parents
-      of the ith commit. Stores value 0x7000000 if no parent in that
+      of the ith commit. Stores value 0x70000000 if no parent in that
       position. If there are more than two parents, the second value
       has its most-significant bit on and the other bits store an array
       position into the Extra Edge List chunk.