{"thread":{"id":"532","subject":"[PATCH 1/2] core-git documentation update","startedAt":"2005-05-08T17:22:45Z","lastAt":"2005-05-08T17:22:45Z","messageCount":1,"participants":["David Greaves"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"2782","messageId":"427E4AE5.3090700@dgreaves.com","threadId":"532","inReplyTo":null,"subject":"[PATCH 1/2] core-git documentation update","fromName":"David Greaves","fromEmail":"david@dgreaves.com","sentAt":"2005-05-08T17:22:45Z","receivedAt":"2005-05-08T17:22:45Z","isPatch":true,"sender":{"key":"david@dgreaves.com","avatar":"https://gravatar.com/avatar/ca67bad50999edcdd137c9a65da2381557d175bea99ae956afdabc5785e42b79?d=mp&s=160"},"body":"Sorts core-git.txt into alphabetical order\n\nSigned-off-by: David Greaves <david@dgreaves.com>\n---\n\n\n\n--- a/Documentation/core-git.txt\n+++ b/Documentation/core-git.txt\n@@ -161,16 +161,16 @@ filenames. Just so that you wouldn't hav\n problems (not possible in the above example, but get used to it in\n scripting!).\n \n-The prefix ability basically makes it trivial to use git-checkout-cache as\n-a \"git-export as tree\" function. Just read the desired tree into the\n-index, and do a\n+The prefix ability basically makes it trivial to use\n+git-checkout-cache as an \"export as tree\" function. Just read the\n+desired tree into the index, and do a\n   \n         git-checkout-cache --prefix=git-export-dir/ -a\n   \n-and git-checkout-cache will \"git-export\" the cache into the specified\n+and git-checkout-cache will \"export\" the cache into the specified\n directory.\n   \n-NOTE! The final \"/\" is important. The git-exported name is literally just\n+NOTE! The final \"/\" is important. The exported name is literally just\n prefixed with the specified string, so you can also do something like\n   \n         git-checkout-cache --prefix=.merged- Makefile\n@@ -351,6 +351,33 @@ special all-zero sha1.\n \n \n ################################################################\n+git-diff-files\n+\tgit-diff-files [-p] [-q] [-r] [-z] [<pattern>...]\n+\n+Compares the files in the working tree and the cache.  When paths\n+are specified, compares only those named paths.  Otherwise all\n+entries in the cache are compared.  The output format is the\n+same as git-diff-cache and git-diff-tree.\n+\n+-p\n+\tgenerate patch (see section on generating patches).\n+\n+-q\n+\tRemain silent even on nonexisting files\n+\n+-r\n+\tThis flag does not mean anything.  It is there only to match\n+\tgit-diff-tree.  Unlike git-diff-tree, git-diff-files always looks\n+\tat all the subdirectories.\n+\n+\n+Output format:\n+\n+See \"Output format from git-diff-cache, git-diff-tree and git-diff-files\"\n+section.\n+\n+\n+################################################################\n git-diff-tree\n \tgit-diff-tree [-p] [-r] [-z] [--stdin] [-m] [-s] [-v] <tree-ish> <tree-ish> [<pattern>]*\n \n@@ -477,6 +504,14 @@ See also the section on generating patch\n \n \n ################################################################\n+git-export\n+\tgit-export top [base]\n+\n+Exports each commit and diff against each of its parents, between\n+top and base.  If base is not specified it exports everything.\n+\n+\n+################################################################\n git-fsck-cache\n \tgit-fsck-cache [--tags] [--root] [[--unreachable] [--cache] <object>*]\n \n@@ -572,11 +607,20 @@ GIT_INDEX_FILE\n \n \n ################################################################\n-git-export\n-\tgit-export top [base]\n+git-http-pull\n \n-Exports each commit and diff against each of its parents, between\n-top and base.  If base is not specified it exports everything.\n+\tgit-http-pull [-c] [-t] [-a] [-v] commit-id url\n+\n+Downloads a remote GIT repository via HTTP protocol.\n+\n+-c\n+\tGet the commit objects.\n+-t\n+\tGet trees associated with the commit objects.\n+-a\n+\tGet all the objects.\n+-v\n+\tReport what is downloaded.\n \n \n ################################################################\n@@ -594,11 +638,11 @@ git-init-db won't hurt an existing repos\n \n \n ################################################################\n-git-http-pull\n+git-local-pull\n \n-\tgit-http-pull [-c] [-t] [-a] [-v] commit-id url\n+\tgit-local-pull [-c] [-t] [-a] [-l] [-s] [-n] [-v] commit-id path\n \n-Downloads a remote GIT repository via HTTP protocol.\n+Downloads another GIT repository on a local system.\n \n -c\n \tGet the commit objects.\n@@ -609,22 +653,80 @@ Downloads a remote GIT repository via HT\n -v\n \tReport what is downloaded.\n \n-\n ################################################################\n-git-local-pull\n+git-ls-files\n+\tgit-ls-files [-z] [-t]\n+\t\t(--[cached|deleted|others|ignored|stage|unmerged])*\n+\t\t(-[c|d|o|i|s|u])*\n+\t\t[-x <pattern>|--exclude=<pattern>]\n+\t\t[-X <file>|--exclude-from=<file>]\n \n-\tgit-local-pull [-c] [-t] [-a] [-l] [-s] [-n] [-v] commit-id path\n+This merges the file listing in the directory cache index with the\n+actual working directory list, and shows different combinations of the\n+two.\n \n-Downloads another GIT repository on a local system.\n+One or more of the options below may be used to determine the files\n+shown:\n+\n+-c|--cached\n+\tShow cached files in the output (default)\n+\n+-d|--deleted\n+\tShow deleted files in the output\n+\n+-o|--others\n+\tShow other files in the output\n+\n+-i|--ignored\n+\tShow ignored files in the output\n+\tNote the this also reverses any exclude list present.\n+\n+-s|--stage\n+\tShow stage files in the output\n+\n+-u|--unmerged\n+\tShow unmerged files in the output (forces --stage)\n+\n+-z\n+\t\\0 line termination on output\n+\n+-x|--exclude=<pattern>\n+\tSkips files matching pattern.\n+\tNote that pattern is a shell wildcard pattern.\n+\n+-X|--exclude-from=<file>\n+\texclude patterns are read from <file>; 1 per line.\n+\tAllows the use of the famous dontdiff file as follows to find\n+\tout about uncommitted files just as dontdiff is used with\n+\tthe diff command:\n+\t     git-ls-files --others --exclude-from=dontdiff\n \n--c\n-\tGet the commit objects.\n -t\n-\tGet trees associated with the commit objects.\n--a\n-\tGet all the objects.\n--v\n-\tReport what is downloaded.\n+\tIdentify the file status with the following tags (followed by\n+\ta space) at the start of each line:\n+\tH\tcached\n+\tM\tunmerged\n+\tR\tremoved/deleted\n+\t?\tother\n+\n+Output\n+show files just outputs the filename unless --stage is specified in\n+which case it outputs:\n+\n+[<tag> ]<mode> <object> <stage> <file>\n+\n+git-ls-files --unmerged\" and \"git-ls-files --stage \" can be used to examine\n+detailed information on unmerged paths.\n+\n+For an unmerged path, instead of recording a single mode/SHA1 pair,\n+the dircache records up to three such pairs; one from tree O in stage\n+1, A in stage 2, and B in stage 3.  This information can be used by\n+the user (or Cogito) to see what should eventually be recorded at the\n+path. (see read-cache for more information on state)\n+\n+see also:\n+read-cache\n+\n \n ################################################################\n git-ls-tree\n@@ -959,33 +1061,6 @@ Helper \"server-side\" program used by git\n \n \n ################################################################\n-git-diff-files\n-\tgit-diff-files [-p] [-q] [-r] [-z] [<pattern>...]\n-\n-Compares the files in the working tree and the cache.  When paths\n-are specified, compares only those named paths.  Otherwise all\n-entries in the cache are compared.  The output format is the\n-same as git-diff-cache and git-diff-tree.\n-\n--p\n-\tgenerate patch (see section on generating patches).\n-\n--q\n-\tRemain silent even on nonexisting files\n-\n--r\n-\tThis flag does not mean anything.  It is there only to match\n-\tgit-diff-tree.  Unlike git-diff-tree, git-diff-files always looks\n-\tat all the subdirectories.\n-\n-\n-Output format:\n-\n-See \"Output format from git-diff-cache, git-diff-tree and git-diff-files\"\n-section.\n-\n-\n-################################################################\n git-tag-script\n \n This is an example script that uses git-mktag to create a tag object\n@@ -1003,81 +1078,6 @@ generated tar archive.\n \n \n ################################################################\n-git-ls-files\n-\tgit-ls-files [-z] [-t]\n-\t\t(--[cached|deleted|others|ignored|stage|unmerged])*\n-\t\t(-[c|d|o|i|s|u])*\n-\t\t[-x <pattern>|--exclude=<pattern>]\n-\t\t[-X <file>|--exclude-from=<file>]\n-\n-This merges the file listing in the directory cache index with the\n-actual working directory list, and shows different combinations of the\n-two.\n-\n-One or more of the options below may be used to determine the files\n-shown:\n-\n--c|--cached\n-\tShow cached files in the output (default)\n-\n--d|--deleted\n-\tShow deleted files in the output\n-\n--o|--others\n-\tShow other files in the output\n-\n--i|--ignored\n-\tShow ignored files in the output\n-\tNote the this also reverses any exclude list present.\n-\n--s|--stage\n-\tShow stage files in the output\n-\n--u|--unmerged\n-\tShow unmerged files in the output (forces --stage)\n-\n--z\n-\t\\0 line termination on output\n-\n--x|--exclude=<pattern>\n-\tSkips files matching pattern.\n-\tNote that pattern is a shell wildcard pattern.\n-\n--X|--exclude-from=<file>\n-\texclude patterns are read from <file>; 1 per line.\n-\tAllows the use of the famous dontdiff file as follows to find\n-\tout about uncommitted files just as dontdiff is used with\n-\tthe diff command:\n-\t     git-ls-files --others --exclude-from=dontdiff\n-\n--t\n-\tIdentify the file status with the following tags (followed by\n-\ta space) at the start of each line:\n-\tH\tcached\n-\tM\tunmerged\n-\tR\tremoved/deleted\n-\t?\tother\n-\n-Output\n-show files just outputs the filename unless --stage is specified in\n-which case it outputs:\n-\n-[<tag> ]<mode> <object> <stage> <file>\n-\n-git-ls-files --unmerged\" and \"git-ls-files --stage \" can be used to examine\n-detailed information on unmerged paths.\n-\n-For an unmerged path, instead of recording a single mode/SHA1 pair,\n-the dircache records up to three such pairs; one from tree O in stage\n-1, A in stage 2, and B in stage 3.  This information can be used by\n-the user (or Cogito) to see what should eventually be recorded at the\n-path. (see read-cache for more information on state)\n-\n-see also:\n-read-cache\n-\n-\n-################################################################\n git-unpack-file\n \tgit-unpack-file <blob>\n \n"}]}