[PATCH] Subject: [PATCH] Add some documentation.
Add some documentation. Text taken from the the commit messages and the command sources.
This commit is contained in:
A Large Angry SCM
Junio C Hamano
parent
8500231579
commit
52a22d1e72
@ -3,26 +3,21 @@ git-add-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-add-script - Some git command not yet documented.
|
git-add-script - Add files to the cache.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-add-script' [ --option ] <args>...
|
'git-add-script' [<file>]\+
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
A simple wrapper to git-update-cache to add files to the cache for people used
|
||||||
|
to do "cvs add".
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
<file>::
|
||||||
Some option not yet documented.
|
Files to add to the cache.
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,27 @@ git-branch-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-branch-script - Some git command not yet documented.
|
git-branch-script - Create a new branch.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-branch-script' [ --option ] <args>...
|
'git-branch-script' [<branchname> [start-point]]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
If no argument is provided, show available branches and mark current
|
||||||
|
branch with star. Otherwise, create a new branch of name <branchname>.
|
||||||
|
|
||||||
|
If a starting point is also specified, that will be where the branch is
|
||||||
|
created, otherwise it will be created at the current HEAD.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
<branchname>::
|
||||||
Some option not yet documented.
|
The name of the branch to create.
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
start-point::
|
||||||
|
Where to make the branch; defaults to HEAD.
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,30 @@ git-cherry(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-cherry - Some git command not yet documented.
|
git-cherry - Find commits not merged upstream.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-cherry' [ --option ] <args>...
|
'git-cherry' [-v] <upstream> [<head>]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
Each commit between the fork-point and <head> is examined, and compared against
|
||||||
|
the change each commit between the fork-point and <upstream> introduces.
|
||||||
|
Commits already included in upstream are prefixed with '-' (meaning "drop from
|
||||||
|
my local pull"), while commits missing from upstream are prefixed with '+'
|
||||||
|
(meaning "add to the updated upstream").
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
-v::
|
||||||
Some option not yet documented.
|
Verbose.
|
||||||
|
|
||||||
<args>...::
|
<upstream>::
|
||||||
Some argument not yet documented.
|
Upstream branch to compare against.
|
||||||
|
|
||||||
|
<head>::
|
||||||
|
Working branch; defaults to HEAD.
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,16 @@ git-count-objects-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-count-objects-script - Some git command not yet documented.
|
git-count-objects-script - Reports on unpacked objects.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-count-objects-script' [ --option ] <args>...
|
'git-count-objects-script'
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
This counts the number of unpacked object files and disk space consumed by
|
||||||
|
them, to help you decide when it is a good time to repack.
|
||||||
|
|
||||||
OPTIONS
|
|
||||||
-------
|
|
||||||
--option::
|
|
||||||
Some option not yet documented.
|
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,25 @@ git-patch-id(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-patch-id - Some git command not yet documented.
|
git-patch-id - Generate a patch ID.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-patch-id' [ --option ] <args>...
|
'git-patch-id' < <patch>
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
A "patch ID" is nothing but a SHA1 of the diff associated with a patch, with
|
||||||
|
whitespace and line numbers ignored. As such, it's "reasonably stable", but at
|
||||||
|
the same time also reasonably unique, ie two patches that have the same "patch
|
||||||
|
ID" are almost guaranteed to be the same thing.
|
||||||
|
|
||||||
|
IOW, you can use this thing to look for likely duplicate commits.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
<patch>::
|
||||||
Some option not yet documented.
|
The diff to create the ID of.
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,23 @@ git-rebase-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-rebase-script - Some git command not yet documented.
|
git-rebase-script - Rebase local commits to new upstream head.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-rebase-script' [ --option ] <args>...
|
'git-rebase-script' <upstream> [<head>]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
Rebases local commits to the new head of the upstream tree.'
|
||||||
|
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
<upstream>::
|
||||||
Some option not yet documented.
|
Upstream branch to compare against.
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
<head>::
|
||||||
|
Working branch; defaults to HEAD.
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,25 @@ git-relink-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-relink-script - Some git command not yet documented.
|
git-relink-script - Hardlink common objects in local repositories.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-relink-script' [ --option ] <args>...
|
'git-relink-script' [--safe] <dir> <dir> [<dir>]\*
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
This will scan 2 or more object repositories and look for common objects, check
|
||||||
|
if they are hardlinked, and replace one with a hardlink to the other if not.
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
--safe::
|
||||||
Some option not yet documented.
|
Stops if two objects with the same hash exist but have different sizes.
|
||||||
|
Default is to warn and continue.
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
<dir>::
|
||||||
|
Directories containing a .git/objects/ subdirectory.
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,22 @@ git-revert-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-revert-script - Some git command not yet documented.
|
git-revert-script - Revert an existing commit.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-revert-script' [ --option ] <args>...
|
'git-revert-script' <commit>
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
Given one existing commit, revert the change the patch introduces, and record a
|
||||||
|
new commit that records it. This requires your working tree to be clean (no
|
||||||
|
modifications from the HEAD commit).
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
<commit>::
|
||||||
Some option not yet documented.
|
Commit to revert.
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,22 @@ git-sh-setup-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-sh-setup-script - Some git command not yet documented.
|
git-sh-setup-script - Common git shell script setup code.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-sh-setup-script' [ --option ] <args>...
|
'git-sh-setup-script'
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
|
||||||
|
|
||||||
|
Sets up the normal git environment variables and a few helper functions
|
||||||
|
(currently just "die()"), and returns ok if it all looks like a git archive.
|
||||||
|
So use it something like
|
||||||
|
|
||||||
OPTIONS
|
. git-sh-setup-script || die "Not a git archive"
|
||||||
-------
|
|
||||||
--option::
|
|
||||||
Some option not yet documented.
|
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
to make the rest of the git scripts more careful and readable.
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
@ -3,26 +3,20 @@ git-verify-tag-script(1)
|
|||||||
|
|
||||||
NAME
|
NAME
|
||||||
----
|
----
|
||||||
git-verify-tag-script - Some git command not yet documented.
|
git-verify-tag-script - Check the GPG signature of tag.
|
||||||
|
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
'git-verify-tag-script' [ --option ] <args>...
|
'git-verify-tag-script' <tag>
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
Does something not yet documented.
|
Validates the gpg signature created by git-tag-script.
|
||||||
|
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
--option::
|
<tag>::
|
||||||
Some option not yet documented.
|
SHA1 identifier of a git tag object.
|
||||||
|
|
||||||
<args>...::
|
|
||||||
Some argument not yet documented.
|
|
||||||
|
|
||||||
|
|
||||||
Author
|
Author
|
||||||
------
|
------
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user