Browse Source

Update the git-ls-tree documentation

This patch aims to freshen up a bit the git-ls-tree documentation. It hints
that the list of paths are in fact patterns to be matched, explains the new
-t, --name-only and --name-status options, corrects the original autorship
information to refer to yours sincerely, corrects several grammar mistakes,
etc.

Since the documentation still deserves some significant work (at least
proper description of the pattern matching), I also added the stub notice.

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Petr Baudis 20 years ago committed by Junio C Hamano
parent
commit
7b9b4c452c
  1. 43
      Documentation/git-ls-tree.txt

43
Documentation/git-ls-tree.txt

@ -8,12 +8,15 @@ git-ls-tree - Lists the contents of a tree object.


SYNOPSIS SYNOPSIS
-------- --------
'git-ls-tree' [-d] [-r] [-z] <tree-ish> [paths...] 'git-ls-tree' [-d] [-r] [-t] [-z] [--name-only] [--name-status] <tree-ish> [paths...]


DESCRIPTION DESCRIPTION
----------- -----------
Lists the contents of a tree object, like what "/bin/ls -a" does Lists the contents of a given tree object, like what "/bin/ls -a" does
in the current working directory. in the current working directory. Note that the usage is subtly different,
though - 'paths' denote just a list of patterns to match, e.g. so specifying
directory name (without '-r') will behave differently, and order of the
arguments does not matter.


OPTIONS OPTIONS
------- -------
@ -21,36 +24,48 @@ OPTIONS
Id of a tree-ish. Id of a tree-ish.


-d:: -d::
show only the named tree entry itself, not its children Show only the named tree entry itself, not its children.


-r:: -r::
recurse into sub-trees Recurse into sub-trees.

-t::
Show tree entries even when going to recurse them. Has no effect
if '-r' was not passed. '-d' implies '-t'.


-z:: -z::
\0 line termination on output \0 line termination on output.

--name-only::
--name-status::
List only filenames (instead of the "long" output), one per line.


paths:: paths::
When paths are given, show them. Otherwise implicitly When paths are given, show them (note that this isn't really raw
uses the root level of the tree as the sole path argument. pathnames, but rather a list of patterns to match). Otherwise
implicitly uses the root level of the tree as the sole path argument.




Output Format Output Format
------------- -------------
<mode> SP <type> SP <object> TAB <file> <mode> SP <type> SP <object> TAB <file>


When `-z` option is not used, TAB, LF, and backslash characters When the `-z` option is not used, TAB, LF, and backslash characters
in pathnames are represented as `\t`, `\n`, and `\\`, in pathnames are represented as `\t`, `\n`, and `\\`, respectively.
respectively.




Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org> Written by Petr Baudis <pasky@suse.cz>
Completely rewritten from scratch by Junio C Hamano <junkio@cox.net> Completely rewritten from scratch by Junio C Hamano <junkio@cox.net>,
another major rewrite by Linus Torvalds <torvalds@osdl.org>


Documentation Documentation
-------------- --------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. Documentation by David Greaves, Junio C Hamano and the git-list
<git@vger.kernel.org>.

This manual page is a stub. You can help the git documentation by expanding it.


GIT GIT
--- ---

Loading…
Cancel
Save