Skip to content

Commit f85a419

Browse files
author
Junio C Hamano
committed
Accumulated documentation updates.
Signed-off-by: Junio C Hamano <junkio@cox.net>
1 parent d5acdcf commit f85a419

File tree

8 files changed

+297
-149
lines changed

8 files changed

+297
-149
lines changed

‎Documentation/git-applymbox.txt‎

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,66 @@ git-applymbox(1)
33

44
NAME
55
----
6-
git-applymbox - Some git command not yet documented.
6+
git-applymbox - Apply a series of patches in a mailbox
77

88

99
SYNOPSIS
1010
--------
11-
'git-applymbox' [ --option ] <args>...
11+
'git-applymbox' [-u] [-k] [-q] ( -c .dotest/<num> | <mbox> ) [ <signoff> ]
1212

1313
DESCRIPTION
1414
-----------
15-
Does something not yet documented.
15+
Splits mail messages in a mailbox into commit log message,
16+
authorship information and patches, and applies them to the
17+
current branch.
1618

1719

1820
OPTIONS
1921
-------
20-
--option::
21-
Some option not yet documented.
22+
-q::
23+
Apply patches interactively. The user will be given
24+
opportunity to edit the log message and the patch before
25+
attempting to apply patch in each e-mail message.
2226

23-
<args>...::
24-
Some argument not yet documented.
27+
-k::
28+
Usually the program 'cleans up' the Subject: header line
29+
to extract the title line for the commit log message,
30+
among which (1) remove 'Re:' or 're:', (2) leading
31+
whitespaces, (3) '[' up to ']', typically '[PATCH]', and
32+
then prepends "[PATCH] ". This flag forbids this
33+
munging, and is most useful when used to read back 'git
34+
format-patch --mbox' output.
2535

36+
-u::
37+
By default, the commit log message, author name and
38+
author email are taken from the e-mail without any
39+
charset conversion, after minimally decoding MIME
40+
transfer encoding. This flag causes the resulting
41+
commit to be encoded in utf-8 by transliterating them.
42+
Note that the patch is always used as is without charset
43+
conversion, even with this flag.
44+
45+
-c .dotest/<num>::
46+
When the patch contained in an e-mail does not cleanly
47+
apply, the command exits with an error message. The
48+
patch and extracted message are found in .dotest/, and
49+
you could re-run 'git applymbox' with '-c .dotest/<num>'
50+
flag to restart the process after inspecting and fixing
51+
them.
52+
53+
<mbox>::
54+
The name of the file that contains the e-mail messages
55+
with patches. This file should be in the UNIX mailbox
56+
format. See 'SubmittingPatches' document to learn about
57+
the formatting convention for e-mail submission.
58+
59+
<signoff>::
60+
The name of the file that contains your "Signed-off-by"
61+
line. See 'SubmittingPatches' document to learn what
62+
"Signed-off-by" line means. You can also just say
63+
'yes', 'true', 'me', or 'please' to use an automatically
64+
generated "Signed-off-by" line based on your committer
65+
identity.
2666

2767
Author
2868
------

‎Documentation/git-applypatch.txt‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,33 @@ git-applypatch(1)
33

44
NAME
55
----
6-
git-applypatch - Some git command not yet documented.
6+
git-applypatch - Apply one patch extracted from an e-mail.
77

88

99
SYNOPSIS
1010
--------
11-
'git-applypatch' [ --option ] <args>...
11+
'git-applypatch' <msg> <patch> <info> [<signoff>]
1212

1313
DESCRIPTION
1414
-----------
15-
Does something not yet documented.
15+
Takes three files <msg>, <patch>, and <info> prepared from an
16+
e-mail message by 'git-mailinfo', and creates a commit. It is
17+
usually not necessary to use this command directly.
1618

1719

1820
OPTIONS
1921
-------
20-
--option::
21-
Some option not yet documented.
22+
<msg>::
23+
Commit log message (sans the first line, which comes
24+
from e-mail Subject stored in <info>).
2225

23-
<args>...::
24-
Some argument not yet documented.
26+
<patch>::
27+
The patch to apply.
28+
29+
<info>:
30+
Author and subject information extracted from e-mail,
31+
used on "author" line and as the first line of the
32+
commit log message.
2533

2634

2735
Author

‎Documentation/git-bisect-script.txt‎

Lines changed: 53 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,69 @@ git-bisect-script(1)
33

44
NAME
55
----
6-
git-bisect-script - Some git command not yet documented.
6+
git-bisect-script - Find the change that introduced a bug
77

88

99
SYNOPSIS
1010
--------
11-
'git-bisect-script' [ --option ] <args>...
11+
'git bisect' start
12+
'git bisect' bad <rev>
13+
'git bisect' good <rev>
14+
'git bisect' reset [<branch>]
1215

1316
DESCRIPTION
1417
-----------
15-
Does something not yet documented.
18+
This command uses 'git-rev-list --bisect' option to help drive
19+
the binary search process to find which change introduced a bug,
20+
given an old "good" commit object name and a later "bad" commit
21+
object name.
1622

23+
The way you use it is:
1724

18-
OPTIONS
19-
-------
20-
--option::
21-
Some option not yet documented.
25+
------------------------------------------------
26+
git bisect start
27+
git bisect bad # Current version is bad
28+
git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
29+
# tested that was good
30+
------------------------------------------------
2231

23-
<args>...::
24-
Some argument not yet documented.
32+
When you give at least one bad and one good versions, it will
33+
bisect the revision tree and say something like:
34+
35+
------------------------------------------------
36+
Bisecting: 675 revisions left to test after this
37+
------------------------------------------------
38+
39+
and check out the state in the middle. Now, compile that kernel, and boot
40+
it. Now, let's say that this booted kernel works fine, then just do
41+
42+
------------------------------------------------
43+
git bisect good # this one is good
44+
------------------------------------------------
45+
46+
which will now say
47+
48+
------------------------------------------------
49+
Bisecting: 337 revisions left to test after this
50+
------------------------------------------------
51+
52+
and you continue along, compiling that one, testing it, and depending on
53+
whether it is good or bad, you say "git bisect good" or "git bisect bad",
54+
and ask for the next bisection.
55+
56+
Until you have no more left, and you'll have been left with the first bad
57+
kernel rev in "refs/bisect/bad".
58+
59+
Oh, and then after you want to reset to the original head, do a
60+
61+
------------------------------------------------
62+
git bisect reset
63+
------------------------------------------------
64+
65+
to get back to the master branch, instead of being in one of the bisection
66+
branches ("git bisect start" will do that for you too, actually: it will
67+
reset the bisection state, and before it does that it checks that you're
68+
not using some old bisection branch).
2569

2670

2771
Author

‎Documentation/git-mailinfo.txt‎

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,57 @@ git-mailinfo(1)
33

44
NAME
55
----
6-
git-mailinfo - Some git command not yet documented.
6+
git-mailinfo - Extracts patch from a single e-mail message.
77

88

99
SYNOPSIS
1010
--------
11-
'git-mailinfo' [ --option ] <args>...
11+
'git-mailinfo' [-k] [-u] <msg> <patch>
12+
1213

1314
DESCRIPTION
1415
-----------
15-
Does something not yet documented.
16+
Reading a single e-mail message from the standard input, and
17+
writes the commit log message in <msg> file, and the patches in
18+
<patch> file. The author name, e-mail and e-mail subject are
19+
written out to the standard output to be used by git-applypatch
20+
to create a commit. It is usually not necessary to use this
21+
command directly.
1622

1723

1824
OPTIONS
1925
-------
20-
--option::
21-
Some option not yet documented.
26+
-k::
27+
Usually the program 'cleans up' the Subject: header line
28+
to extract the title line for the commit log message,
29+
among which (1) remove 'Re:' or 're:', (2) leading
30+
whitespaces, (3) '[' up to ']', typically '[PATCH]', and
31+
then prepends "[PATCH] ". This flag forbids this
32+
munging, and is most useful when used to read back 'git
33+
format-patch --mbox' output.
34+
35+
-u::
36+
By default, the commit log message, author name and
37+
author email are taken from the e-mail without any
38+
charset conversion, after minimally decoding MIME
39+
transfer encoding. This flag causes the resulting
40+
commit to be encoded in utf-8 by transliterating them.
41+
Note that the patch is always used as is without charset
42+
conversion, even with this flag.
2243

23-
<args>...::
24-
Some argument not yet documented.
44+
<msg>::
45+
The commit log message extracted from e-mail, usually
46+
except the title line which comes from e-mail Subject.
47+
48+
<patch>::
49+
The patch extracted from e-mail.
2550

2651

2752
Author
2853
------
29-
Written by Linus Torvalds <torvalds@osdl.org>
54+
Written by Linus Torvalds <torvalds@osdl.org> and
55+
Junio C Hamano <junkio@cox.net>
56+
3057

3158
Documentation
3259
--------------

‎Documentation/git-prune-script.txt‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
git-prune-script(1)
22
===================
3-
v0.1, May 2005
3+
v0.99.5, Aug 2005
44

55
NAME
66
----
@@ -9,14 +9,24 @@ git-prune-script - Prunes all unreachable objects from the object database
99

1010
SYNOPSIS
1111
--------
12-
'git-prune-script'
12+
'git-prune-script' [-n]
1313

1414
DESCRIPTION
1515
-----------
16-
This runs "git-fsck-cache --unreachable" program using the heads specified
17-
on the command line (or `$GIT_DIR/refs/heads/\*` and `$GIT_DIR/refs/tags/\*`
18-
if none is specified), and prunes all unreachable objects from the object
19-
database.
16+
17+
This runs `git-fsck-cache --unreachable` using the heads
18+
specified on the command line (or `$GIT_DIR/refs/heads/\*` and
19+
`$GIT_DIR/refs/tags/\*` if none is specified), and prunes all
20+
unreachable objects from the object database. In addition, it
21+
prunes the unpacked objects that are also found in packs by
22+
running `git prune-packed`.
23+
24+
OPTIONS
25+
-------
26+
27+
-n::
28+
Do not remove anything; just report what it would
29+
remove.
2030

2131

2232
Author

‎Documentation/git-repack-script.txt‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
git-repack-script(1)
22
=====================
3-
v0.1, August 2005
3+
v0.99.5, August 2005
44

55
NAME
66
----
@@ -10,17 +10,36 @@ objects into pack files.
1010

1111
SYNOPSIS
1212
--------
13-
'git-repack-script'
13+
'git-repack-script' [-a] [-d]
1414

1515
DESCRIPTION
1616
-----------
17-
This script is used to combine all objects that do not currently reside in a
18-
"pack", into a pack.
1917

20-
A pack is a collection of objects, individually compressed, with delta
21-
compression applied, stored in a single file, with an associated index file.
18+
This script is used to combine all objects that do not currently
19+
reside in a "pack", into a pack.
20+
21+
A pack is a collection of objects, individually compressed, with
22+
delta compression applied, stored in a single file, with an
23+
associated index file.
24+
25+
Packs are used to reduce the load on mirror systems, backup
26+
engines, disk storage, etc.
27+
28+
OPTIONS
29+
-------
30+
31+
-a::
32+
Instead of incrementally packing the unpacked objects,
33+
pack everything available into a single pack.
34+
Especially useful when packing a repository that is used
35+
for a private development and there no need to worry
36+
about people fetching via dumb protocols from it. Use
37+
with '-d'.
38+
39+
-d::
40+
After packing, if the newly created packs make some
41+
existing packs redundant, remove the redundant packs.
2242

23-
Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc.
2443

2544
Author
2645
------

‎Documentation/git-show-branch.txt‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
git-show-branch(1)
22
==================
3-
v0.99.4, Aug 2005
3+
v0.99.5, Aug 2005
44

55
NAME
66
----
@@ -28,7 +28,8 @@ OPTIONS
2828
--more=<n>::
2929
Usually the command stops output upon showing the commit
3030
that is the common ancestor of all the branches. This
31-
flag tells the command to go <n> commits beyond that.
31+
flag tells the command to go <n> more common commits
32+
beyond that.
3233

3334
--merge-base::
3435
Instead of showing the commit list, just act like the

0 commit comments

Comments
 (0)