From: Junio C Hamano <gitster@pobox.com>
To: Christian Couder <christian.couder@gmail.com>
Cc: Shao-Ce SUN via GitGitGadget <gitgitgadget@gmail.com>,
git <git@vger.kernel.org>, Shao-Ce SUN <sunshaoce@iscas.ac.cn>
Subject: Re: [PATCH] Fix wrong info in `INSTALL`
Date: Wed, 25 May 2022 09:05:30 -0700 [thread overview]
Message-ID: <xmqqo7zla985.fsf@gitster.g> (raw)
In-Reply-To: <CAP8UFD2BS3OuJD7xhb6M+bX3ojLqM8ZuXK_h4w0CvdYRfmzVqg@mail.gmail.com> (Christian Couder's message of "Wed, 25 May 2022 07:29:50 +0200")
Christian Couder <christian.couder@gmail.com> writes:
> So we could perhaps get rid of the ';', but on the other hand ";#"
> should make it extra clear that the command before it ended and that
> the rest of the line is a comment.
True. In modern shells, ";" in the ";#" sequence may not be
necessary, but consistently writing ";#" as if it were a single
token would probably be a good idea in the documentation.
Of course, if we can declare that the usefulness of the monospace
plain text document does not matter, we could do without ";#" and
typeset the comment (and the prompt) in different font and/or color.
It would make it easier to see which part of the line is what is to
be typed verbatim.
Thanks.
prev parent reply other threads:[~2022-05-25 16:05 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-24 20:43 [PATCH] Fix wrong info in `INSTALL` Shao-Ce SUN via GitGitGadget
2022-05-24 21:39 ` Ævar Arnfjörð Bjarmason
2022-05-24 22:03 ` Philippe Blain
2022-05-24 22:21 ` Junio C Hamano
2022-05-25 5:29 ` Christian Couder
2022-05-25 16:05 ` Junio C Hamano [this message]
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=xmqqo7zla985.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=sunshaoce@iscas.ac.cn \
/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 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 NNTP newsgroup(s).