Several trivial documentation touch ups.

Move incorrect asciidoc level 2 titles back to level 1. Show output of git-name-rev in man page example. Reword sentences that begin with a period (.) in asciidoc numbered lists to work around conversion to man page bug. Mention that git-repack now calls git-prune-packed when the -d option is passed to it. [imap] section headers in the config file example need to be contained in a literal block. imap.pass is the proper config file variable to use, not imap.password. Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca> Signed-off-by: Junio C Hamano <junkio@cox.net>
git-mirror · May 5, 2006 · 2b5f3ed · 2b5f3ed
1 parent 8852145
commit 2b5f3ed
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 6 deletions.
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
@@ -101,7 +101,7 @@ OPTIONS
 	is not allowed.
 
 Examples
-~~~~~~~~
+--------
 
 Clone from upstream::
 +

diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
@@ -29,6 +29,7 @@ CONFIGURATION
 git-imap-send requires the following values in the repository
 configuration file (shown with examples):
 
+..........................
 [imap]
     Folder = "INBOX.Drafts"
 
@@ -38,8 +39,9 @@ configuration file (shown with examples):
 [imap]
     Host = imap.server.com
     User = bob
-    Password = pwd
+    Pass = pwd
     Port = 143
+..........................
 
 
 BUGS

diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt
@@ -41,6 +41,7 @@ Enter git-name-rev:
 
 ------------
 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
+33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
 ------------
 
 Now you are wiser, because you know that it happened 940 revisions before v0.99.

diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
@@ -38,6 +38,7 @@ OPTIONS
 -d::
 	After packing, if the newly created packs make some
 	existing packs redundant, remove the redundant packs.
+	Also runs gitlink:git-prune-packed[1].
 
 -l::
         Pass the `--local` option to `git pack-objects`, see

diff --git a/Documentation/git-repo-config.txt b/Documentation/git-repo-config.txt
@@ -34,10 +34,10 @@ convert the value to the canonical form (simple decimal number for int,
 a "true" or "false" string for bool). If no type specifier is passed,
 no checks or transformations are performed on the value.
 
-This command will fail if
+This command will fail if:
 
-. .git/config is invalid,
-. .git/config can not be written to,
+. The .git/config file is invalid,
+. Can not write to .git/config,
 . no section was provided,
 . the section or key is invalid,
 . you try to unset an option which does not exist, or

diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
@@ -43,7 +43,7 @@ OPTIONS
 	Commit to make the current HEAD.
 
 Examples
-~~~~~~~~
+--------
 
 Undo a commit and redo::
 +
-Original file line number
+Diff line change
@@ Expand Up / @@ -41,6 +41,7 @@ Enter git-name-rev: @@
     ------------
     % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
+db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
     ------------
     Now you are wiser, because you know that it happened 940 revisions before v0.99.
@@ Expand Down @@