diff options
author | J. Bruce Fields <bfields@citi.umich.edu> | 2007-01-07 22:58:14 -0500 |
---|---|---|
committer | J. Bruce Fields <bfields@citi.umich.edu> | 2007-01-07 22:58:14 -0500 |
commit | 6bd9b6822f7647cb3275cf151ca92c6d6e9423aa (patch) | |
tree | 3a0a2f8d479219e4a6aa4d807d40666a8bc94fe6 /Documentation/user-manual.txt | |
parent | d19fbc3c171aa71a79b2ff0b654e3064c91628b8 (diff) | |
download | git-6bd9b6822f7647cb3275cf151ca92c6d6e9423aa.tar.gz git-6bd9b6822f7647cb3275cf151ca92c6d6e9423aa.tar.xz |
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>
Diffstat (limited to 'Documentation/user-manual.txt')
-rw-r--r-- | Documentation/user-manual.txt | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 30ad103b1..18831476c 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -4,6 +4,15 @@ _________________ This manual is designed to be readable by someone with basic unix commandline skills, but no previous knowledge of git. +Chapters 1 and 2 explain how to fetch and study a project using git--the +tools you'd need to build and test a particular version of a software +project, to search for regressions, and so on. + +Chapter 3 explains how to do development with git and share your progress +with others. + +Further chapters cover more specialized topics. + Comprehensive reference documentation is available through the man pages. For a command such as "git clone", just use @@ -1430,8 +1439,24 @@ Glossary of git terms include::glossary.txt[] -Todo list for this manual -========================= +Notes and todo list for this manual +=================================== + +This is a work in progress. + +The basic requirements: + - It must be readable in order, from beginning to end, by someone + intelligent with a basic grasp of the unix commandline, but + without any special knowledge of git. If necessary, any other + prerequisites should be specifically mentioned as they arise. + - Whenever possible, section headings should clearly describe the + task they explain how to do, in language that requires no more + knowledge than necessary: for example, "importing patches into a + project" rather than "the git-am command" + +Think about how to create a clear chapter dependency graph that will allow +people to get to important topics without necessarily reading everything +in between. Scan Documentation/ for other stuff left out; in particular: howto's @@ -1454,7 +1479,7 @@ Can also simplify beginning by suggesting disconnected head instead of temporary branch creation. Explain how to refer to file stages in the "how to resolve a merge" -section: diff -1, -2, -3; :1:/path notation. +section: diff -1, -2, -3, --ours, --theirs :1:/path notation. Include cross-references to the glossary, where appropriate. |