[PATCH 3/4] git-commit-graph.txt: refer to "*commit* graph file"
- From
- Martin Ågren <martin.agren@gmail.com>
- Date
- Sep 19, 2018, 16:30 UTC
- Message-ID
- <65f42c947aa2b392075740673a5dc889fd6e64e6.1537374062.git.martin.agren@gmail.com>
- 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