summaryrefslogtreecommitdiff
path: root/Documentation/git-ls-tree.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-ls-tree.txt')
-rw-r--r--Documentation/git-ls-tree.txt20
1 files changed, 15 insertions, 5 deletions
diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index 8955b71302..4c7262f1cd 100644
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -9,17 +9,27 @@ git-ls-tree - List the contents of a tree object
SYNOPSIS
--------
[verse]
-'git-ls-tree' [-d] [-r] [-t] [-l] [-z]
+'git ls-tree' [-d] [-r] [-t] [-l] [-z]
[--name-only] [--name-status] [--full-name] [--abbrev=[<n>]]
<tree-ish> [paths...]
DESCRIPTION
-----------
Lists the contents of a given tree object, like what "/bin/ls -a" does
-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.
+in the current working directory. Note that:
+
+ - the behaviour is slightly different from that of "/bin/ls" in that the
+ '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.
+
+ - the behaviour is similar to that of "/bin/ls" in that the 'paths' is
+ taken as relative to the current working directory. E.g. when you are
+ in a directory 'sub' that has a directory 'dir', you can run 'git
+ ls-tree -r HEAD dir' to list the contents of the tree (that is
+ 'sub/dir' in 'HEAD'). You don't want to give a tree that is not at the
+ root level (e.g. 'git ls-tree -r HEAD:sub dir') in this case, as that
+ would result in asking for 'sub/sub/dir' in the 'HEAD' commit.
OPTIONS
-------