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

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 8, 2024, 15:24 UTC
Message-ID: <xmqqil1wiw5l.fsf@gitster.g>
In-Reply-To: <ghbk7p43xq.fsf@gouders.net>

Dirk Gouders <dirk@gouders.net> writes:

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

Documentation/CodingGuidelines would be a good start, but

 * A here-doc for a single liner is probably an overkill.  Why not

    echo "Hello, world" >file

   In either way, in our codebase a redirection operator '>' (or
   '<') has one whitespace before it, and no whitespace after it
   before the file.

 * printf piped to "cat - file" whose output feeds another pipe
   looked unusual.  More usual way novices write may be

    { printf ... ; cat file; } | sha1sum

were the two things I noticed.

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

git hash-object can be used to replace that whole thing ;-)

> 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?

I think many may prefer to downcase B in By, but if it is "substantial", probably. I do not think I gave much in this discussion to become a substantial addition to the original, though.