Documentation updates.
Fill in more missing documentation. Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Sep 7, 2005 at 23:04 UTC
35ef3a4c63d6b60cda8f26c842c0efee8d2cb5cc
4 files changed
+74
-28
Documentation/git-diff.txt
+23
-9
@@ -3,25 +3,39 @@ git-diff(1)
3
4
NAME
5
----
6
-git-diff - Some git command not yet documented.
6
+git-diff - Show changes between commits, commit and working tree, etc.
7
8
9
SYNOPSIS
10
--------
11
-'git-diff' [ --option ] <args>...
11
+'git-diff' [ --diff-options ] <ent>{0,2} [<path>...]
12
13
DESCRIPTION
14
-----------
15
-Does something not yet documented.
16
-
15
+Show changes between two ents, an ent and the working tree, an
16
+ent and the index file, or the index file and the working tree.
17
+The combination of what is compared with what is determined by
18
+the number of ents given to the command.
19
+
20
+`----------------`--------`-----------------------------`------------------
21
+Number of ents Options What's Compared Underlying command
22
+---------------------------------------------------------------------------
23
+0 - index file and working tree git-diff-files
24
+1 --cached ent and index file git-diff-index
25
+1 - ent and working tree git-diff-index
26
+2 - two ents git-diff-tree
27
+---------------------------------------------------------------------------
28
29
OPTIONS
30
-------
20
---option::
21
- Some option not yet documented.
22
-
23
-<args>...::
24
- Some argument not yet documented.
31
+--diff-options::
32
+ '--diff-options' are passed to the `git-diff-files`,
33
+ `git-diff-index`, and `git-diff-tree` commands. See the
34
+ documentation for these commands for description.
35
+
36
+<path>...::
37
+ The <path> arguments are also passed to `git-diff-\*`
38
+ commands.
39
40
41
Author
Documentation/git-format-patch.txt
+38
-7
@@ -3,25 +3,56 @@ git-format-patch(1)
3
4
NAME
5
----
6
-git-format-patch - Some git command not yet documented.
6
+git-format-patch - Prepare patches for e-mail submission.
7
8
9
SYNOPSIS
10
--------
11
-'git-format-patch' [ --option ] <args>...
11
+'git-format-patch' [-n][-o <dir>][-k][--mbox][--diff-options] <his> [<mine>]
12
13
DESCRIPTION
14
-----------
15
-Does something not yet documented.
15
+Prepare each commit with its patch since <mine> head forked from
16
+<his> head, one file per patch, for e-mail submission. Each
17
+output file is numbered sequentially from 1, and uses the first
18
+line of the commit message (massaged for pathname safety) as the
19
+filename.
20
+
21
+When -o is specified, output files are created in that
22
+directory; otherwise in the current working directory.
23
+
24
+When -n is specified, instead of "[PATCH] Subject", the first
25
+line is formatted as "[PATCH N/M] Subject", unless you have only
26
+one patch.
27
+
28
+When --mbox is specified, the output is formatted to resemble
29
+UNIX mailbox format, and can be concatenated together for
30
+processing with applymbox.
31
32
33
OPTIONS
34
-------
20
---option::
21
- Some option not yet documented.
35
+-o <dir>::
36
+ Use <dir> to store the resulting files, instead of the
37
+ current working directory.
38
+
39
+-n::
40
+ Name output in '[PATCH n/m]' format.
41
+
42
+-k::
43
+ Do not strip/add '[PATCH]' from the first line of the
44
+ commit log message.
45
+
46
+--author, --date::
47
+ Output From: and Date: headers for commits made by
48
+ yourself as well. Usually these are output only for
49
+ commits made by people other than yourself.
50
23
-<args>...::
24
- Some argument not yet documented.
51
+--mbox::
52
+ Format the output files for closer to mbox format by
53
+ adding a phony Unix "From " line, so they can be
54
+ concatenated together and fed to `git-applymbox`.
55
+ Implies --author and --date.
56
57
58
Author
Documentation/git-stripspace.txt
+1
-1
@@ -3,7 +3,7 @@ git-stripspace(1)
3
4
NAME
5
----
6
-git-stripspace - Fileter out empty lines.
6
+git-stripspace - Filter out empty lines.
7
8
9
SYNOPSIS
Documentation/git.txt
+12
-11
@@ -237,10 +237,18 @@ link:git-commit.html[git-commit]::
237
Record changes to the repository.
238
Previously this command was known as git-commit-script.
239
240
+link:git-diff.html[git-diff]::
241
+ git-diff.
242
+ Previously this command was known as git-diff-script.
243
+
244
link:git-fetch.html[git-fetch]::
245
Download from a remote repository via various protocols.
246
Previously this command was known as git-fetch-script.
247
248
+link:git-format-patch.html[git-format-patch]::
249
+ git-format-patch.
250
+ Previously this command was known as git-format-patch-script.
251
+
252
link:git-log.html[git-log]::
253
Shows commit logs.
254
Previously this command was known as git-log-script.
@@ -391,19 +399,12 @@ link:git-send-email.html[git-send-email]::
399
link:git-show-rev-cache.html[git-show-rev-cache]::
400
Show the contents of a rev-cache file.
401
394
-Commands not yet documented
395
----------------------------
396
-
397
-link:git-diff.html[git-diff]::
398
- git-diff.
399
- Previously this command was known as git-diff-script.
402
+link:git-stripspace.html[git-stripspace]::
403
+ Filter out empty lines.
404
401
-link:git-format-patch.html[git-format-patch]::
402
- git-format-patch.
403
- Previously this command was known as git-format-patch-script.
405
405
-link:git-stripspace.html[git-stripspace]::
406
- git-stripspace.
406
+Commands not yet documented
407
+---------------------------
408
409
link:gitk.html[gitk]::
410
gitk.