list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: "Martin Ågren" <>
To: Junio C Hamano <>
Cc: "Git Mailing List" <>,
	"Sergey Organov" <>,
	"Patrick Steinhardt" <>,
	"Ævar Arnfjörð Bjarmason" <>
Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering
Date: Fri, 19 Feb 2021 07:33:22 +0100	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <xmqqim6pgqev.fsf@gitster.g>

On Thu, 18 Feb 2021 at 19:51, Junio C Hamano <> wrote:
> The "two" diffs may indeed be misleading.
> The patch only changes one source and the "supporting material" is
> not something that we need to use on the source file---it is only
> showing the change in the output.
> I did appreciate the inclusion of doc-diff myself, but it seems that
> it confused Chris and Patrick.  I doubt that it is an improvement to
> omit doc-diff.  We may want to find a way to make it easier for the
> readers to tell which part is the patch to be applied and which part
> is not in similar changes we discuss on the list in the future, and
> apparently, a one column indentation alone was not quite sufficient
> in this case.  Replacing "doc-diff:" label and patch header lines up
> to the hunk header with a prose to explain what the intended diff is
> may have helped, e.g.

Glad to know you found the included doc-diff useful. Thanks for the
suggestion on how to present it. Next time I'll try wrapping the
doc-diff in English prose to make it stand out more. The "doc-diff:" I
used now was definitely a bit too subtle.


  reply	other threads:[~2021-02-19  6:35 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-17 19:56 [PATCH 0/3] fix some doc rendering issues since v2.30.0 Martin Ågren
2021-02-17 19:56 ` [PATCH 1/3] rev-list-options.txt: fix rendering of bonus paragraph Martin Ågren
2021-02-17 19:56 ` [PATCH 2/3] git.txt: fix monospace rendering Martin Ågren
2021-02-17 22:47   ` Chris Torek
2021-02-18  6:28     ` Martin Ågren
2021-02-18  6:27   ` Patrick Steinhardt
2021-02-18  6:32     ` Martin Ågren
2021-02-18 18:51   ` Junio C Hamano
2021-02-19  6:33     ` Martin Ågren [this message]
2021-02-17 19:56 ` [PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses Martin Ågren
2021-02-18 10:48   ` Ævar Arnfjörð Bjarmason
2021-02-17 21:22 ` [PATCH 0/3] fix some doc rendering issues since v2.30.0 Junio C Hamano

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:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \ \

* 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

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