{"thread":{"id":"8616","subject":"[PATCH 00/11] Document missing options","startedAt":"2007-06-16T19:03:36Z","lastAt":"2007-06-16T22:29:51Z","messageCount":14,"participants":["Jakub Narebski","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":11},"messages":[{"id":"45165","messageId":"11820206272990-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":null,"subject":"[PATCH 00/11] Document missing options","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:36Z","receivedAt":"2007-06-16T19:03:36Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"This series of patches documents [some] options which were missing\nfrom the documentation.\n\nTable of contents:\n==================\n [PATCH 01/11] Use tabs for indenting definition list for options in git-log.txt\n [PATCH 02/11] Document git log --full-diff\n [PATCH 03/11] Document git log --abbrev-commit, as a kind of pretty option\n [PATCH 04/11] Document that '--message=' is long version of '-m '\n [PATCH 05/11] Document that '--no-checkout' is long version of '-n' option of git-clone\n [PATCH 06/11] Document git rev-list --timestamp\n [PATCH 07/11] Document git rev-list --full-history\n [PATCH 08/11] Document git rev-parse --is-inside-git-dir\n [PATCH 09/11] Document git read-tree --trivial\n [PATCH 10/11] Document git reflog --stale-fix\n [PATCH 11/11] Document git commit --untracked-files and --verbose\n\nWhat is still undocumented are:\n * git clone --no-separate-remote, which is deprecated and perhaps\n should be left undocumented.\n * git commit -o|--only, which is now default when providing files\n to be committed, and -i|--include is not present. Description\n of this option was removed in commit 6c96753d:\n \"Documentation/git-commit: rewrite to make it more end-user friendly.\"\n Should we re-add this description?\n * git commit --reedit-message (--reedit) and --reuse-message\n (--reuse). I'm not sure what are the meaning of those options, and\n how they differ from -c (or -C --edit) and -C. I think, but I'm not\n sure, that --reedit-message is long form of -c, and --reuse-message\n is long form of -C.\n * git reflog --dry-run. The --dry-run option in other command describe\n what would be done. I think that this option does not work for this\n command.\n\nI have checked only ling options in builtins and shell scripts; I have\nnot checked Perl scripts not short options, and I might have missed\nsome options for which the same named option but for different command\nexists in the documentation.\n\nI might have missed modifying usage strings in command source, and\nin command documentation.\n\nBut I think this series of patches is a good start...\n---\n Documentation/git-clone.txt | 1 +\n Documentation/git-commit.txt | 12 ++++++++++--\n Documentation/git-log.txt | 9 ++++++++-\n Documentation/git-read-tree.txt | 8 +++++++-\n Documentation/git-reflog.txt | 13 +++++++++++++\n Documentation/git-rev-list.txt | 13 +++++++++++++\n Documentation/git-rev-parse.txt | 4 ++++\n Documentation/pretty-options.txt | 9 +++++++++\n builtin-read-tree.c | 2 +-\n 9 files changed, 66 insertions(+), 5 deletions(-)\n\n--\nJakub Narebski\nPoland\n"},{"id":"45166","messageId":"11820206303537-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 01/11] Use tabs for indenting definition list for options in git-log.txt","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:37Z","receivedAt":"2007-06-16T19:03:37Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Signed-off-by: Jakub Narebski \n---\n Documentation/git-log.txt | 2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex 6157edb..c072441 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -52,7 +52,7 @@ include::pretty-options.txt[]\n \tSee also gitlink:git-reflog[1].\n \n --decorate::\n- Print out the ref names of any commits that are shown.\n+\tPrint out the ref names of any commits that are shown.\n \n ...::\n \tShow only commits that affect the specified paths.\n-- \n1.5.2\n"},{"id":"45169","messageId":"11820206312866-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 02/11] Document git log --full-diff","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:38Z","receivedAt":"2007-06-16T19:03:38Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Based on description of commit 477f2b41310c4b1040a9e7f72720b9c39d82caf9\n\"git log --full-diff\" adding this option.\n\nSigned-off-by: Jakub Narebski \n---\n Documentation/git-log.txt | 7 +++++++\n 1 files changed, 7 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex c072441..7adcdef 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -54,6 +54,13 @@ include::pretty-options.txt[]\n --decorate::\n \tPrint out the ref names of any commits that are shown.\n \n+--full-diff::\n+\tWithout this flag, \"git log -p ...\" shows commits that\n+\ttouch the specified paths, and diffs about the same specified\n+\tpaths. With this, the full diff is shown for commits that touch\n+\tthe specified paths; this means that \"...\" limits only\n+\tcommits, and doesn't limit diff for those commits.\n+\n ...::\n \tShow only commits that affect the specified paths.\n \n-- \n1.5.2\n"},{"id":"45167","messageId":"11820206321696-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 03/11] Document git log --abbrev-commit, as a kind of pretty option","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:39Z","receivedAt":"2007-06-16T19:03:39Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Documentation taken from paraphrased description of \"--abbrev[=]\"\ndiff option, and from description of commit 5c51c985 introducing\nthis option.\n\nNote that to change number of digits one must use \"--abbrev=\",\nwhich affects [also] diff output.\n\nSigned-off-by: Jakub Narebski \n---\n Documentation/pretty-options.txt | 9 +++++++++\n 1 files changed, 9 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt\nindex 6338def..746bc5b 100644\n--- a/Documentation/pretty-options.txt\n+++ b/Documentation/pretty-options.txt\n@@ -5,6 +5,15 @@\n \t'full', 'fuller', 'email', 'raw' and 'format:'.\n \tWhen left out the format default to 'medium'.\n \n+--abbrev-commit::\n+\tInstead of showing the full 40-byte hexadecimal commit object\n+\tname, show only handful hexdigits prefix. Non default number of\n+\tdigits can be specified with \"--abbrev=\" (which also modifies\n+\tdiff output, if it is displayed).\n++\n+This should make \"--pretty=oneline\" a whole lot more readable for\n+people using 80-column terminals.\n+\n --encoding[=]::\n \tThe commit objects record the encoding used for the log message\n \tin their encoding header; this option can be used to tell the\n-- \n1.5.2\n"},{"id":"45168","messageId":"1182020633805-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 04/11] Document that '--message=' is long version of '-m '","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:40Z","receivedAt":"2007-06-16T19:03:40Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Signed-off-by: Jakub Narebski \n---\n Documentation/git-commit.txt | 2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex 53a7bb0..352a494 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -71,7 +71,7 @@ OPTIONS\n \tOverride the author name used in the commit. Use\n \t`A U Thor ` format.\n \n--m ::\n+-m |--message=::\n \tUse the given as the commit message.\n \n -s|--signoff::\n-- \n1.5.2\n"},{"id":"45173","messageId":"11820206332182-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 05/11] Document that '--no-checkout' is long version of '-n' option of git-clone","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:41Z","receivedAt":"2007-06-16T19:03:41Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Signed-off-by: Jakub Narebski \n---\n Documentation/git-clone.txt | 1 +\n 1 files changed, 1 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex 4a5bab5..796cbba 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -64,6 +64,7 @@ OPTIONS\n \tOperate quietly. This flag is passed to \"rsync\" and\n \t\"git-fetch-pack\" commands when given.\n \n+--no-checkout::\n -n::\n \tNo checkout of HEAD is performed after the clone is complete.\n \n-- \n1.5.2\n"},{"id":"45176","messageId":"1182020634624-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 06/11] Document git rev-list --timestamp","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:42Z","receivedAt":"2007-06-16T19:03:42Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Note that git log does not understand this option yet:\n\n $ git log --timestamp\n fatal: unrecognized argument: --timestamp\n\nSigned-off-by: Jakub Narebski \n---\n Documentation/git-rev-list.txt | 4 ++++\n 1 files changed, 4 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt\nindex 0dba73f..f5e5786 100644\n--- a/Documentation/git-rev-list.txt\n+++ b/Documentation/git-rev-list.txt\n@@ -21,6 +21,7 @@ SYNOPSIS\n \t [ \\--stdin ]\n \t [ \\--topo-order ]\n \t [ \\--parents ]\n+\t [ \\--timestamp ]\n \t [ \\--left-right ]\n \t [ \\--cherry-pick ]\n \t [ \\--encoding[=] ]\n@@ -116,6 +117,9 @@ e.g. \"2 hours ago\".\n \n \tPrint the parents of the commit.\n \n+--timestamp::\n+\tPrint the raw commit timestamp.\n+\n --left-right::\n \n \tMark which side of a symmetric diff a commit is reachable from.\n-- \n1.5.2\n"},{"id":"45170","messageId":"11820206343380-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 07/11] Document git rev-list --full-history","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:43Z","receivedAt":"2007-06-16T19:03:43Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Signed-off-by: Jakub Narebski \n---\n Documentation/git-rev-list.txt | 9 +++++++++\n 1 files changed, 9 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt\nindex f5e5786..32cb13f 100644\n--- a/Documentation/git-rev-list.txt\n+++ b/Documentation/git-rev-list.txt\n@@ -16,6 +16,7 @@ SYNOPSIS\n \t [ \\--sparse ]\n \t [ \\--no-merges ]\n \t [ \\--remove-empty ]\n+\t [ \\--full-history ]\n \t [ \\--not ]\n \t [ \\--all ]\n \t [ \\--stdin ]\n@@ -232,6 +233,14 @@ limiting may be applied.\n \n \tStop when a given path disappears from the tree.\n \n+--full-history::\n+\n+\tShow also parts of history irrelevant to current state of a given\n+\tpath. This turns off history simplification, which removed merges\n+\twhich didn't change anything at all at some child. It will still actually\n+\tsimplify away merges that didn't change anything at all into either\n+\tchild.\n+\n --no-merges::\n \n \tDo not print commits with more than one parent.\n-- \n1.5.2\n"},{"id":"45174","messageId":"11820206351723-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 08/11] Document git rev-parse --is-inside-git-dir","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:44Z","receivedAt":"2007-06-16T19:03:44Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Signed-off-by: Jakub Narebski \n---\n Documentation/git-rev-parse.txt | 4 ++++\n 1 files changed, 4 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt\nindex e1cb4ef..87771b8 100644\n--- a/Documentation/git-rev-parse.txt\n+++ b/Documentation/git-rev-parse.txt\n@@ -89,6 +89,10 @@ OPTIONS\n --git-dir::\n \tShow `$GIT_DIR` if defined else show the path to the .git directory.\n \n+--is-inside-git-dir::\n+\tReturn \"true\" if we are in the git directory, otherwise \"false\".\n+\tSome commands require to be run in a working directory.\n+\n --short, --short=number::\n \tInstead of outputting the full SHA1 values of object names try to\n \tabbreviate them to a shorter unique name. When no length is specified\n-- \n1.5.2\n"},{"id":"45172","messageId":"1182020635187-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 09/11] Document git read-tree --trivial","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:45Z","receivedAt":"2007-06-16T19:03:45Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Signed-off-by: Jakub Narebski \n---\n Documentation/git-read-tree.txt | 8 +++++++-\n builtin-read-tree.c | 2 +-\n 2 files changed, 8 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt\nindex 84184d6..74c5478 100644\n--- a/Documentation/git-read-tree.txt\n+++ b/Documentation/git-read-tree.txt\n@@ -8,7 +8,7 @@ git-read-tree - Reads tree information into the index\n \n SYNOPSIS\n --------\n-'git-read-tree' ( | [[-m [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [--index-output=] [ []])\n+'git-read-tree' ( | [[-m [--trivial] [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [--index-output=] [ []])\n \n \n DESCRIPTION\n@@ -50,6 +50,12 @@ OPTIONS\n \ttrees that are not directly related to the current\n \tworking tree status into a temporary index file.\n \n+--trivial::\n+\tRestrict three-way merge by `git-read-tree` to happen\n+\tonly if there is no file-level merging required, instead\n+\tof resolving merge for trivial cases and leaving\n+\tconflicting files unresolved in the index.\n+\n --aggressive::\n \tUsually a three-way merge by `git-read-tree` resolves\n \tthe merge for really trivial cases and leaves other\ndiff --git a/builtin-read-tree.c b/builtin-read-tree.c\nindex 316fb0f..41f8110 100644\n--- a/builtin-read-tree.c\n+++ b/builtin-read-tree.c\n@@ -84,7 +84,7 @@ static void prime_cache_tree(void)\n \n }\n \n-static const char read_tree_usage[] = \"git-read-tree ( | [[-m [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [--index-output=] [ []])\";\n+static const char read_tree_usage[] = \"git-read-tree ( | [[-m [--trivial] [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [--index-output=] [ []])\";\n \n static struct lock_file lock_file;\n \n-- \n1.5.2\n"},{"id":"45175","messageId":"1182020635891-git-send-email-jnareb@gmail.com","threadId":"8616","inReplyTo":"11820206272990-git-send-email-jnareb@gmail.com","subject":"[PATCH 10/11] Document git reflog --stale-fix","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2007-06-16T19:03:46Z","receivedAt":"2007-06-16T19:03:46Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Document --stale-fix, used in \"git reflog expire --stale-fix --all\"\nto remove invalid reflog entries, to fix situation after running\nnon reflog-aware git-prune from an older git in the presence of\nreflogs (see RelNotes-1.5.0.txt).\n\nBased on description of commit 1389d9ddaa68a4cbf5018d88f971b9bbb7aaa3c9\n \"reflog expire --fix-stale\"\nwhich introduced this option.\n\nSigned-off-by: Jakub Narebski \n---\n Documentation/git-reflog.txt | 13 +++++++++++++\n 1 files changed, 13 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt\nindex f717e1e..89bc9c5 100644\n--- a/Documentation/git-reflog.txt\n+++ b/Documentation/git-reflog.txt\n@@ -39,6 +39,19 @@ the current branch. It is basically an alias for 'git log -g --abbrev-commit\n OPTIONS\n -------\n \n+--stale-fix::\n+\tThis revamps the logic -- the definition of \"broken commit\"\n+\tbecomes: a commit that is not reachable from any of the refs and\n+\tthere is a missing object among the commit, tree, or blob\n+\tobjects reachable from it that is not reachable from any of the\n+\trefs.\n++\n+This computation involves traversing all the reachable objects, i.e. it\n+has the same cost as 'git prune'. Fortunately, once this is run, we\n+should not have to ever worry about missing objects, because the current\n+prune and pack-objects know about reflogs and protect objects referred by\n+them.\n+\n --expire=