Skip to content

Commit 52a22d1

Browse files
gitzillaJunio C Hamano
gitzilla
authored and
Junio C Hamano
committed
[PATCH] Subject: [PATCH] Add some documentation.
Add some documentation. Text taken from the the commit messages and the command sources.
1 parent 8500231 commit 52a22d1

10 files changed

+77
-106
lines changed

‎Documentation/git-add-script.txt‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,21 @@ git-add-script(1)
33

44
NAME
55
----
6-
git-add-script - Some git command not yet documented.
7-
6+
git-add-script - Add files to the cache.
87

98
SYNOPSIS
109
--------
11-
'git-add-script' [ --option ] <args>...
10+
'git-add-script' [<file>]\+
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
14+
A simple wrapper to git-update-cache to add files to the cache for people used
15+
to do "cvs add".
1716

1817
OPTIONS
1918
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
25-
19+
<file>::
20+
Files to add to the cache.
2621

2722
Author
2823
------

‎Documentation/git-branch-script.txt‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,27 @@ git-branch-script(1)
33

44
NAME
55
----
6-
git-branch-script - Some git command not yet documented.
7-
6+
git-branch-script - Create a new branch.
87

98
SYNOPSIS
109
--------
11-
'git-branch-script' [ --option ] <args>...
10+
'git-branch-script' [<branchname> [start-point]]
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
14+
If no argument is provided, show available branches and mark current
15+
branch with star. Otherwise, create a new branch of name <branchname>.
1616

17+
If a starting point is also specified, that will be where the branch is
18+
created, otherwise it will be created at the current HEAD.
1719

1820
OPTIONS
1921
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
22+
<branchname>::
23+
The name of the branch to create.
2524

25+
start-point::
26+
Where to make the branch; defaults to HEAD.
2627

2728
Author
2829
------

‎Documentation/git-cherry.txt‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,30 @@ git-cherry(1)
33

44
NAME
55
----
6-
git-cherry - Some git command not yet documented.
7-
6+
git-cherry - Find commits not merged upstream.
87

98
SYNOPSIS
109
--------
11-
'git-cherry' [ --option ] <args>...
10+
'git-cherry' [-v] <upstream> [<head>]
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
14+
Each commit between the fork-point and <head> is examined, and compared against
15+
the change each commit between the fork-point and <upstream> introduces.
16+
Commits already included in upstream are prefixed with '-' (meaning "drop from
17+
my local pull"), while commits missing from upstream are prefixed with '+'
18+
(meaning "add to the updated upstream").
1719

1820
OPTIONS
1921
-------
20-
--option::
21-
Some option not yet documented.
22+
-v::
23+
Verbose.
2224

23-
<args>...::
24-
Some argument not yet documented.
25+
<upstream>::
26+
Upstream branch to compare against.
2527

28+
<head>::
29+
Working branch; defaults to HEAD.
2630

2731
Author
2832
------

‎Documentation/git-count-objects-script.txt‎

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,16 @@ git-count-objects-script(1)
33

44
NAME
55
----
6-
git-count-objects-script - Some git command not yet documented.
7-
6+
git-count-objects-script - Reports on unpacked objects.
87

98
SYNOPSIS
109
--------
11-
'git-count-objects-script' [ --option ] <args>...
10+
'git-count-objects-script'
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
17-
18-
OPTIONS
19-
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
25-
14+
This counts the number of unpacked object files and disk space consumed by
15+
them, to help you decide when it is a good time to repack.
2616

2717
Author
2818
------

‎Documentation/git-patch-id.txt‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,25 @@ git-patch-id(1)
33

44
NAME
55
----
6-
git-patch-id - Some git command not yet documented.
7-
6+
git-patch-id - Generate a patch ID.
87

98
SYNOPSIS
109
--------
11-
'git-patch-id' [ --option ] <args>...
10+
'git-patch-id' < <patch>
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
14+
A "patch ID" is nothing but a SHA1 of the diff associated with a patch, with
15+
whitespace and line numbers ignored. As such, it's "reasonably stable", but at
16+
the same time also reasonably unique, ie two patches that have the same "patch
17+
ID" are almost guaranteed to be the same thing.
1618

19+
IOW, you can use this thing to look for likely duplicate commits.
1720

1821
OPTIONS
1922
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
25-
23+
<patch>::
24+
The diff to create the ID of.
2625

2726
Author
2827
------

‎Documentation/git-rebase-script.txt‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,23 @@ git-rebase-script(1)
33

44
NAME
55
----
6-
git-rebase-script - Some git command not yet documented.
7-
6+
git-rebase-script - Rebase local commits to new upstream head.
87

98
SYNOPSIS
109
--------
11-
'git-rebase-script' [ --option ] <args>...
10+
'git-rebase-script' <upstream> [<head>]
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
14+
Rebases local commits to the new head of the upstream tree.'
1715

1816
OPTIONS
1917
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
18+
<upstream>::
19+
Upstream branch to compare against.
2520

21+
<head>::
22+
Working branch; defaults to HEAD.
2623

2724
Author
2825
------

‎Documentation/git-relink-script.txt‎

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

44
NAME
55
----
6-
git-relink-script - Some git command not yet documented.
7-
6+
git-relink-script - Hardlink common objects in local repositories.
87

98
SYNOPSIS
109
--------
11-
'git-relink-script' [ --option ] <args>...
10+
'git-relink-script' [--safe] <dir> <dir> [<dir>]\*
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
14+
This will scan 2 or more object repositories and look for common objects, check
15+
if they are hardlinked, and replace one with a hardlink to the other if not.
1716

1817
OPTIONS
1918
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
19+
--safe::
20+
Stops if two objects with the same hash exist but have different sizes.
21+
Default is to warn and continue.
2522

23+
<dir>::
24+
Directories containing a .git/objects/ subdirectory.
2625

2726
Author
2827
------

‎Documentation/git-revert-script.txt‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,22 @@ git-revert-script(1)
33

44
NAME
55
----
6-
git-revert-script - Some git command not yet documented.
7-
6+
git-revert-script - Revert an existing commit.
87

98
SYNOPSIS
109
--------
11-
'git-revert-script' [ --option ] <args>...
10+
'git-revert-script' <commit>
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
14+
Given one existing commit, revert the change the patch introduces, and record a
15+
new commit that records it. This requires your working tree to be clean (no
16+
modifications from the HEAD commit).
1717

1818
OPTIONS
1919
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
25-
20+
<commit>::
21+
Commit to revert.
2622

2723
Author
2824
------

‎Documentation/git-sh-setup-script.txt‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,22 @@ git-sh-setup-script(1)
33

44
NAME
55
----
6-
git-sh-setup-script - Some git command not yet documented.
7-
6+
git-sh-setup-script - Common git shell script setup code.
87

98
SYNOPSIS
109
--------
11-
'git-sh-setup-script' [ --option ] <args>...
10+
'git-sh-setup-script'
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
1714

18-
OPTIONS
19-
-------
20-
--option::
21-
Some option not yet documented.
15+
Sets up the normal git environment variables and a few helper functions
16+
(currently just "die()"), and returns ok if it all looks like a git archive.
17+
So use it something like
2218

23-
<args>...::
24-
Some argument not yet documented.
19+
. git-sh-setup-script || die "Not a git archive"
2520

21+
to make the rest of the git scripts more careful and readable.
2622

2723
Author
2824
------

‎Documentation/git-verify-tag-script.txt‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,20 @@ git-verify-tag-script(1)
33

44
NAME
55
----
6-
git-verify-tag-script - Some git command not yet documented.
7-
6+
git-verify-tag-script - Check the GPG signature of tag.
87

98
SYNOPSIS
109
--------
11-
'git-verify-tag-script' [ --option ] <args>...
10+
'git-verify-tag-script' <tag>
1211

1312
DESCRIPTION
1413
-----------
15-
Does something not yet documented.
16-
14+
Validates the gpg signature created by git-tag-script.
1715

1816
OPTIONS
1917
-------
20-
--option::
21-
Some option not yet documented.
22-
23-
<args>...::
24-
Some argument not yet documented.
25-
18+
<tag>::
19+
SHA1 identifier of a git tag object.
2620

2721
Author
2822
------

0 commit comments

Comments
 (0)