From 5e65dac9c88d02f569cc87cdf630ecb5a780c6a6 Mon Sep 17 00:00:00 2001 From: Martin Ågren Date: Thu, 7 Apr 2022 17:52:31 +0200 Subject: git-ls-tree.txt: fix the name of "%(objectsize:padded)" MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Commit 455923e0a1 ("ls-tree: introduce "--format" option", 2022-03-23) introduced `--format` and the various placeholders it can take, such as %(objectname) and %(objectsize). At some point when that patch was being developed, those placeholders had shorter names, e.g., %(name) and %(size), which can be seen in the commit message of 455923e0a1. One instance of "%(size:padded)" also managed to enter the documentation in the final version of the patch. Correct it to "%(objectsize:padded)". Signed-off-by: Martin Ågren Signed-off-by: Junio C Hamano --- Documentation/git-ls-tree.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-ls-tree.txt') diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt index 43aebb9938..8f31e2ee9d 100644 --- a/Documentation/git-ls-tree.txt +++ b/Documentation/git-ls-tree.txt @@ -156,7 +156,7 @@ objectname:: The name of the object. objectsize[:padded]:: The size of the object ("-" if it's a tree). - It also supports a padded format of size with "%(size:padded)". + It also supports a padded format of size with "%(objectsize:padded)". path:: The pathname of the object. -- cgit v1.3 From acd34fd5f60ab01e871dfa3a3bb8b81828ac181d Mon Sep 17 00:00:00 2001 From: Ævar Arnfjörð Bjarmason Date: Fri, 8 Apr 2022 18:00:25 +0200 Subject: ls-tree doc: document interaction with submodules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Signed-off-by: Junio C Hamano --- Documentation/git-ls-tree.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-ls-tree.txt') diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt index 8f31e2ee9d..0240adb8ee 100644 --- a/Documentation/git-ls-tree.txt +++ b/Documentation/git-ls-tree.txt @@ -151,11 +151,11 @@ names can be used: objectmode:: The mode of the object. objecttype:: - The type of the object (`blob` or `tree`). + The type of the object (`commit`, `blob` or `tree`). objectname:: The name of the object. objectsize[:padded]:: - The size of the object ("-" if it's a tree). + The size of a `blob` object ("-" if it's a `commit` or `tree`). It also supports a padded format of size with "%(objectsize:padded)". path:: The pathname of the object. -- cgit v1.3