Re: [PATCH v3] rev-list: support human-readable output for `--disk-usage`
- From
Johannes Sixt <j6t@kdbg.org>
- Date
- Aug 10, 2022, 07:18 UTC
- Message-ID
- <4e54c11d-d01d-7777-89e7-8799180c2931@kdbg.org>
- In-Reply-To
- <pull.1313.v3.git.1660111276934.gitgitgadget@gmail.com>
Am 10.08.22 um 08:01 schrieb Li Linchao via GitGitGadget:
Show 10 quoted lines
> --disk-usage:: > +--disk-usage=human:: > Suppress normal output; instead, print the sum of the bytes used > - for on-disk storage by the selected commits or objects. This is > + for on-disk storage by the selected commits or objects. > + When it accepts a value `human`, like: `--disk-usage=human`, this > + means to print objects size in human readable format. This is > equivalent to piping the output into `git cat-file > --batch-check='%(objectsize:disk)'`, except that it runs much > faster (especially with `--use-bitmap-index`). See the `CAVEATS`
The original paragraph flows very well and explains what the option does and how it computes the result. Please do not interrupt the flow of the text with a whole sentence that should be just a parenthetical remark, but add a sentence at the end, not in the middle.
You added a new feature, and I understand that it is important *to you*. But do make it a habit to ask yourself if it is also important for the general audience. Generally, a new feature is not as important as existing features, otherwise, it would have been added earlier, wouldn't it?
-- Hannes