@matheusbsbs / matheus-bagliano / commits / 971aa71fc6
Fork 0

user-manual: adjust section levels in "git internals"

The descriptions of the various object types should all be a subsection of the "Object Database" section. I cribbed most of this chapter from the README (now core-intro.txt and git(7)), because there's stuff in there people need to know and I was too lazy to rewrite it. The audience isn't quite right, though--the chapter is a mixture of user- and developer- level documentation that isn't as appropriate now as it was originally. So, reserve this chapter for stuff users need to know, and move the source code introduction into a new "git hacking" chapter where we'll also move any hacker-only technical details. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>

J. Bruce Fields committed Aug 30, 2007 at 22:49 UTC 971aa71fc695e0b56ffe2172543a126d20b16842
1 file changed +12 -5
Documentation/user-manual.txt
+12 -5
@@ -2787,7 +2787,7 @@ The object types in some more detail:
2787
2788 [[blob-object]]
2789 Blob Object
2790 ------------
2790 +~~~~~~~~~~~
2791
2792 A "blob" object is nothing but a binary blob of data, and doesn't
2793 refer to anything else. There is no signature or any other
@@ -2809,7 +2809,7 @@ is run, and its data can be accessed by gitlink:git-cat-file[1].
2809
2810 [[tree-object]]
2811 Tree Object
2812 ------------
2812 +~~~~~~~~~~~
2813
2814 The next hierarchical object type is the "tree" object. A tree object
2815 is a list of mode/name/blob data, sorted by name. Alternatively, the
@@ -2851,7 +2851,7 @@ Two trees can be compared with gitlink:git-diff-tree[1].
2851
2852 [[commit-object]]
2853 Commit Object
2854 --------------
2854 +~~~~~~~~~~~~~
2855
2856 The "commit" object is an object that introduces the notion of
2857 history into the picture. In contrast to the other objects, it
@@ -2878,7 +2878,7 @@ its data can be accessed by gitlink:git-cat-file[1].
2878
2879 [[trust]]
2880 Trust
2881 ------
2881 +~~~~~
2882
2883 An aside on the notion of "trust". Trust is really outside the scope
2884 of "git", but it's worth noting a few things. First off, since
@@ -2908,7 +2908,7 @@ To assist in this, git also provides the tag object...
2908
2909 [[tag-object]]
2910 Tag Object
2911 -----------
2911 +~~~~~~~~~~
2912
2913 Git provides the "tag" object to simplify creating, managing and
2914 exchanging symbolic and signed tokens. The "tag" object at its
@@ -3474,6 +3474,13 @@ confusing and scary messages, but it won't actually do anything bad. In
3474 contrast, running "git prune" while somebody is actively changing the
3475 repository is a *BAD* idea).
3476
3477 +[[hacking-git]]
3478 +Hacking git
3479 +===========
3480 +
3481 +This chapter covers internal details of the git implementation which
3482 +probably only git developers need to understand.
3483 +
3484 [[birdview-on-the-source-code]]
3485 A birds-eye view of Git's source code
3486 -------------------------------------