Re: [PATCH v4 2/3] docs: improve send-email documentation

From: Junio C Hamano <gitster@pobox.com>
Date: May 8, 2025, 14:52 UTC
Message-ID: <xmqqcycj888l.fsf@gitster.g>
In-Reply-To: <xmqqwmar8bw9.fsf@gitster.g>

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

>> I think ~/.gitconfig should be in single quotes, its not a command.
>
> "Is this something the end-user would type verbatim?" is the criteria,
> not "Is this a command name?".

Looking for "^Markup:" in Documentation/CodingGuidelines, we find a better description.

 Literal parts (e.g. use of command-line options, command names,
 branch names, URLs, pathnames (files and directories), configuration and
 environment variables) must be typeset as verbatim (i.e. wrapped with
 backticks):
   `--pretty=oneline`
   `git rev-list`
   `remote.pushDefault`
   `http://git.example.com`
   `.git/config`
   `GIT_DIR`
   `HEAD`
   `umask`(2)

$ 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.