Re: [PATCH v3 1/4] doc: interpret-trailers: don’t use heredoc in examples

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 12, 2023, 21:16 UTC
Message-ID: <xmqqcz487qds.fsf@gitster.g>
In-Reply-To: <fd515ad8b4b7c04aea9f332f47a660350d91fd57.1681326818.git.code@khaugsbakk.name>

Kristoffer Haugsbakk <code@khaugsbakk.name> writes:

Show 8 quoted lines

> Let’s get rid of these whitespace errors and also make the examples more
> friendly to cut-and-paste by replacing the heredocs with files which are
> shown with cat(1).
> -$ git interpret-trailers <<EOF
> -> EOF
> +$ git interpret-trailers <empty-msg.txt
>  
>  Signed-off-by: Bob <bob@example.com>

Nobody created empty-msg.txt and readers need to guess that it is a file with 0-byte contents. Using "</dev/null" would have avoided the need for guessing.

But it seems that this goes away at the end of the series, so let's not worry too much about it ;-)

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.