git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Derrick Stolee <stolee@gmail.com>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH 3/4] git-commit-graph.txt: refer to "*commit* graph file"
Date: Thu, 20 Sep 2018 09:42:00 -0400	[thread overview]
Message-ID: <6b1cb43e-a1a8-921f-cd66-3697609854e0@gmail.com> (raw)
In-Reply-To: <CAN0heSo89WS69VXuPp02nQizordMWgNG0D0o-f-tm02Tp_gGEw@mail.gmail.com>

On 9/20/2018 9:38 AM, Martin Ågren wrote:
> On Thu, 20 Sep 2018 at 14:50, Derrick Stolee <stolee@gmail.com> wrote:
>> On 9/19/2018 12:30 PM, Martin Ågren wrote:
>>> The full name, by the way, is not the "commit-graph file" with a dash,
>>> cf. the synopsis. Use the dashless form. (The next commit will fix the
>>> remaining few instances of the "commit-graph file" in this document.)
>> The file is literally at ".git/objects/info/commit-graph" which is why I
>> tried to use "commit-graph" everywhere. Why do you think that "commit
>> graph" is better?
> I noticed the discrepancy between "commit graph file" and "commit-graph
> file" and briefly wondered if it was intentional, i.e., if it meant
> anything, but the dash vs no dash seemed pretty random to me. In order
> to figure out which was (more) correct, I went to the synopsis. But
> admittedly, that was quite arbitrary. For all I know, "the commit-graph
> file" could be the better choice, grammatically.

Yeah, the fact that I was inconsistent forced you to make a choice. 
Sorry for that.

> There is the file named "commit-graph" as you note, but it might on the
> other hand just as well be called "cg.bin". I would probably try to let
> the filename "commit-graph" influence the user manual only if we would
> have written "cg.bin" instead. For example, if we would talk about how
> you might get out of a hole by deleting the "<...>/commit-graph"
> ("cg.bin") file manually.
>
> But that's certainly not to argue against "the commit-graph file". I'd
> be happy to s/commit graph file/commit-graph file/g instead to keep
> others from wondering if these are two slightly different things. And
> if the concept and the file have the same name, all the better.
>
> If you agree, I'll do that in a v2, where I will also note in the
> Options section that `--object-dir` takes a `<dir>`.
I think "commit-graph" is better. Thanks for also catching the `...` 
formatting.

Thanks!
-Stolee

  reply	other threads:[~2018-09-20 13:42 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-19 16:30 [PATCH 0/4] git-commit-graph.txt: various cleanups Martin Ågren
2018-09-19 16:30 ` [PATCH 1/4] git-commit-graph.txt: fix bullet lists Martin Ågren
2018-09-19 23:28   ` Derrick Stolee
2018-09-19 16:30 ` [PATCH 2/4] git-commit-graph.txt: typeset more in monospace Martin Ågren
2018-09-19 23:29   ` Derrick Stolee
2018-09-19 16:30 ` [PATCH 3/4] git-commit-graph.txt: refer to "*commit* graph file" Martin Ågren
2018-09-19 23:32   ` Derrick Stolee
2018-09-20 13:38     ` Martin Ågren
2018-09-20 13:42       ` Derrick Stolee [this message]
2018-09-27 19:12         ` [PATCH v2 0/4] git-commit-graph.txt: various cleanups Martin Ågren
2018-09-27 19:12           ` [PATCH v2 1/4] git-commit-graph.txt: fix bullet lists Martin Ågren
2018-09-27 19:12           ` [PATCH v2 2/4] git-commit-graph.txt: typeset more in monospace Martin Ågren
2018-09-27 19:12           ` [PATCH v2 3/4] git-commit-graph.txt: refer to "*commit*-graph file" Martin Ågren
2018-09-27 19:12           ` [PATCH v2 4/4] Doc: refer to the "commit-graph file" with dash Martin Ågren
2018-09-27 19:16           ` [PATCH v2 0/4] git-commit-graph.txt: various cleanups Derrick Stolee
2018-09-27 19:21             ` Martin Ågren
2018-09-19 16:30 ` [PATCH 4/4] git-commit-graph.txt: refer to the "commit graph file" without dash Martin Ågren

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=6b1cb43e-a1a8-921f-cd66-3697609854e0@gmail.com \
    --to=stolee@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=martin.agren@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;
as well as URLs for NNTP newsgroup(s).