Skip to content

Commit ecd95b5

Browse files
author
J. Bruce Fields
committed
user-manual: todo updates and cleanup
Format a couple lists. Reminder that we may want to add submodule documentation some day.
1 parent 9644ffd commit ecd95b5

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

Documentation/user-manual.txt

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4023,25 +4023,26 @@ Appendix B: Notes and todo list for this manual
40234023
This is a work in progress.
40244024

40254025
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"
40354035

40364036
Think about how to create a clear chapter dependency graph that will
40374037
allow people to get to important topics without necessarily reading
40384038
everything in between.
40394039

40404040
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]
40454046

40464047
Scan email archives for other stuff left out
40474048

@@ -4070,3 +4071,5 @@ Write a chapter on using plumbing and writing scripts.
40704071
Alternates, clone -reference, etc.
40714072

40724073
git unpack-objects -r for recovery
4074+
4075+
submodules

0 commit comments

Comments
 (0)