update README and #include in git.txt
PATCH 1/1 update README and #include in git.txt
Hi Petr
I sent this to Junio just as he was shutting down his tree. Can you take it into yours?
(This is the README from Linus' tree)
David
Makefile understands the includes git.txt #includes README README reformatted to asciidoc to allow inclusion in git.txt
---
commit 14d464865c5e204793c2244bdc4aba0ecd6d593d
tree e0e578bb02a7d8db1c105fddf5b5168ad0c79088
parent d81ed1b591b1db413c91e29b66de6a14dc543ffc
author David Greaves <[email protected]> Wed, 11 May 2005 16:20:23 +0100 committer David Greaves <[email protected]> Wed, 11 May 2005 16:20:23 +0100
Documentation/Makefile | 8 Documentation/git.txt | 19 - README | 728 +++++++++++++++++++++++++------------------------ 3 files changed, 390 insertions(+), 365 deletions(-)
Documentation/Makefile (mode:100644) +6 -2
@@ -8,8 +8,12 @@ man: $(DOC_MAN) -git-%: %.c $(LIB_FILE) - $(CC) $(CFLAGS) -o $@ $(filter %.c,$^) $(LIBS) +# 'include' dependencies +git.txt: ../README + touch git.txt + +git-diff-*.txt: diff-format.txt + touch $@ clean: rm -f *.xml *.html *.1
Documentation/git.txt (mode:100644) +9 -10
@@ -16,9 +16,10 @@ This is reference information for the core git commands. -The link:README[] contains much useful definition and clarification -info - read that first. And of the commands, I suggest reading -'git-update-cache' and 'git-read-tree' first - I wish I had! +The Discussion section below contains much useful definition and +clarification info - read that first. And of the commands, I suggest +reading link:git-update-cache.html[git-update-cache] and +link:git-read-tree.html[git-read-tree] first - I wish I had! David Greaves <[email protected]> 08/05/05
@@ -230,18 +231,12 @@ Terminology ----------- -Each line contains terms used interchangeably +Each line contains terms which you may see used interchangeably object database, .git directory directory cache, index id, sha1, sha1-id, sha1 hash type, tag - blob, blob object - tree, tree object - commit, commit object - parent - root object - changeset Environment Variables
@@ -295,6 +290,10 @@ link:git-diff-files.html[git-diff-files]; link:git-diff-tree.html[git-diff-tree] +Discussion +---------- +include::../README[] + Author ------ Written by Linus Torvalds <[email protected]>
README (mode:100644) +375 -353
797 lines not on this page · raw message
-
To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Dear diary, on Thu, May 12, 2005 at 11:31:05PM CEST, I got a letter where David Greaves <[email protected]> told me that...
Quoted 4 lines
Makefileunderstands the includes git.txt #includes README README reformatted to asciidoc to allow inclusion in git.txtSigned-off-by David Greaves <[email protected]>
Is it just me or this commit message is really weird? :-)
Quoted 10 lines
Index: README
===================================================================README (mode:100644) +2
-1@@ -1,9 +1,13 @@ +//////////////////////////////////////////////////////////////// + GIT - the stupid content tracker -
README (mode:100644) line 13
Quoted 10 lines
README (mode:100644) +4
-1- GIT - the stupid content tracker +Note that this README is written in asciidoc format and is #include'd +in the git.txt docs +The rest of this README is #included in the git.txt file +//////////////////////////////////////////////////////////////// "git" can mean anything, depending on your mood. - random three-letter combination that is pronounceable, and not
I'd probably prefer this being much less prominent. Can it be rather at the bottom of the file?
README (mode:100644) line 42
Quoted 6 lines
README (mode:100644) +3
-3-the object (i.e. how it is used, and how it can refer to other objects). -There are currently three different object types: "blob", "tree" and -"commit". +the object (ie how it is used, and how it can refer to other objects). +There are currently four different object types: "blob", "tree", +"commit" and "tag".
You're reintroducing the "typos" fixed before, apparently.
Quoted 12 lines
A "blob" object cannot refer to any other object, and is, like the tag implies, a pure storage object containing some user data. It is used to
README (mode:100644) +1
-1@@ -48,7 +50,7 @@ directory structure. In addition, a tree object can refer to other tree objects, thus creating a directory hierarchy. -Finally, a "commit" object ties such directory hierarchies together into +A "commit" object ties such directory hierarchies together into a DAG of revisions - each "commit" is associated with exactly one tree (the directory hierarchy at the time of the commit). In addition, a "commit" refers to one or more "parent" commit objects that describe the
README (mode:100644) line 70
Quoted 7 lines
README (mode:100644) +4
-0@@ -62,12 +64,17 @@ just going to confuse people. So aim for the notion of "one root object per project", even if git itself does not enforce that. +A "tag" object symbolically identifies and can be used to sign other +objects. It contains the identifier and type of another object, a +symbolic name (of course!) and, optionally, a signature. +
I think those changes should be either sent as a separate patch or noted as being done in the commit message.
README (mode:100644) line 278
Quoted 9 lines
README (mode:100644) +2
-3@@ -245,216 +274,209 @@ - The Workflow - - +The Workflow +------------
Cannot at least the newlines be preserved?
Signature · 3 lines
Petr "Pasky" Baudis Stuff: http://pasky.or.cz/ C++: an octopus made by nailing extra legs onto a dog. -- Steve Taylor
Quoted 4 lines · Petr Baudis
Dear diary, on Thu, May 12, 2005 at 11:31:05PM CEST, I got a letter where David Greaves <[email protected]> told me that...
Quoted 10 lines
Quoted 6 lines
Makefileunderstands the includes git.txt #includes README README reformatted to asciidoc to allow inclusion in git.txtSigned-off-by David Greaves <[email protected]>Is it just me or this commit message is really weird? :-)
I know, I saw it when I pushed send. Somehow a \n became a space... I blame vi. Should be:
Makefile understands the includes
git.txt #includes README
README reformatted to asciidoc to allow inclusion in git.txt
Quoted 21 lines
Quoted 21 lines
Index: README
===================================================================README (mode:100644) +6
-2@@ -1,9 +1,13 @@ +//////////////////////////////////////////////////////////////// + GIT - the stupid content tracker - - GIT - the stupid content tracker +Note that this README is written in asciidoc format and is #include'd +in the git.txt docs +The rest of this README is #included in the git.txt file +////////////////////////////////////////////////////////////////"git" can mean anything, depending on your mood.
Quoted 8 lines
Quoted 3 lines
- random three-letter combination that is pronounceable, and not
I'd probably prefer this being much less prominent. Can it be rather at the bottom of the file?
If you mean the header in the ///'s?
yes - but I wanted editors to realise it is asciidoc so kept it at the top. It could also be toned down by using fewer ////s - but that looked a bit odd.
(the /// /// lines act as comment block markers so asciidoc ignores the header
Or the "git can mean anything" speech?
That's how it was originally.
Quoted 14 lines
README (mode:100644) line 42
Quoted 10 lines
README (mode:100644) +3
-3-the object (i.e. how it is used, and how it can refer to other objects). -There are currently three different object types: "blob", "tree" and -"commit". +the object (ie how it is used, and how it can refer to other objects). +There are currently four different object types: "blob", "tree", +"commit" and "tag".You're reintroducing the "typos" fixed before, apparently.
I didn't notice the i.e. vs ie - I'm not that bothered ;)
Quoted 17 lines
Quoted 17 lines
A "blob" object cannot refer to any other object, and is, like the tag implies, a pure storage object containing some user data. It is used to
README (mode:100644) +0
-0@@ -48,7 +50,7 @@directory structure. In addition, a tree object can refer to other tree objects, thus creating a directory hierarchy.
README (mode:100644) +1
-1-Finally, a "commit" object ties such directory hierarchies together into +A "commit" object ties such directory hierarchies together intoa DAG of revisions - each "commit" is associated with exactly one tree (the directory hierarchy at the time of the commit). In addition, a "commit" refers to one or more "parent" commit objects that describe the
README (mode:100644) +0
-0@@ -62,12 +64,17 @@just going to confuse people. So aim for the notion of "one root object per project", even if git itself does not enforce that.
Quoted 11 lines
README (mode:100644) line 70
Quoted 6 lines
README (mode:100644) +4
-0+A "tag" object symbolically identifies and can be used to sign other +objects. It contains the identifier and type of another object, a +symbolic name (of course!) and, optionally, a signature. +I think those changes should be either sent as a separate patch or noted as being done in the commit message.
makes sense.
I'd rather note them in the message if that's OK
Quoted 6 lines
Quoted 6 lines
README (mode:100644) +0
-0@@ -245,216 +274,209 @@
Quoted 12 lines
README (mode:100644)
Quoted 7 lines
README (mode:100644) +2
-3- The Workflow - - +The Workflow +------------Cannot at least the newlines be preserved?
Yes - I must have been in an anti-whitespace mood.
Will see to this in the am...
David
Dear diary, on Sat, May 14, 2005 at 12:29:24AM CEST, I got a letter where David Greaves <[email protected]> told me that...
Quoted 27 lines
Quoted 19 lines
Quoted 19 lines
Index: README
===================================================================README (mode:100644) +6
-2@@ -1,9 +1,13 @@ +//////////////////////////////////////////////////////////////// + GIT - the stupid content tracker - - GIT - the stupid content tracker +Note that this README is written in asciidoc format and is #include'd +in the git.txt docs +The rest of this README is #included in the git.txt file +////////////////////////////////////////////////////////////////"git" can mean anything, depending on your mood.
Quoted 8 lines
Quoted 3 lines
- random three-letter combination that is pronounceable, and not
I'd probably prefer this being much less prominent. Can it be rather at the bottom of the file?
Quoted 2 lines
If you mean the header in the ///'s?
yes - but I wanted editors to realise it is asciidoc so kept it at the top.
But it's called README, not EDITME. And I think it's cluttering for the readers.
Quoted 4 lines
Quoted 3 lines
You're reintroducing the "typos" fixed before, apparently.
I didn't notice the i.e. vs ie - I'm not that bothered ;)
But there were other typo fixes there and the big reindenting won't show up any further changes to the text. I don't want to lose them so I'm concerned now.
Signature · 3 lines
Petr "Pasky" Baudis Stuff: http://pasky.or.cz/ C++: an octopus made by nailing extra legs onto a dog. -- Steve Taylor