user-manual: rewrap, fix heading levels
Fix some heading levels that prevented compile; rewrap some stuff. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
J. Bruce Fields committed
Jan 14, 2007 at 22:43 UTC
2f99710cfe2aacce077c510f93b51edd9ba16a0d
1 file changed
+23
-17
Documentation/user-manual.txt
+23
-17
@@ -770,7 +770,7 @@ Examples
770
--------
771
772
Check whether two branches point at the same history
773
-----------------------------------------------------
773
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
774
775
Suppose you want to check whether two branches point at the same point
776
in history.
@@ -802,7 +802,7 @@ $ git log origin...master
802
will return no commits when the two branches are equal.
803
804
Check which tagged version a given fix was first included in
805
-------------------------------------------------------------
805
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
806
807
Suppose you know that the commit e05db0fd fixed a certain problem.
808
You'd like to find the earliest tagged release that contains that
@@ -1723,14 +1723,15 @@ Notes and todo list for this manual
1723
This is a work in progress.
1724
1725
The basic requirements:
1726
- - It must be readable in order, from beginning to end, by someone
1727
- intelligent with a basic grasp of the unix commandline, but
1728
- without any special knowledge of git. If necessary, any other
1729
- prerequisites should be specifically mentioned as they arise.
1730
- - Whenever possible, section headings should clearly describe the
1731
- task they explain how to do, in language that requires no more
1732
- knowledge than necessary: for example, "importing patches into a
1733
- project" rather than "the git-am command"
1726
+ - It must be readable in order, from beginning to end, by
1727
+ someone intelligent with a basic grasp of the unix
1728
+ commandline, but without any special knowledge of git. If
1729
+ necessary, any other prerequisites should be specifically
1730
+ mentioned as they arise.
1731
+ - Whenever possible, section headings should clearly describe
1732
+ the task they explain how to do, in language that requires
1733
+ no more knowledge than necessary: for example, "importing
1734
+ patches into a project" rather than "the git-am command"
1735
1736
Think about how to create a clear chapter dependency graph that will
1737
allow people to get to important topics without necessarily reading
@@ -1748,20 +1749,25 @@ Scan email archives for other stuff left out
1749
Scan man pages to see if any assume more background than this manual
1750
provides.
1751
1751
-Simplify beginning by suggesting disconnected head instead of temporary
1752
-branch creation.
1752
+Simplify beginning by suggesting disconnected head instead of
1753
+temporary branch creation.
1754
1755
Explain how to refer to file stages in the "how to resolve a merge"
1756
section: diff -1, -2, -3, --ours, --theirs :1:/path notation. The
1756
-"git ls-files --unmerged --stage" thing is sorta useful too, actually. And
1757
-note gitk --merge. Also what's easiest way to see common merge base?
1757
+"git ls-files --unmerged --stage" thing is sorta useful too,
1758
+actually. And note gitk --merge. Also what's easiest way to see
1759
+common merge base? Note also text where I claim rebase and am
1760
+conflicts are resolved like merges isn't generally true, at least by
1761
+default--fix.
1762
1759
-Add more good examples. Entire sections of just cookbook examples might
1760
-be a good idea; maybe make an "advanced examples" section a standard
1761
-end-of-chapter section?
1763
+Add more good examples. Entire sections of just cookbook examples
1764
+might be a good idea; maybe make an "advanced examples" section a
1765
+standard end-of-chapter section?
1766
1767
Include cross-references to the glossary, where appropriate.
1768
1769
+Add quickstart as first chapter.
1770
+
1771
To document:
1772
reflogs, git reflog expire
1773
shallow clones?? See draft 1.5.0 release notes for some documentation.