All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: Derrick Stolee <stolee@gmail.com>
Subject: [PATCH 3/4] git-commit-graph.txt: refer to "*commit* graph file"
Date: Wed, 19 Sep 2018 18:30:34 +0200	[thread overview]
Message-ID: <65f42c947aa2b392075740673a5dc889fd6e64e6.1537374062.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1537374062.git.martin.agren@gmail.com>

This document sometimes refers to the "commit graph file" as just "the
graph file". This saves a couple of words here and there at the risk of
confusion. In particular, the documentation for `git commit-graph read`
appears to suggest that there are indeed different types of graph files.

Let's just write out the full name everywhere.

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

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git-commit-graph.txt | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt
index 6ac610f016..55f63d47d9 100644
--- a/Documentation/git-commit-graph.txt
+++ b/Documentation/git-commit-graph.txt
@@ -54,8 +54,8 @@ existing commit-graph file.
 
 'read'::
 
-Read a graph file given by the commit-graph file and output basic
-details about the graph file. Used for debugging purposes.
+Read the commit graph file and output basic details about it.
+Used for debugging purposes.
 
 'verify'::
 
@@ -73,21 +73,21 @@ EXAMPLES
 $ git commit-graph write
 ------------------------------------------------
 
-* Write a graph file, extending the current graph file using commits
-  in `<pack-index>`.
+* Write a commit graph file, extending the current commit graph file
+  using commits in `<pack-index>`.
 +
 ------------------------------------------------
 $ echo <pack-index> | git commit-graph write --stdin-packs
 ------------------------------------------------
 
-* Write a graph file containing all reachable commits.
+* Write a commit graph file containing all reachable commits.
 +
 ------------------------------------------------
 $ git show-ref -s | git commit-graph write --stdin-commits
 ------------------------------------------------
 
-* Write a graph file containing all commits in the current
-  commit-graph file along with those reachable from `HEAD`.
+* Write a commit graph file containing all commits in the current
+  commit graph file along with those reachable from `HEAD`.
 +
 ------------------------------------------------
 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
-- 
2.19.0.216.g2d3b1c576c


  parent reply	other threads:[~2018-09-19 16:30 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 ` Martin Ågren [this message]
2018-09-19 23:32   ` [PATCH 3/4] git-commit-graph.txt: refer to "*commit* graph file" Derrick Stolee
2018-09-20 13:38     ` Martin Ågren
2018-09-20 13:42       ` Derrick Stolee
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=65f42c947aa2b392075740673a5dc889fd6e64e6.1537374062.git.martin.agren@gmail.com \
    --to=martin.agren@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=stolee@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.