diff options
author | Junio C Hamano <gitster@pobox.com> | 2008-07-28 02:33:33 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2008-07-28 23:01:57 -0700 |
commit | 7ddea13af24d72deca06a779b1827a8ea2d6cfe6 (patch) | |
tree | f650adc427a519e7c14fdbf6286e17116de4808d /Documentation | |
parent | Allow installing in the traditional way (diff) | |
download | tgif-7ddea13af24d72deca06a779b1827a8ea2d6cfe6.tar.xz |
ls-tree documentation: enhance notes on subdirectory and pathspec behaviour
When run in a working copy subdirectory, git-ls-tree will automagically
add the prefix to the pathspec, which can result in an unexpected behavior
when the tree object accessed is not the root tree object.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-ls-tree.txt | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt index d7e73f568d..4c7262f1cd 100644 --- a/Documentation/git-ls-tree.txt +++ b/Documentation/git-ls-tree.txt @@ -16,10 +16,20 @@ SYNOPSIS 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 ------- |