{"thread":{"id":"2746","subject":"[PATCH] Update the git-ls-tree documentation","startedAt":"2005-12-04T23:31:08Z","lastAt":"2005-12-04T23:31:08Z","messageCount":1,"participants":["Petr Baudis"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"13187","messageId":"20051204233108.6730.28024.stgit@machine.or.cz","threadId":"2746","inReplyTo":null,"subject":"[PATCH] Update the git-ls-tree documentation","fromName":"Petr Baudis","fromEmail":"pasky@suse.cz","sentAt":"2005-12-04T23:31:08Z","receivedAt":"2005-12-04T23:31:08Z","isPatch":true,"sender":{"key":"pasky@ucw.cz","avatar":"https://avatars.githubusercontent.com/u/18439?v=4"},"body":"This patch aims to freshen up a bit the git-ls-tree documentation. It hints\nthat the list of paths are in fact patterns to be matched, explains the new\n-t, --name-only and --name-status options, corrects the original autorship\ninformation to refer to yours sincerely, corrects several grammar mistakes,\netc.\n\nSince the documentation still deserves some significant work (at least\nproper description of the pattern matching), I also added the stub notice.\n\nSigned-off-by: Petr Baudis <pasky@suse.cz>\n---\n\n Documentation/git-ls-tree.txt |   43 ++++++++++++++++++++++++++++-------------\n 1 files changed, 29 insertions(+), 14 deletions(-)\n\ndiff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt\nindex ba0438e..b92a8b2 100644\n--- a/Documentation/git-ls-tree.txt\n+++ b/Documentation/git-ls-tree.txt\n@@ -8,12 +8,15 @@ git-ls-tree - Lists the contents of a tr\n \n SYNOPSIS\n --------\n-'git-ls-tree' [-d] [-r] [-z] <tree-ish> [paths...]\n+'git-ls-tree' [-d] [-r] [-t] [-z] [--name-only] [--name-status] <tree-ish> [paths...]\n \n DESCRIPTION\n -----------\n-Lists the contents of a tree object, like what \"/bin/ls -a\" does\n-in the current working directory.\n+Lists the contents of a given tree object, like what \"/bin/ls -a\" does\n+in the current working directory. Note that the usage is subtly different,\n+though - 'paths' denote just a list of patterns to match, e.g. so specifying\n+directory name (without '-r') will behave differently, and order of the\n+arguments does not matter.\n \n OPTIONS\n -------\n@@ -21,36 +24,48 @@ OPTIONS\n \tId of a tree-ish.\n \n -d::\n-\tshow only the named tree entry itself, not its children\n+\tShow only the named tree entry itself, not its children.\n \n -r::\n-\trecurse into sub-trees\n+\tRecurse into sub-trees.\n+\n+-t::\n+\tShow tree entries even when going to recurse them. Has no effect\n+\tif '-r' was not passed. '-d' implies '-t'.\n \n -z::\n-\t\\0 line termination on output\n+\t\\0 line termination on output.\n+\n+--name-only::\n+--name-status::\n+\tList only filenames (instead of the \"long\" output), one per line.\n \n paths::\n-\tWhen paths are given, show them.  Otherwise implicitly\n-\tuses the root level of the tree as the sole path argument.\n+\tWhen paths are given, show them (note that this isn't really raw\n+\tpathnames, but rather a list of patterns to match).  Otherwise\n+\timplicitly uses the root level of the tree as the sole path argument.\n \n \n Output Format\n -------------\n         <mode> SP <type> SP <object> TAB <file>\n \n-When `-z` option is not used, TAB, LF, and backslash characters\n-in pathnames are represented as `\\t`, `\\n`, and `\\\\`,\n-respectively.\n+When the `-z` option is not used, TAB, LF, and backslash characters\n+in pathnames are represented as `\\t`, `\\n`, and `\\\\`, respectively.\n \n \n Author\n ------\n-Written by Linus Torvalds <torvalds@osdl.org>\n-Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>\n+Written by Petr Baudis <pasky@suse.cz>\n+Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>,\n+another major rewrite by Linus Torvalds <torvalds@osdl.org>\n \n Documentation\n --------------\n-Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.\n+Documentation by David Greaves, Junio C Hamano and the git-list\n+<git@vger.kernel.org>.\n+\n+This manual page is a stub. You can help the git documentation by expanding it.\n \n GIT\n ---\n"}]}