Re: [PATCH 1/1] Documentation/user-manual.txt: example for generating object hashes

From: Dirk Gouders <dirk@gouders.net>
Date: Mar 8, 2024, 06:45 UTC
Message-ID: <ghbk7p43xq.fsf@gouders.net>
In-Reply-To: <xmqqil27c5p1.fsf@gitster.g>

Junio C Hamano <gitster@pobox.com> writes:

> Dirk Gouders <dirk@gouders.net> writes:

Show 29 quoted lines

>> +The following is a short example that demonstrates how hashes can be
>> +generated manually:
>> +
>> +Let's asume a small text file with the content "Hello git.\n"
>> +-------------------------------------------------
>> +$ cat > hello.txt <<EOF
>> +Hello git.
>> +EOF
>> +-------------------------------------------------
>> +
>> +We can now manually generate the hash `git` would use for this file:
>> +
>> +- The object we want the hash for is of type "blob" and its size is
>> +  11 bytes.
>> +
>> +- Prepend the object header to the file content and feed this to
>> +  sha1sum(1):
>> +
>> +-------------------------------------------------
>> +$ printf "blob 11\0" | cat - hello.txt | sha1sum
>> +7217614ba6e5f4e7db2edaa2cdf5fb5ee4358b57 .
>> +-------------------------------------------------
>> +
>
> ... something like the above (modulo coding style) would be a useful
> addition to help those who want to convince themselves they
> understand how (some parts of) Git works under the hood, and I think
> it would be a welcome addition to some subset of such readers (the
> rest of the world may feel it is way too much detail, though).

May I ask what you meant by "modulo coding style", e.g. where I should look at to make the code of similar style?

I would also add that git-hash-object(1) could be used to verify the result if you think that is OK.

In addition to a suggestion in another mail, the commit would consist of substantial content you suggested and perhaps, you could tell me how to express this; would a Helped-By be correct?

Dirk