Re: [PATCH] Fix wrong info in `INSTALL`

From: Junio C Hamano <gitster@pobox.com>
Date: May 25, 2022, 16:05 UTC
Message-ID: <xmqqo7zla985.fsf@gitster.g>
In-Reply-To: <CAP8UFD2BS3OuJD7xhb6M+bX3ojLqM8ZuXK_h4w0CvdYRfmzVqg@mail.gmail.com>

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.