@matheusbsbs / matheus-bagliano / commits / 2b5f3ed316
Fork 0

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>

sean committed May 5, 2006 at 15:05 UTC 2b5f3ed3166ea7d93f4138bb2b6c849851ba86ac
6 files changed +10 -6
Documentation/git-clone.txt
+1 -1
@@ -101,7 +101,7 @@ OPTIONS
101 is not allowed.
102
103 Examples
104 -~~~~~~~~
104 +--------
105
106 Clone from upstream::
107 +
Documentation/git-imap-send.txt
+3 -1
@@ -29,6 +29,7 @@ CONFIGURATION
29 git-imap-send requires the following values in the repository
30 configuration file (shown with examples):
31
32 +..........................
33 [imap]
34 Folder = "INBOX.Drafts"
35
@@ -38,8 +39,9 @@ configuration file (shown with examples):
39 [imap]
40 Host = imap.server.com
41 User = bob
41 - Password = pwd
42 + Pass = pwd
43 Port = 143
44 +..........................
45
46
47 BUGS
Documentation/git-name-rev.txt
+1
@@ -41,6 +41,7 @@ Enter git-name-rev:
41
42 ------------
43 % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
44 +33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
45 ------------
46
47 Now you are wiser, because you know that it happened 940 revisions before v0.99.
Documentation/git-repack.txt
+1
@@ -38,6 +38,7 @@ OPTIONS
38 -d::
39 After packing, if the newly created packs make some
40 existing packs redundant, remove the redundant packs.
41 + Also runs gitlink:git-prune-packed[1].
42
43 -l::
44 Pass the `--local` option to `git pack-objects`, see
Documentation/git-repo-config.txt
+3 -3
@@ -34,10 +34,10 @@ convert the value to the canonical form (simple decimal number for int,
34 a "true" or "false" string for bool). If no type specifier is passed,
35 no checks or transformations are performed on the value.
36
37 -This command will fail if
37 +This command will fail if:
38
39 -. .git/config is invalid,
40 -. .git/config can not be written to,
39 +. The .git/config file is invalid,
40 +. Can not write to .git/config,
41 . no section was provided,
42 . the section or key is invalid,
43 . you try to unset an option which does not exist, or
Documentation/git-reset.txt
+1 -1
@@ -43,7 +43,7 @@ OPTIONS
43 Commit to make the current HEAD.
44
45 Examples
46 -~~~~~~~~
46 +--------
47
48 Undo a commit and redo::
49 +