[PATCH] Rewrite ls-tree to behave more like "/bin/ls -a"

[git.git] / Documentation / git-ls-tree.txt

diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index a113c35..958b56d 100644 (file)
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -4,23 +4,26 @@ v0.1, May 2005
 
 NAME
 ----
-git-ls-tree - Displays a tree object in human readable form
+git-ls-tree - Lists the contents of a tree object.
 
 
 SYNOPSIS
 --------
-'git-ls-tree' [-r] [-z] <tree-ish> [paths...]
+'git-ls-tree' [-d] [-r] [-z] <tree-ish> [paths...]
 
 DESCRIPTION
 -----------
-Converts the tree object to a human readable (and script processable)
-form.
+Lists the contents of a tree object, like what "/bin/ls -a" does
+in the current working directory.
 
 OPTIONS
 -------
 <tree-ish>::
        Id of a tree.
 
+-d::
+       show only the named tree entry itself, not its children
+
 -r::
        recurse into sub-trees
 
@@ -28,18 +31,19 @@ OPTIONS
        \0 line termination on output
 
 paths::
-       Optionally, restrict the output of git-ls-tree to specific
-       paths. Directories will only list their tree blob ids.
-       Implies -r.
+       When paths are given, shows them.  Otherwise implicitly
+       uses the root level of the tree as the sole path argument.
+
 
 Output Format
 -------------
-        <mode>\t       <type>\t        <object>\t      <file>
+        <mode> SP <type> SP <object> TAB <file>
 
 
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
+Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>
 
 Documentation
 --------------