{"thread":{"id":"57524","subject":"[PATCH] repack: Sync list of options between synopsis and description in the documentation","startedAt":"2022-03-09T12:35:16Z","lastAt":"2022-03-09T13:17:26Z","messageCount":2,"participants":["Bagas Sanjaya","Shaoxuan Yuan"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"450835","messageId":"20220309123447.852883-1-bagasdotme@gmail.com","threadId":"57524","inReplyTo":null,"subject":"[PATCH] repack: Sync list of options between synopsis and description in the documentation","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2022-03-09T12:34:47Z","receivedAt":"2022-03-09T12:35:16Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"Options list in the synopsis and description section of git-repack(1)\nare out of sync. The latest addition was in commit 1d89d88d37\n(builtin/repack.c: support writing a MIDX while repacking, 2021-09-28),\nwhich only adds -m/--write-midx option.\n\nAdd missing options to the synopsis. Additionaly, sort according to the\norder they appear in the description.\n\nSigned-off-by: Bagas Sanjaya <bagasdotme@gmail.com>\n---\n Documentation/git-repack.txt | 8 +++++++-\n 1 file changed, 7 insertions(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\nindex ee30edc178..26e997bde1 100644\n--- a/Documentation/git-repack.txt\n+++ b/Documentation/git-repack.txt\n@@ -9,7 +9,13 @@ git-repack - Pack unpacked objects in a repository\n SYNOPSIS\n --------\n [verse]\n-'git repack' [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [-b] [-m] [--window=<n>] [--depth=<n>] [--threads=<n>] [--keep-pack=<pack-name>] [--write-midx]\n+'git repack' [-a] [-A] [-d] [-l] [-f] [-F] [-q | --quiet] [-n] [--window=<n>]\n+\t     [--depth=<n>] [--threads=<n>] [--window-memory=<n>]\n+\t     [--max-pack-size=<n>] [-b | --write-bitmap-index]\n+\t     [--pack-kept-objects] [--keep-pack=<pack-name>]\n+\t     [--unpack-unreachable=<when>] [-k | --keep-unreachable]\n+\t     [-i | --delta-islands] [-g | --geometric <factor>]\n+\t     [-m | --write-midx]\n \n DESCRIPTION\n -----------\n\nbase-commit: c2162907e9aa884bdb70208389cb99b181620d51\n-- \nAn old man doll... just what I always wanted! - Clara\n\n"},{"id":"450838","messageId":"CAJyCBORGGbn6d5UYMdRnfrbn9OONcgMMxaCyJ4qUoQY3+s8-uQ@mail.gmail.com","threadId":"57524","inReplyTo":"20220309123447.852883-1-bagasdotme@gmail.com","subject":"Re: [PATCH] repack: Sync list of options between synopsis and description in the documentation","fromName":"Shaoxuan Yuan","fromEmail":"shaoxuan.yuan02@gmail.com","sentAt":"2022-03-09T13:17:09Z","receivedAt":"2022-03-09T13:17:26Z","isPatch":true,"sender":{"key":"shaoxuan.yuan02@gmail.com","avatar":"https://avatars.githubusercontent.com/u/46557895?v=4"},"body":"On Wed, Mar 9, 2022 at 9:01 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:\n>\n> Options list in the synopsis and description section of git-repack(1)\n> are out of sync. The latest addition was in commit 1d89d88d37\n> (builtin/repack.c: support writing a MIDX while repacking, 2021-09-28),\n> which only adds -m/--write-midx option.\n>\n> Add missing options to the synopsis. Additionaly, sort according to the\n> order they appear in the description.\n>\n> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>\n> ---\n>  Documentation/git-repack.txt | 8 +++++++-\n>  1 file changed, 7 insertions(+), 1 deletion(-)\n>\n> diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\n> index ee30edc178..26e997bde1 100644\n> --- a/Documentation/git-repack.txt\n> +++ b/Documentation/git-repack.txt\n> @@ -9,7 +9,13 @@ git-repack - Pack unpacked objects in a repository\n>  SYNOPSIS\n>  --------\n>  [verse]\n> -'git repack' [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [-b] [-m] [--window=<n>] [--depth=<n>] [--threads=<n>] [--keep-pack=<pack-name>] [--write-midx]\n> +'git repack' [-a] [-A] [-d] [-l] [-f] [-F] [-q | --quiet] [-n] [--window=<n>]\n> +            [--depth=<n>] [--threads=<n>] [--window-memory=<n>]\n> +            [--max-pack-size=<n>] [-b | --write-bitmap-index]\n> +            [--pack-kept-objects] [--keep-pack=<pack-name>]\n> +            [--unpack-unreachable=<when>] [-k | --keep-unreachable]\n> +            [-i | --delta-islands] [-g | --geometric <factor>]\n> +            [-m | --write-midx]\n\nCould we possibly just shorten the synopsis to something like this?\n\n\"git repack [<options>]\"\n\nAs Junio mentioned here [1], this could be a more \"modern\" style?\nSince the OPTIONS chunk below gives a more detailed usage, I\nthink we can get rid of the redundancy in the SYNOPSIS. And it also\nhelps with the aesthetic and clarity.\n\n[1]: https://lore.kernel.org/git/xmqq1r0awse5.fsf@gitster.g/\n-- \nThanks & Regards,\nShaoxuan\n"}]}