ls-tree doc: document interaction with submodules
The ls-tree documentation had never been updated after it learned to interact with submodules to explicitly mention them. The initial support was added in f35a6d3bce7 (Teach core object handling functions about gitlinks, 2007-04-09). E.g. the discussion of --long added in f35a6d3bce7 (Teach core object handling functions about gitlinks, 2007-04-09) didn't explicitly mention them. But this documentation added in 455923e0a15 (ls-tree: introduce "--format" option, 2022-03-23) had no such excuse, and was actively misleading by providing an exhaustive but incomplete list of object types we'd emit. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Apr 8, 2022 at 18:00 UTC
acd34fd5f60ab01e871dfa3a3bb8b81828ac181d
1 file changed
+2
-2
Documentation/git-ls-tree.txt
+2
-2
@@ -151,11 +151,11 @@ names can be used:
151
objectmode::
152
The mode of the object.
153
objecttype::
154
- The type of the object (`blob` or `tree`).
154
+ The type of the object (`commit`, `blob` or `tree`).
155
objectname::
156
The name of the object.
157
objectsize[:padded]::
158
- The size of the object ("-" if it's a tree).
158
+ The size of a `blob` object ("-" if it's a `commit` or `tree`).
159
It also supports a padded format of size with "%(objectsize:padded)".
160
path::
161
The pathname of the object.