public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: Jeff King <peff@peff•net>
Cc: git@vger•kernel.org, Patrick Steinhardt <ps@pks•im>
Subject: Re: [PATCH 1/3] git-verify-pack.txt: fix inconsistent spelling of "packfile"
Date: Wed, 20 May 2015 15:37:23 -0700	[thread overview]
Message-ID: <xmqqzj4ylvto.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <20150520194906.GA8421@peff.net> (Jeff King's message of "Wed, 20 May 2015 15:49:07 -0400")

Jeff King <peff@peff•net> writes:

> On Wed, May 20, 2015 at 12:45:09PM -0700, Junio C Hamano wrote:
>
>> One related thing is that there are few mentions of "idx file" to
>> refer to "pack index" (e.g. show-index and verify-pack documentation
>> pages); I think this was an attempt to disambiguate "pack index"
>> from "the Index", but as long as we spell it "pack index", I think
>> it should be OK, so while we are at it we may want to fix them.  We
>> can leave "pack .idx file" as-is, but rewriting it to "pack index
>> file" or just "pack index" may be OK as long as it is clear from the
>> context.
>> 
>> "git show-index" has this in SYNOPSIS:
>> 
>> 	'git show-index' < idx-file
>> 
>> It probably should become
>> 
>> 	'git show-index' < <pack-index>
>
> That makes "pack-file" make more sense to me. It is not "the abstract
> concept of a packfile", but "the file with the .pack extension" (just as
> "idx-file" is "the file with the .idx extension"). They are the same
> thing if you think about it, of course, but you might choose one over
> the other depending on the context.

Hmm, that is also true.

In any case, even though I merged these three to 'next', I think we
need to either revert 3/3 or do s/pack-file/packfile/ throughout the
pack-protocol documentation.  The original has something like this:

    The pack-file MUST NOT be sent if the only command used is 'delete'.

    A pack-file MUST be sent if either create or update command is used,
    even if the server already has all the necessary objects.  In this
    case the client MUST send an empty pack-file.   The only time this
    is likely to happen is if the client is creating
    a new branch or a tag that points to an existing obj-id.

and these are explicitly referring to what EBNF defines as "pack-file".
Changing them to "packfile" is simply wrong.

  reply	other threads:[~2015-05-20 22:37 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-17  6:56 [PATCH 1/3] git-verify-pack.txt: fix inconsistent spelling of "packfile" Patrick Steinhardt
2015-05-17  6:56 ` [PATCH 2/3] git-unpack-objects.txt: " Patrick Steinhardt
2015-05-17  6:56 ` [PATCH 3/3] pack-protocol.txt: fix insconsistent " Patrick Steinhardt
2015-05-19 19:34 ` [PATCH 1/3] git-verify-pack.txt: fix inconsistent " Junio C Hamano
2015-05-19 22:24   ` Jeff King
2015-05-20 19:22     ` Junio C Hamano
2015-05-20 19:45       ` Junio C Hamano
2015-05-20 19:49         ` Jeff King
2015-05-20 22:37           ` Junio C Hamano [this message]
2015-05-21  2:04             ` Jeff King
2015-05-21  4:54               ` Junio C Hamano
2015-05-21  7:27                 ` [PATCH] doc: " Patrick Steinhardt
2015-05-21 16:37                   ` Junio C Hamano
2015-05-22  6:10                     ` Patrick Steinhardt
2015-05-22  6:22                   ` [PATCH v2] " Patrick Steinhardt
2015-05-22 16:00                     ` Junio C Hamano
2015-05-20  5:13   ` [PATCH 1/3] git-verify-pack.txt: " Patrick Steinhardt

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=xmqqzj4ylvto.fsf@gitster.dls.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=peff@peff$(echo .)net \
    --cc=ps@pks$(echo .)im \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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