user-manual: todo updates and cleanup
Format a couple lists. Reminder that we may want to add submodule documentation some day.
J. Bruce Fields committed
Sep 2, 2007 at 23:28 UTC
ecd95b536e37e0a816d8c9832e04f61c3f1d4423
1 file changed
+16
-13
Documentation/user-manual.txt
+16
-13
@@ -4023,25 +4023,26 @@ Appendix B: Notes and todo list for this manual
4023
This is a work in progress.
4024
4025
The basic requirements:
4026
- - It must be readable in order, from beginning to end, by
4027
- someone intelligent with a basic grasp of the UNIX
4028
- command line, but without any special knowledge of git. If
4029
- necessary, any other prerequisites should be specifically
4030
- mentioned as they arise.
4031
- - Whenever possible, section headings should clearly describe
4032
- the task they explain how to do, in language that requires
4033
- no more knowledge than necessary: for example, "importing
4034
- patches into a project" rather than "the git-am command"
4026
+
4027
+- It must be readable in order, from beginning to end, by someone
4028
+ intelligent with a basic grasp of the UNIX command line, but without
4029
+ any special knowledge of git. If necessary, any other prerequisites
4030
+ should be specifically mentioned as they arise.
4031
+- Whenever possible, section headings should clearly describe the task
4032
+ they explain how to do, in language that requires no more knowledge
4033
+ than necessary: for example, "importing patches into a project" rather
4034
+ than "the git-am command"
4035
4036
Think about how to create a clear chapter dependency graph that will
4037
allow people to get to important topics without necessarily reading
4038
everything in between.
4039
4040
Scan Documentation/ for other stuff left out; in particular:
4041
- howto's
4042
- some of technical/?
4043
- hooks
4044
- list of commands in gitlink:git[1]
4041
+
4042
+- howto's
4043
+- some of technical/?
4044
+- hooks
4045
+- list of commands in gitlink:git[1]
4046
4047
Scan email archives for other stuff left out
4048
@@ -4070,3 +4071,5 @@ Write a chapter on using plumbing and writing scripts.
4071
Alternates, clone -reference, etc.
4072
4073
git unpack-objects -r for recovery
4074
+
4075
+submodules