@matheusbsbs / matheus-bagliano / commits / 6bd9b6822f
Fork 0

Documentation: expand preface and todo's

Add a brief description of the organization to the preface, expand the final notes/todo's section, in hopes maybe some others will want to contribute. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>

J. Bruce Fields committed Jan 7, 2007 at 22:58 UTC 6bd9b6822f7647cb3275cf151ca92c6d6e9423aa
1 file changed +28 -3
Documentation/user-manual.txt
+28 -3
@@ -4,6 +4,15 @@ _________________
4 This manual is designed to be readable by someone with basic unix
5 commandline skills, but no previous knowledge of git.
6
7 +Chapters 1 and 2 explain how to fetch and study a project using git--the
8 +tools you'd need to build and test a particular version of a software
9 +project, to search for regressions, and so on.
10 +
11 +Chapter 3 explains how to do development with git and share your progress
12 +with others.
13 +
14 +Further chapters cover more specialized topics.
15 +
16 Comprehensive reference documentation is available through the man
17 pages. For a command such as "git clone", just use
18
@@ -1430,8 +1439,24 @@ Glossary of git terms
1439
1440 include::glossary.txt[]
1441
1433 -Todo list for this manual
1434 -=========================
1442 +Notes and todo list for this manual
1443 +===================================
1444 +
1445 +This is a work in progress.
1446 +
1447 +The basic requirements:
1448 + - It must be readable in order, from beginning to end, by someone
1449 + intelligent with a basic grasp of the unix commandline, but
1450 + without any special knowledge of git. If necessary, any other
1451 + prerequisites should be specifically mentioned as they arise.
1452 + - Whenever possible, section headings should clearly describe the
1453 + task they explain how to do, in language that requires no more
1454 + knowledge than necessary: for example, "importing patches into a
1455 + project" rather than "the git-am command"
1456 +
1457 +Think about how to create a clear chapter dependency graph that will allow
1458 +people to get to important topics without necessarily reading everything
1459 +in between.
1460
1461 Scan Documentation/ for other stuff left out; in particular:
1462 howto's
@@ -1454,7 +1479,7 @@ Can also simplify beginning by suggesting disconnected head instead
1479 of temporary branch creation.
1480
1481 Explain how to refer to file stages in the "how to resolve a merge"
1457 -section: diff -1, -2, -3; :1:/path notation.
1482 +section: diff -1, -2, -3, --ours, --theirs :1:/path notation.
1483
1484 Include cross-references to the glossary, where appropriate.
1485