Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Noman <necrospre@gmail.com>
Cc: git@vger.kernel.org,  karthik nayak <karthik.188@gmail.com>,
	jltobler@gmail.com
Subject: Re: [GSoC][PATCH] doc: fix doubled words in gitdiffcore documentation
Date: Sat, 28 Mar 2026 10:29:39 -0700	[thread overview]
Message-ID: <87bjg7g8vw.fsf@gitster.g> (raw)
In-Reply-To: <CA+TqWtWiYR+aEsQPOsOwOonc2hinjfXW0oy5mLuDOPx4Xu9mwA@mail.gmail.com> (Noman's message of "Sat, 28 Mar 2026 11:11:29 +0530")

Noman <necrospre@gmail.com> writes:

> diff --git a/Documentation/gitdiffcore.adoc b/Documentation/gitdiffcore.adoc
> index 642c51227b..2b3fd5a259 100644
> --- a/Documentation/gitdiffcore.adoc
> +++ b/Documentation/gitdiffcore.adoc
> @@ -133,7 +133,7 @@ input contained these filepairs:
>  :000000 100644 0000000... 0123456... A file0
>  ------------------------------------------------
>
> -and the contents of the deleted file fileX is similar enough to
> +and the contents of the deleted file X is similar enough to
>  the contents of the created file file0, then rename detection
>  merges these filepairs and creates:

Please pay attention to the line just before the pre-context of the
above hunk, which says

    :100644 000000 0123456... 0000000... D fileX

and "the deleted file fileX" is a reference to it.

It indeed results in an awkward-sounding sentence, and I agree that
it would have been better if we used sample filenames that sounded
distinctly different from "file" 20 years ago when we wrote the
first edition of this document, but that water under the bridge has
poured out to the ocean long ago ;-)

In principle, I would not mind an update that consistently moves us
away from file0, file1, ... to something else both in examples and
explanations, but the cost of doing such a change and the cost of
reviewing such a change to make sure no unintended mistakes sneak
in, feels rather high, relative to the benefit.  So, I dunno.

> @@ -145,7 +145,7 @@ When the "-C" option is used, the original
> contents of modified files,
>  and deleted files (and also unmodified files, if the
>  "--find-copies-harder" option is used) are considered as candidates
>  of the source files in rename/copy operation.  If the input were like
> -these filepairs, that talk about a modified file fileY and a newly
> +these filepairs, that talk about a modified file Y and a newly
>  created file file0:
>
>  ------------------------------------------------
> --
> 2.45.1.windows.1

  reply	other threads:[~2026-03-28 17:29 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-28  5:41 [GSoC][PATCH] doc: fix doubled words in gitdiffcore documentation Noman
2026-03-28 17:29 ` Junio C Hamano [this message]
  -- strict thread matches above, loose matches on Subject: below --
2026-03-28  6:23 Siddharth Shrimali

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=87bjg7g8vw.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jltobler@gmail.com \
    --cc=karthik.188@gmail.com \
    --cc=necrospre@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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox