{"thread":{"id":"60371","subject":"[PATCH 1/2] doc/git-repack: fix syntax for `-g` shorthand option","startedAt":"2023-10-16T07:19:55Z","lastAt":"2023-10-30T21:52:19Z","messageCount":5,"participants":["Patrick Steinhardt","Taylor Blau"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"483295","messageId":"bee3cfbe359c62cfeb9803917d661fbba54e404b.1697440686.git.ps@pks.im","threadId":"60371","inReplyTo":"cover.1697440686.git.ps@pks.im","subject":"[PATCH 1/2] doc/git-repack: fix syntax for `-g` shorthand option","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2023-10-16T07:19:51Z","receivedAt":"2023-10-16T07:19:55Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"The `-g` switch is a shorthand for `--geometric=` and allows the user to\nspecify the geometric. The documentation is wrong though and indicates\nthat the syntax for the shorthand is `-g=<factor>`. In fact though, the\noption must be specified without the equals sign via `-g<factor>`.\n\nFix the syntax accordingly.\n\nSigned-off-by: Patrick Steinhardt <ps@pks.im>\n---\n Documentation/git-repack.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\nindex 8545a32667..dfd2a59c50 100644\n--- a/Documentation/git-repack.txt\n+++ b/Documentation/git-repack.txt\n@@ -209,7 +209,7 @@ depth is 4095.\n \tPass the `--delta-islands` option to `git-pack-objects`, see\n \tlinkgit:git-pack-objects[1].\n \n--g=<factor>::\n+-g<factor>::\n --geometric=<factor>::\n \tArrange resulting pack structure so that each successive pack\n \tcontains at least `<factor>` times the number of objects as the\n-- \n2.42.0\n\n"},{"id":"483297","messageId":"cover.1697440686.git.ps@pks.im","threadId":"60371","inReplyTo":null,"subject":"[PATCH 0/2] doc/git-repack: small fixes for geometric repacks","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2023-10-16T07:19:46Z","receivedAt":"2023-10-16T07:19:55Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"Hi,\n\nthis small series addresses two issues in our documentation for the\ngit-repack(1) command that relate to geometric repacks.\n\nPatrick\n\nPatrick Steinhardt (2):\n  doc/git-repack: fix syntax for `-g` shorthand option\n  doc/git-repack: don't mention nonexistent \"--unpacked\" option\n\n Documentation/git-repack.txt | 9 +++------\n 1 file changed, 3 insertions(+), 6 deletions(-)\n\n-- \n2.42.0\n\n"},{"id":"483296","messageId":"aa0b4fef4d8397983676394472ff86e468bfc687.1697440686.git.ps@pks.im","threadId":"60371","inReplyTo":"cover.1697440686.git.ps@pks.im","subject":"[PATCH 2/2] doc/git-repack: don't mention nonexistent \"--unpacked\" option","fromName":"Patrick Steinhardt","fromEmail":"ps@pks.im","sentAt":"2023-10-16T07:19:56Z","receivedAt":"2023-10-16T07:20:01Z","isPatch":true,"sender":{"key":"ps@pks.im","avatar":"https://avatars.githubusercontent.com/u/4056630?v=4"},"body":"The documentation for geometric repacking mentions a \"--unpacked\" option\nthat supposedly changes how loose objects are rolled up. This option has\nnever existed, and the implied behaviour, namely to include all unpacked\nobjects into the resulting packfile, is in fact the default behaviour.\n\nCorrect the documentation to not mention this option.\n\nSigned-off-by: Patrick Steinhardt <ps@pks.im>\n---\n Documentation/git-repack.txt | 7 ++-----\n 1 file changed, 2 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\nindex dfd2a59c50..d61078b697 100644\n--- a/Documentation/git-repack.txt\n+++ b/Documentation/git-repack.txt\n@@ -226,11 +226,8 @@ uniquely by the set of packs being \"rolled-up\"; in other words, the\n packs determined to need to be combined in order to restore a geometric\n progression.\n +\n-When `--unpacked` is specified, loose objects are implicitly included in\n-this \"roll-up\", without respect to their reachability. This is subject\n-to change in the future. This option (implying a drastically different\n-repack mode) is not guaranteed to work with all other combinations of\n-option to `git repack`.\n+Loose objects are implicitly included in this \"roll-up\", without respect to\n+their reachability. This is subject to change in the future.\n +\n When writing a multi-pack bitmap, `git repack` selects the largest resulting\n pack as the preferred pack for object selection by the MIDX (see\n-- \n2.42.0\n\n"},{"id":"484156","messageId":"ZUAldFRSj/HLGjOQ@nand.local","threadId":"60371","inReplyTo":"aa0b4fef4d8397983676394472ff86e468bfc687.1697440686.git.ps@pks.im","subject":"Re: [PATCH 2/2] doc/git-repack: don't mention nonexistent \"--unpacked\" option","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2023-10-30T21:51:48Z","receivedAt":"2023-10-30T21:51:52Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Mon, Oct 16, 2023 at 09:19:56AM +0200, Patrick Steinhardt wrote:\n> The documentation for geometric repacking mentions a \"--unpacked\" option\n> that supposedly changes how loose objects are rolled up. This option has\n> never existed, and the implied behaviour, namely to include all unpacked\n> objects into the resulting packfile, is in fact the default behaviour.\n>\n> Correct the documentation to not mention this option.\n>\n> Signed-off-by: Patrick Steinhardt <ps@pks.im>\n> ---\n>  Documentation/git-repack.txt | 7 ++-----\n>  1 file changed, 2 insertions(+), 5 deletions(-)\n>\n> diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\n> index dfd2a59c50..d61078b697 100644\n> --- a/Documentation/git-repack.txt\n> +++ b/Documentation/git-repack.txt\n> @@ -226,11 +226,8 @@ uniquely by the set of packs being \"rolled-up\"; in other words, the\n>  packs determined to need to be combined in order to restore a geometric\n>  progression.\n>  +\n> -When `--unpacked` is specified, loose objects are implicitly included in\n> -this \"roll-up\", without respect to their reachability. This is subject\n> -to change in the future. This option (implying a drastically different\n> -repack mode) is not guaranteed to work with all other combinations of\n> -option to `git repack`.\n> +Loose objects are implicitly included in this \"roll-up\", without respect to\n> +their reachability. This is subject to change in the future.\n>  +\n\nOops. This refers to the \"--unpacked\" option that pack-objects takes,\nnot repack. I agree that mentioning \"--unpacked\" is too low-level a\ndetail for this user-facing documentation, so even something like:\n\n    When `repack` passes `--unpacked` down to `pack-objects` (which is\n    the default) ...\n\nwould be too much detail for this man page.\n\nI am very happy with the patch here as an alternative.\n\nThanks,\nTaylor\n"},{"id":"484157","messageId":"ZUAlkAUU4qSJG0BL@nand.local","threadId":"60371","inReplyTo":"cover.1697440686.git.ps@pks.im","subject":"Re: [PATCH 0/2] doc/git-repack: small fixes for geometric repacks","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2023-10-30T21:52:16Z","receivedAt":"2023-10-30T21:52:19Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Mon, Oct 16, 2023 at 09:19:46AM +0200, Patrick Steinhardt wrote:\n> Patrick Steinhardt (2):\n>   doc/git-repack: fix syntax for `-g` shorthand option\n>   doc/git-repack: don't mention nonexistent \"--unpacked\" option\n>\n>  Documentation/git-repack.txt | 9 +++------\n>  1 file changed, 3 insertions(+), 6 deletions(-)\n\nSorry that this one fell off of my queue. These are both looking good to\nme, thanks for finding and fixing them!\n\nThanks,\nTaylor\n"}]}