Skip to content

Commit 2b5f3ed

Browse files
loopsJunio C Hamano
authored andcommitted
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>
1 parent 8852145 commit 2b5f3ed

File tree

6 files changed

+10
-6
lines changed

6 files changed

+10
-6
lines changed

Documentation/git-clone.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ OPTIONS
101101
is not allowed.
102102

103103
Examples
104-
~~~~~~~~
104+
--------
105105

106106
Clone from upstream::
107107
+

Documentation/git-imap-send.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ CONFIGURATION
2929
git-imap-send requires the following values in the repository
3030
configuration file (shown with examples):
3131

32+
..........................
3233
[imap]
3334
Folder = "INBOX.Drafts"
3435

@@ -38,8 +39,9 @@ configuration file (shown with examples):
3839
[imap]
3940
Host = imap.server.com
4041
User = bob
41-
Password = pwd
42+
Pass = pwd
4243
Port = 143
44+
..........................
4345

4446

4547
BUGS

Documentation/git-name-rev.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Enter git-name-rev:
4141

4242
------------
4343
% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
44+
33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99^0~940
4445
------------
4546

4647
Now you are wiser, because you know that it happened 940 revisions before v0.99.

Documentation/git-repack.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ OPTIONS
3838
-d::
3939
After packing, if the newly created packs make some
4040
existing packs redundant, remove the redundant packs.
41+
Also runs gitlink:git-prune-packed[1].
4142

4243
-l::
4344
Pass the `--local` option to `git pack-objects`, see

Documentation/git-repo-config.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ convert the value to the canonical form (simple decimal number for int,
3434
a "true" or "false" string for bool). If no type specifier is passed,
3535
no checks or transformations are performed on the value.
3636

37-
This command will fail if
37+
This command will fail if:
3838

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,
4141
. no section was provided,
4242
. the section or key is invalid,
4343
. you try to unset an option which does not exist, or

Documentation/git-reset.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ OPTIONS
4343
Commit to make the current HEAD.
4444

4545
Examples
46-
~~~~~~~~
46+
--------
4747

4848
Undo a commit and redo::
4949
+

0 commit comments

Comments
 (0)