From: Derrick Stolee <derrickstolee@github.com>
To: Philip Oakley <philipoakley@iee.email>, GitList <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>,
Derrick Stolee <stolee@gmail.com>,
Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
Subject: Re: [PATCH v2 2/3] glossary: add "commit graph" description
Date: Tue, 25 Oct 2022 08:31:58 -0400 [thread overview]
Message-ID: <3a7f43bd-2c48-6a37-7602-f4c938f7f58e@github.com> (raw)
In-Reply-To: <20221022222539.2333-3-philipoakley@iee.email>
On 10/22/2022 6:25 PM, Philip Oakley wrote:
> Git has an additional "commit graph" capability that supplements the
> normal commit object's directed acylic graph (DAG). The supplemental
> commit graph file is designed for speed of access.
>
> Describe the commit graph both from the normative DAG view point and
> from the commit graph file perspective.
One way to help keep the general term and the file separate is to use
different notation. "commit graph" (with a space, no formatting) is the
DAG. "`commit-graph`" (with a dash, code formatting) is the file (and
its format).
> +[[def_commit_graph_general]]commit graph concept, representations and usage::
> + A synonym for the <<def_DAG,DAG>> structure formed by
> + the commits in the object database, <<def_ref,referenced>> by branch tips,
> + using their <<def_chain,chain>> of linked commits.
> + This structure is the definitive commit graph. The
> + graph can be represented in other ways, e.g. the
> + <<def_commit_graph_file,commit graph file>>.
> +
> +[[def_commit_graph_file]]commit graph file::
> + The commit-graph file is a supplemental representation of
> + the <<def_commit_graph_general,commit graph>> which accelerates
> + commit graph walks. The "commit-graph" file is stored
> + either in the .git/objects/info directory or in the info directory
> + of an alternate object database.
> +
So this would become:
[[def_commit_graph_file]]`commit-graph` file::
The `commit-graph` file is a supplemental representation of
the <<def_commit_graph_general,commit graph>> which accelerates
commit graph walks. The `commit-graph` file is stored either in
the `.git/objects/info` directory or in the `info` directory of
an alternate object database.
(I did some extra style and word-wrapping changes, too.)
Other than these nits, I find this to be a clear description.
Thanks,
-Stolee
next prev parent reply other threads:[~2022-10-25 12:32 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-09 16:56 [PATCH 0/4] Add some Glossary terms, and extra renormalize information Philip Oakley via GitGitGadget
2022-07-09 16:56 ` [PATCH 1/4] glossary: add Object DataBase (ODB) abbreviation Philip Oakley via GitGitGadget
2022-07-09 16:56 ` [PATCH 2/4] glossary: add commit graph description Philip Oakley via GitGitGadget
2022-07-09 21:20 ` Junio C Hamano
2022-07-10 21:37 ` Philip Oakley
2022-08-30 14:33 ` Philip Oakley
2022-07-09 16:56 ` [PATCH 3/4] glossary: add reachability bitmap description Philip Oakley via GitGitGadget
2022-07-09 16:56 ` [PATCH 4/4] doc add: renormalize is not idempotent for CRCRLF Philip Oakley via GitGitGadget
2022-07-09 21:06 ` Junio C Hamano
2022-07-10 21:52 ` Philip Oakley
2022-07-10 22:04 ` Junio C Hamano
2022-07-10 22:25 ` Philip Oakley
2022-07-10 7:48 ` Torsten Bögershausen
2022-07-10 22:09 ` Philip Oakley
2022-08-05 22:26 ` Junio C Hamano
2022-08-06 19:22 ` Torsten Bögershausen
2022-08-08 14:32 ` Philip Oakley
2022-08-08 16:21 ` Junio C Hamano
2022-08-09 18:44 ` Torsten Bögershausen
2022-08-10 14:44 ` [PATCH v2 0/1] .. Add extra renormalize information Philip Oakley
2022-08-10 14:44 ` [PATCH v2 1/1] doc add: renormalize is not idempotent for CRCRLF Philip Oakley
2022-08-10 17:11 ` Torsten Bögershausen
2022-08-10 17:42 ` Junio C Hamano
2022-07-09 21:34 ` [PATCH 0/4] Add some Glossary terms, and extra renormalize information Junio C Hamano
2022-07-10 15:20 ` Philip Oakley
2022-10-22 22:25 ` [PATCH v2 0/3] Add some Glossary of terms information Philip Oakley
2022-10-22 22:25 ` [PATCH v2 1/3] doc: use 'object database' not ODB or abbreviation Philip Oakley
2022-10-22 22:25 ` [PATCH v2 2/3] glossary: add "commit graph" description Philip Oakley
2022-10-25 12:31 ` Derrick Stolee [this message]
2022-10-29 16:32 ` Philip Oakley
2022-10-22 22:25 ` [PATCH v2 3/3] glossary: add reachability bitmap description Philip Oakley
2022-10-24 7:43 ` Abhradeep Chakraborty
2022-10-24 16:39 ` Junio C Hamano
2022-10-24 21:23 ` Philip Oakley
2022-10-25 12:34 ` Derrick Stolee
2022-10-25 15:53 ` Junio C Hamano
2022-10-29 16:36 ` Philip Oakley
2022-10-23 1:49 ` [PATCH v2 0/3] Add some Glossary of terms information Junio C Hamano
2022-10-29 16:41 ` [PATCH v3 0/4] " Philip Oakley
2022-10-29 16:41 ` [PATCH v3 1/4] doc: use 'object database' not ODB or abbreviation Philip Oakley
2022-10-29 16:41 ` [PATCH v3 2/4] glossary: add "commit graph" description Philip Oakley
2022-10-29 16:41 ` [PATCH v3 3/4] glossary: add reachability bitmap description Philip Oakley
2022-10-29 16:41 ` [PATCH v3 4/4] doc: use "commit-graph" hyphenation consistently Philip Oakley
2022-10-29 17:24 ` [PATCH v3 0/4] Add some Glossary of terms information Taylor Blau
2022-10-29 17:34 ` Philip Oakley
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=3a7f43bd-2c48-6a37-7602-f4c938f7f58e@github.com \
--to=derrickstolee@github.com \
--cc=chakrabortyabhradeep79@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=philipoakley@iee.email \
--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 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).