[PATCH v2 0/4] doc: advertize gitdatamodel(1)

[email protected]
Newsgroups org.kernel.vger.git
Message-ID <[email protected]>
From: Kristoffer Haugsbakk <[email protected]>

Topic name (applied): kh/doc-datamodel

Topic summary: gitdatamodel(7) is not linked to from anywhere. Let’s
mention it on other documentation pages and add a link to the glossary on
the data model page.

§ Testing

Testing done on v1. No tests done for v2.

§ Changes in v2

Thanks to Patrick for reviewing the first round.

Correct commit messages for:

• Patch 1/4, “list gitdatamodel(7) as a concept guide”
• Patch 2/4, “link to the gitdatamodel(7) tutorial”

§ Link to v1

https://lore.kernel.org/git/[email protected]/

§ Aside about context lines in gitlossary(7)

Nothing to do with this topic, but I noticed this “..” in gitglossary(7):

| Different subhierarchies are used for different purposes. For example,
| the `refs/heads/` hierarchy is used to represent local branches whereas
| the `refs/tags/` hierarchy is used to represent local tags..

From 74b50a58 (Documentation/glossary: define root refs as refs,
2024-05-15) by Patrick. Is that intentional, like an ellipsis? In other
words listing heads, then tags, then using ellipsis to communicate “you
see the pattern here”.

[1/4] doc: git: list gitdatamodel(7) as a concept guide
[2/4] doc: git: link to the gitdatamodel(7) tutorial
[3/4] doc: glossary: link four of the terms to gitdatamodel(7)
[4/4] doc: datamodel: link to the glossary

 Documentation/git.adoc              | 12 ++++++++----
 Documentation/gitdatamodel.adoc     |  6 ++++++
 Documentation/gitglossary.adoc      |  1 +
 Documentation/glossary-content.adoc | 13 ++++++++++---
 command-list.txt                    |  1 +
 5 files changed, 26 insertions(+), 7 deletions(-)

Interdiff against v1:
Range-diff against v1:
1:  7fbff6b7d1f ! 1:  35832098717 doc: git: list gitdatamodel(7) as a concept guide
    @@ Commit message
     
         dee80940 (doc: add an explanation of Git's data model, 2025-11-12) added
         gitdatamodel(7), documenting Git’s data model. But it is not mentioned
    -    everywhere.
    +    anywhere.
     
         Let’s start by listing it under Guides in git(1) and with `git help
         --guides`.
2:  916e9f7d46f ! 2:  3d8c4334785 doc: git: link to the gitdatamodel(7) tutorial
    @@ Metadata
      ## Commit message ##
         doc: git: link to the gitdatamodel(7) tutorial
     
    -    The previous commit added the first mention of gitdatamodel(1) on
    -    another page, namely in git(1). But there are also other places where
    -    a mention is relevant.
    +    The previous commit added the first mention of gitdatamodel(7) here,
    +    under Guides. But there are also other sections where a mention is
    +    relevant.
     
         Let’s mention it:
     
    -    • under Description, since it as useful as the other tutorials already
    -      mentioned there for those who are interested;
    +    • under Description, since it is as useful as the other tutorials
    +      already mentioned there for those who are interested;
         • under Terminology, since it complements gitglossary(7) as a
           pedagogical rather than reference source for the core terms;[1] and
         • under See Also, since the other tutorials (plus the user manual) are
3:  5c83788e417 = 3:  04802040a8d doc: glossary: link four of the terms to gitdatamodel(7)
4:  f8fb18b5f98 = 4:  5e8911beb4e doc: datamodel: link to the glossary

base-commit: e9019fcafe0040228b8631c30f97ae1adb61bcdc
-- 
2.55.0.13.g85d2d65e389
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.