[PATCH RFC v2 25/25] cat-file: update of docs
- From
Olga Telezhnaya <olyatelezhnaya@gmail.com>
- Date
- Feb 5, 2018, 11:27 UTC
- Message-ID
- <0102016165b8b47f-c7aaef74-cbf3-45eb-b1d3-a8f94f814a84-000000@eu-west-1.amazonses.com>
- In-Reply-To
- <0102016165b8b3c4-54efe4c4-6d19-435d-b5b9-6c727771353b-000000@eu-west-1.amazonses.com>
Update the docs for cat-file command. Some new formatting atoms added because of reusing ref-filter code. We do not support cat-file atoms in general formatting logic (there is just the support for cat-file), that is why some of the atoms are still explained in cat-file docs. We need to move these explanations when atoms will be supported by other commands.
Signed-off-by: Olga Telezhnaia <olyatelezhnaya@gmail.com> Mentored-by: Christian Couder <christian.couder@gmail.com> Mentored by: Jeff King <peff@peff.net> --- Documentation/git-cat-file.txt | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-)
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index f90f09b03fae5..90639ac21d0e8 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -187,17 +187,8 @@ linkgit:git-rev-parse[1]. You can specify the information shown for each object by using a custom `<format>`. The `<format>` is copied literally to stdout for each object, with placeholders of the form `%(atom)` expanded, followed by a -newline. The available atoms are: - -`objectname`:: - The 40-hex object name of the object. - -`objecttype`:: - The type of the object (the same as `cat-file -t` reports). - -`objectsize`:: - The size, in bytes, of the object (the same as `cat-file -s` - reports). +newline. The available atoms are the same as that of +linkgit:git-for-each-ref[1], but there are some additional ones: `objectsize:disk`:: The size, in bytes, that the object takes up on disk. See the -- https://github.com/git/git/pull/452