From: Junio C Hamano <gitster@pobox.com>
To: Aditya Garg <gargaditya08@live.com>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>,
M Hickford <mirth.hickford@gmail.com>,
"sandals@crustytoothpaste.net" <sandals@crustytoothpaste.net>,
Julian Swagemakers <julian@swagemakers.org>,
Eric Sunshine <sunshine@sunshineco.com>,
Zi Yao <ziyao@disroot.org>,
Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
Subject: Re: [PATCH v4 2/3] docs: improve send-email documentation
Date: Thu, 08 May 2025 07:52:58 -0700 [thread overview]
Message-ID: <xmqqcycj888l.fsf@gitster.g> (raw)
In-Reply-To: <xmqqwmar8bw9.fsf@gitster.g> (Junio C. Hamano's message of "Thu, 08 May 2025 06:33:58 -0700")
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)
next prev parent reply other threads:[~2025-05-08 14:53 UTC|newest]
Thread overview: 68+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-04 13:54 [PATCH 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-04 13:54 ` [PATCH 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-04 14:22 ` Kristoffer Haugsbakk
2025-05-04 15:26 ` Aditya Garg
2025-05-04 16:05 ` Kristoffer Haugsbakk
2025-05-04 13:54 ` [PATCH 2/3] docs: improve send-email documentation Aditya Garg
2025-05-04 13:54 ` [PATCH 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-05 6:16 ` [PATCH v2 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-05 6:16 ` [PATCH v2 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-05 6:16 ` [PATCH v2 2/3] docs: improve send-email documentation Aditya Garg
2025-05-05 19:20 ` Junio C Hamano
2025-05-05 19:30 ` Aditya Garg
2025-05-05 6:16 ` [PATCH v2 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-05 15:23 ` [PATCH v3 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-05 15:23 ` [PATCH v3 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-05 23:49 ` Junio C Hamano
2025-05-06 5:38 ` Aditya Garg
2025-05-06 9:35 ` Aditya Garg
2025-05-06 16:50 ` Aditya Garg
2025-05-06 21:59 ` Junio C Hamano
2025-05-06 17:11 ` Junio C Hamano
2025-05-06 17:23 ` Aditya Garg
2025-05-06 17:49 ` Aditya Garg
2025-05-06 22:07 ` Junio C Hamano
2025-05-05 15:23 ` [PATCH v3 2/3] docs: improve send-email documentation Aditya Garg
2025-05-05 23:54 ` Junio C Hamano
2025-05-06 5:36 ` Aditya Garg
2025-05-05 15:23 ` [PATCH v3 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-07 12:33 ` [PATCH v4 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-07 12:33 ` [PATCH v4 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-07 12:48 ` Aditya Garg
2025-05-07 22:42 ` Junio C Hamano
2025-05-08 10:38 ` Aditya Garg
2025-05-07 12:33 ` [PATCH v4 2/3] docs: improve send-email documentation Aditya Garg
2025-05-07 22:21 ` Junio C Hamano
2025-05-08 3:29 ` Aditya Garg
2025-05-08 13:33 ` Junio C Hamano
2025-05-08 13:52 ` Aditya Garg
2025-05-08 16:23 ` Junio C Hamano
2025-05-08 16:38 ` Aditya Garg
2025-05-08 14:52 ` Junio C Hamano [this message]
2025-05-08 15:05 ` Aditya Garg
2025-05-08 15:08 ` Aditya Garg
2025-05-07 12:33 ` [PATCH v4 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-08 15:18 ` [PATCH v6 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-08 15:18 ` [PATCH v6 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-08 15:18 ` [PATCH v6 2/3] docs: improve send-email documentation Aditya Garg
2025-05-08 15:18 ` [PATCH v6 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-08 17:14 ` [PATCH v7 0/3] Improve checks for valid_fqdn in send-email and update documentation Aditya Garg
2025-05-08 17:14 ` [PATCH v7 1/3] send-mail: improve checks for valid_fqdn Aditya Garg
2025-05-08 17:14 ` [PATCH v7 2/3] docs: improve send-email documentation Aditya Garg
2025-05-08 17:14 ` [PATCH v7 3/3] docs: add credential helper for outlook and gmail in OAuth list of helpers Aditya Garg
2025-05-08 18:08 ` [PATCH v7 0/3] Improve checks for valid_fqdn in send-email and update documentation Junio C Hamano
2025-05-09 16:49 ` [PATCH] send-email: try to get fqdn by running hostname --fqdn on Linux and macOS Aditya Garg
2025-05-09 20:13 ` Junio C Hamano
2025-05-10 7:37 ` [PATCH v2] " Aditya Garg
2025-05-12 7:46 ` Julian Swagemakers
2025-05-12 7:49 ` Aditya Garg
2025-05-12 16:42 ` Junio C Hamano
2025-05-12 16:46 ` Aditya Garg
2025-05-12 17:34 ` Junio C Hamano
2025-05-12 17:42 ` Aditya Garg
2025-05-12 19:05 ` Eric Sunshine
2025-05-12 20:15 ` Junio C Hamano
2025-05-13 12:28 ` Aditya Garg
2025-05-12 13:32 ` Junio C Hamano
2025-05-12 8:11 ` [PATCH v3] send-email: try to get fqdn by running hostname -f " Aditya Garg
2025-05-12 17:16 ` [PATCH v4] " Aditya Garg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqcycj888l.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=gargaditya08@live.com \
--cc=git@vger.kernel.org \
--cc=julian@swagemakers.org \
--cc=kristofferhaugsbakk@fastmail.com \
--cc=mirth.hickford@gmail.com \
--cc=sandals@crustytoothpaste.net \
--cc=sunshine@sunshineco.com \
--cc=ziyao@disroot.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.