From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>,
Taylor Blau <me@ttaylorr.com>,
Derrick Stolee <derrickstolee@github.com>
Subject: Re: [PATCH] Documentation: simplify synopsis of git-repack(1)
Date: Tue, 22 Mar 2022 14:11:53 +0700 [thread overview]
Message-ID: <93d4b801-491c-694e-704c-fbe68f90b660@gmail.com> (raw)
In-Reply-To: <xmqqsfrlvfs8.fsf@gitster.g>
On 14/03/22 02.00, Junio C Hamano wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>
>> Simplify SYNOPSIS section to only mention [<options>...] placeholder.
>> Redundant options list can now be avoided for aesthetic and clarity.
>
> The "git cmd --help" output is meant to be readable and useful, so
> clarity is good, but I do not know much about aesthetics.
>
Sorry for the long delay. I wish I could just say "for the clarity"
here.
> More importantly, the above does not answer a lot more important
> question. Is it just loss of duplicated information that this
> commit brings in? Isn't the motivation that "not all options are
> listed in SYNOPSIS section, and/or some options listed there are not
> described in the body text and are not supported"? And instead of
> trying to keep them in sync, the author chose to simplify SYNOPSIS
> and have readers look options up in the body text, no? These two
> would make a good pair of "what problem do we solve?" and "how we
> choose to solve it?".
>
Indeed not all options are listed in SYNOPSIS, and in my previous attempt
at [1], I followed suggestion from Shaoxuan.
>> [verse]
>> -'git repack' [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [-b] [-m] [--window=<n>] [--depth=<n>] [--threads=<n>] [--keep-pack=<pack-name>] [--write-midx]
>> +'git repack' [<options>...]
>
> Unlike commands with multiple "operation modes", "repack" does one
> thing and only one thing, so a single-liner "git repack <options>"
> may work well.
OK.
[1]: https://lore.kernel.org/git/CAJyCBORGGbn6d5UYMdRnfrbn9OONcgMMxaCyJ4qUoQY3+s8-uQ@mail.gmail.com/
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-03-22 7:14 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-12 11:31 [PATCH] Documentation: simplify synopsis of git-repack(1) Bagas Sanjaya
2022-03-13 19:00 ` Junio C Hamano
2022-03-22 7:11 ` Bagas Sanjaya [this message]
2022-03-22 9:16 ` Shaoxuan Yuan
2022-03-22 12:52 ` Ævar Arnfjörð Bjarmason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=93d4b801-491c-694e-704c-fbe68f90b660@gmail.com \
--to=bagasdotme@gmail.com \
--cc=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.com \
--cc=shaoxuan.yuan02@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).