[PATCH v2 2/4] doc: git: link to the gitdatamodel(7) tutorial

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]




From: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx>
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 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
 mentioned there.
We don’t need to mention it under Further Documentation since we now
mention it under Description.
† 1: See dee80940 (doc: add an explanation of Git's data model,
 2025年11月12日):
 `gitglossary`. This makes a good effort, but it's an
 alphabetically ordered dictionary and a dictionary is not a
 good way to learn concepts. You have to jump around too much
 and it's not possible to present the concepts in the order
 that they should be explained.
Signed-off-by: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx>
---
Notes (series):
 v2:
 • Msg: Correct section: s/gitdatamodel(1)/gitdatamodel(7)/[1]
 • Msg: Missing “is”[1]
 • Msg: Correct “on another page” which refers to git(1)—the same
 page that we are changing.[2] This is a mistake from my own
 iterations since this started as the first commit and I had to
 reword from: not mentioned yet; mentioned with `git help
 --guides`; (realizes that it is also automatically included in
 Guides now) ...
 • Msg: s/other places/other sections/[2]
 🔗 1: https://lore.kernel.org/git/aohDFdjPU0t2d9_8@xxxxxx/
 † 2: Self review
 ---
 v1:
 I have used double spacing for sentences since that seemed to what was
 already in use.
 Documentation/git.adoc | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/git.adoc b/Documentation/git.adoc
index 8a5cdd3b3d2..6f0075f9188 100644
--- a/Documentation/git.adoc
+++ b/Documentation/git.adoc
@@ -25,7 +25,8 @@ and full access to internals.
 See linkgit:gittutorial[7] to get started, then see
 linkgit:giteveryday[7] for a useful minimum set of
 commands. The link:user-manual.html[Git User's Manual] has a more
-in-depth introduction.
+in-depth introduction. See linkgit:gitdatamodel[7] if you want to
+learn about the data model and important terminology.
 
 After you mastered the basic concepts, you can come back to this
 page to learn what commands Git offers. You can learn more about
@@ -469,7 +470,9 @@ Higher level SCMs may provide and manage additional information in the
 
 Terminology
 -----------
-Please see linkgit:gitglossary[7].
+Please see linkgit:gitglossary[7]. See linkgit:gitdatamodel[7] for a
+discussion of the core data model, which includes important terminology
+used throughout the documentation.
 
 
 Environment Variables
@@ -1199,8 +1202,9 @@ SEE ALSO
 --------
 linkgit:gittutorial[7], linkgit:gittutorial-2[7],
 linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
-linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
-linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
+linkgit:gitglossary[7], linkgit:gitdatamodel[7],
+linkgit:gitcore-tutorial[7], linkgit:gitcli[7],
+link:user-manual.html[The Git User's Manual],
 linkgit:gitworkflows[7]
 
 GIT
-- 
2.55.0.13.g85d2d65e389

[Index of Archives] [Linux Kernel Development] [Gcc Help] [IETF Annouce] [DCCP] [Netdev] [Networking] [Security] [V4L] [Bugtraq] [Yosemite] [MIPS Linux] [ARM Linux] [Linux Security] [Linux RAID] [Linux SCSI] [Fedora Users]

(追記) (追記ここまで)
Powered by Linux

AltStyle によって変換されたページ (->オリジナル) /