From: Junio C Hamano <gitster@pobox.com>
To: Denton Liu <liu.denton@gmail.com>
Cc: git@vger.kernel.org, pclouds@gmail.com
Subject: Re: [PATCH v2 2/3] git-submodule.txt: make subcommands underlined
Date: Wed, 13 Feb 2019 10:30:37 -0800 [thread overview]
Message-ID: <xmqq4l97czhu.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20190213081518.GA21926@archbookpro.localdomain> (Denton Liu's message of "Wed, 13 Feb 2019 00:15:18 -0800")
Denton Liu <liu.denton@gmail.com> writes:
> On Tue, Feb 12, 2019 at 01:56:11AM -0800, Denton Liu wrote:
>> In git-remote.txt, the subcommands are underlined. Following that, we
>> also underline the subcommands in git-submodule.txt.
>
> I'd like to retract this patch. I realised that between git-remote,
> git-submodule, git-notes, git-stash, git-bisect, git-reflog, it's pretty
> inconsistent between whether it's formatted with the underline or not.
>
> Also, I missed the underlining of the subcommands in the body of the
> document.
I actually do not think using '<emph>' inside the SYNOPSIS section
is such a great idea to begin with. We do want `<literal>` mark-up
in the body text to tell the users that it is something they need to
type literally (as opposed to what they can substitute with their
own).
In any case, consistent mark-up in the documentation is good. But
you would probably want to make it a separate series, either a
preparatory one before real content changes are made, or a cleanup
one after.
Thanks.
next prev parent reply other threads:[~2019-02-13 18:30 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-12 4:03 [PATCH] git-submodule.txt: document default behavior Denton Liu
2019-02-12 5:33 ` Duy Nguyen
2019-02-12 9:56 ` [PATCH v2 0/3] Document git-submodule's " Denton Liu
2019-02-12 9:56 ` [PATCH v2 1/3] git-remote.txt: be specific about " Denton Liu
2019-02-12 9:56 ` [PATCH v2 2/3] git-submodule.txt: make subcommands underlined Denton Liu
2019-02-13 8:15 ` Denton Liu
2019-02-13 9:55 ` Duy Nguyen
2019-02-13 18:30 ` Junio C Hamano [this message]
2019-02-12 9:56 ` [PATCH v2 3/3] submodule: document default behavior Denton Liu
2019-02-13 18:39 ` Junio C Hamano
2019-02-14 7:24 ` Denton Liu
2019-02-14 17:41 ` Junio C Hamano
2019-02-15 9:26 ` [PATCH v3 0/1] Document git-submodule's " Denton Liu
2019-02-15 9:26 ` [PATCH v3 1/1] submodule: document " Denton Liu
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq4l97czhu.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=liu.denton@gmail.com \
--cc=pclouds@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).