{"thread":{"id":"1670","subject":"Subject: [PATCH] Add some documentation.","startedAt":"2005-08-27T01:18:48Z","lastAt":"2005-08-27T01:18:48Z","messageCount":1,"participants":["A Large Angry SCM"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"7830","messageId":"430FBF78.6050204@gmail.com","threadId":"1670","inReplyTo":null,"subject":"Subject: [PATCH] Add some documentation.","fromName":"A Large Angry SCM","fromEmail":"gitzilla@gmail.com","sentAt":"2005-08-27T01:18:48Z","receivedAt":"2005-08-27T01:18:48Z","isPatch":true,"sender":{"key":"gitzilla@gmail.com","avatar":"https://gravatar.com/avatar/354625c442439908ff3dd99757dee330e29e9df7847472384faf7a00add247fb?d=mp&s=160"},"body":"Add some documentation.\n\nText taken from the the commit messages and the command sources.\n\n---\n\nI made no attempt to use the proper terminology, as defined by the new\nglossary, but instead used the text from the original commit messages and/or\nthe program source.\n\nThese are some of the easy ones. Some others (like git-diff-script) will\nrequire real effort to adequately document.\n\nHopefully I followed my own instructions correctly and will avoid being hit\nby the \"shiny blue bat\". :-)\n\n Documentation/git-add-script.txt           |   17 ++++++-----------\n Documentation/git-branch-script.txt        |   19 ++++++++++---------\n Documentation/git-cherry.txt               |   22 +++++++++++++---------\n Documentation/git-count-objects-script.txt |   18 ++++--------------\n Documentation/git-patch-id.txt             |   19 +++++++++----------\n Documentation/git-rebase-script.txt        |   17 +++++++----------\n Documentation/git-relink-script.txt        |   19 +++++++++----------\n Documentation/git-revert-script.txt        |   18 +++++++-----------\n Documentation/git-sh-setup-script.txt      |   18 +++++++-----------\n Documentation/git-verify-tag-script.txt    |   16 +++++-----------\n 10 files changed, 77 insertions(+), 106 deletions(-)\n\na02a9ef2a347e4fac8088fb289dd24c7110c4ee4\ndiff --git a/Documentation/git-add-script.txt b/Documentation/git-add-script.txt\n--- a/Documentation/git-add-script.txt\n+++ b/Documentation/git-add-script.txt\n@@ -3,26 +3,21 @@ git-add-script(1)\n\n NAME\n ----\n-git-add-script - Some git command not yet documented.\n-\n+git-add-script - Add files to the cache.\n\n SYNOPSIS\n --------\n-'git-add-script' [ --option ] <args>...\n+'git-add-script' [<file>]\\+\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n+A simple wrapper to git-update-cache to add files to the cache for people used\n+to do \"cvs add\".\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n-\n+<file>::\n+\tFiles to add to the cache.\n\n Author\n ------\ndiff --git a/Documentation/git-branch-script.txt b/Documentation/git-branch-script.txt\n--- a/Documentation/git-branch-script.txt\n+++ b/Documentation/git-branch-script.txt\n@@ -3,26 +3,27 @@ git-branch-script(1)\n\n NAME\n ----\n-git-branch-script - Some git command not yet documented.\n-\n+git-branch-script - Create a new branch.\n\n SYNOPSIS\n --------\n-'git-branch-script' [ --option ] <args>...\n+'git-branch-script' [<branchname> [start-point]]\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n+If no argument is provided, show available branches and mark current\n+branch with star. Otherwise, create a new branch of name <branchname>.\n\n+If a starting point is also specified, that will be where the branch is\n+created, otherwise it will be created at the current HEAD.\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n+<branchname>::\n+\tThe name of the branch to create.\n\n+start-point::\n+\tWhere to make the branch; defaults to HEAD.\n\n Author\n ------\ndiff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt\n--- a/Documentation/git-cherry.txt\n+++ b/Documentation/git-cherry.txt\n@@ -3,26 +3,30 @@ git-cherry(1)\n\n NAME\n ----\n-git-cherry - Some git command not yet documented.\n-\n+git-cherry - Find commits not merged upstream.\n\n SYNOPSIS\n --------\n-'git-cherry' [ --option ] <args>...\n+'git-cherry' [-v] <upstream> [<head>]\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n+Each commit between the fork-point and <head> is examined, and compared against\n+the change each commit between the fork-point and <upstream> introduces.\n+Commits already included in upstream are prefixed with '-' (meaning \"drop from\n+my local pull\"), while commits missing from upstream are prefixed with '+'\n+(meaning \"add to the updated upstream\").\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n+-v::\n+\tVerbose.\n\n-<args>...::\n-\tSome argument not yet documented.\n+<upstream>::\n+\tUpstream branch to compare against.\n\n+<head>::\n+\tWorking branch; defaults to HEAD.\n\n Author\n ------\ndiff --git a/Documentation/git-count-objects-script.txt b/Documentation/git-count-objects-script.txt\n--- a/Documentation/git-count-objects-script.txt\n+++ b/Documentation/git-count-objects-script.txt\n@@ -3,26 +3,16 @@ git-count-objects-script(1)\n\n NAME\n ----\n-git-count-objects-script - Some git command not yet documented.\n-\n+git-count-objects-script - Reports on unpacked objects.\n\n SYNOPSIS\n --------\n-'git-count-objects-script' [ --option ] <args>...\n+'git-count-objects-script'\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n-\n-OPTIONS\n--------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n-\n+This counts the number of unpacked object files and disk space consumed by\n+them, to help you decide when it is a good time to repack.\n\n Author\n ------\ndiff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt\n--- a/Documentation/git-patch-id.txt\n+++ b/Documentation/git-patch-id.txt\n@@ -3,26 +3,25 @@ git-patch-id(1)\n\n NAME\n ----\n-git-patch-id - Some git command not yet documented.\n-\n+git-patch-id - Generate a patch ID.\n\n SYNOPSIS\n --------\n-'git-patch-id' [ --option ] <args>...\n+'git-patch-id' < <patch>\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n+A \"patch ID\" is nothing but a SHA1 of the diff associated with a patch, with\n+whitespace and line numbers ignored.  As such, it's \"reasonably stable\", but at\n+the same time also reasonably unique, ie two patches that have the same \"patch\n+ID\" are almost guaranteed to be the same thing.\n\n+IOW, you can use this thing to look for likely duplicate commits.\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n-\n+<patch>::\n+\tThe diff to create the ID of.\n\n Author\n ------\ndiff --git a/Documentation/git-rebase-script.txt b/Documentation/git-rebase-script.txt\n--- a/Documentation/git-rebase-script.txt\n+++ b/Documentation/git-rebase-script.txt\n@@ -3,26 +3,23 @@ git-rebase-script(1)\n\n NAME\n ----\n-git-rebase-script - Some git command not yet documented.\n-\n+git-rebase-script - Rebase local commits to new upstream head.\n\n SYNOPSIS\n --------\n-'git-rebase-script' [ --option ] <args>...\n+'git-rebase-script' <upstream> [<head>]\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n+Rebases local commits to the new head of the upstream tree.'\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n+<upstream>::\n+\tUpstream branch to compare against.\n\n+<head>::\n+\tWorking branch; defaults to HEAD.\n\n Author\n ------\ndiff --git a/Documentation/git-relink-script.txt b/Documentation/git-relink-script.txt\n--- a/Documentation/git-relink-script.txt\n+++ b/Documentation/git-relink-script.txt\n@@ -3,26 +3,25 @@ git-relink-script(1)\n\n NAME\n ----\n-git-relink-script - Some git command not yet documented.\n-\n+git-relink-script - Hardlink common objects in local repositories.\n\n SYNOPSIS\n --------\n-'git-relink-script' [ --option ] <args>...\n+'git-relink-script' [--safe] <dir> <dir> [<dir>]\\*\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n+This will scan 2 or more object repositories and look for common objects, check\n+if they are hardlinked, and replace one with a hardlink to the other if not.\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n+--safe::\n+\tStops if two objects with the same hash exist but have different sizes.\n+\tDefault is to warn and continue.\n\n+<dir>::\n+\tDirectories containing a .git/objects/ subdirectory.\n\n Author\n ------\ndiff --git a/Documentation/git-revert-script.txt b/Documentation/git-revert-script.txt\n--- a/Documentation/git-revert-script.txt\n+++ b/Documentation/git-revert-script.txt\n@@ -3,26 +3,22 @@ git-revert-script(1)\n\n NAME\n ----\n-git-revert-script - Some git command not yet documented.\n-\n+git-revert-script - Revert an existing commit.\n\n SYNOPSIS\n --------\n-'git-revert-script' [ --option ] <args>...\n+'git-revert-script' <commit>\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n+Given one existing commit, revert the change the patch introduces, and record a\n+new commit that records it.  This requires your working tree to be clean (no\n+modifications from the HEAD commit).\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n-\n+<commit>::\n+\tCommit to revert.\n\n Author\n ------\ndiff --git a/Documentation/git-sh-setup-script.txt b/Documentation/git-sh-setup-script.txt\n--- a/Documentation/git-sh-setup-script.txt\n+++ b/Documentation/git-sh-setup-script.txt\n@@ -3,26 +3,22 @@ git-sh-setup-script(1)\n\n NAME\n ----\n-git-sh-setup-script - Some git command not yet documented.\n-\n+git-sh-setup-script - Common git shell script setup code.\n\n SYNOPSIS\n --------\n-'git-sh-setup-script' [ --option ] <args>...\n+'git-sh-setup-script'\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n\n-OPTIONS\n--------\n---option::\n-\tSome option not yet documented.\n+Sets up the normal git environment variables and a few helper functions\n+(currently just \"die()\"), and returns ok if it all looks like a git archive.\n+So use it something like\n\n-<args>...::\n-\tSome argument not yet documented.\n+\t. git-sh-setup-script || die \"Not a git archive\"\n\n+to make the rest of the git scripts more careful and readable.\n\n Author\n ------\ndiff --git a/Documentation/git-verify-tag-script.txt b/Documentation/git-verify-tag-script.txt\n--- a/Documentation/git-verify-tag-script.txt\n+++ b/Documentation/git-verify-tag-script.txt\n@@ -3,26 +3,20 @@ git-verify-tag-script(1)\n\n NAME\n ----\n-git-verify-tag-script - Some git command not yet documented.\n-\n+git-verify-tag-script - Check the GPG signature of tag.\n\n SYNOPSIS\n --------\n-'git-verify-tag-script' [ --option ] <args>...\n+'git-verify-tag-script' <tag>\n\n DESCRIPTION\n -----------\n-Does something not yet documented.\n-\n+Validates the gpg signature created by git-tag-script.\n\n OPTIONS\n -------\n---option::\n-\tSome option not yet documented.\n-\n-<args>...::\n-\tSome argument not yet documented.\n-\n+<tag>::\n+\tSHA1 identifier of a git tag object.\n\n Author\n ------\n"}]}