From: Damien Robert <email@example.com> To: Junio C Hamano <firstname.lastname@example.org> Cc: email@example.com Subject: Re: [PATCH 1/2] doc: update the documentation of pack-objects and repack Date: Tue, 3 Mar 2020 22:23:02 +0100 Message-ID: <20200303212302.znhumbjo7lywyhvh@doriath> (raw) In-Reply-To: <firstname.lastname@example.org> From Junio C Hamano, Tue 03 Mar 2020 at 10:49:43 (-0800) : > Damien Robert <email@example.com> writes: > > > The problem here is that > > `--keep-true-parents`, `--no-empty`, `--all`, `--reflog`, `--indexed-objects`, > > `--exclude-promisor-objects` > > are always passed and not driven by any options of `git repack`, so I > > did not know where else to put them. > > Ah, I think I may have misread the patch, then. Why do readers who > wanted to learn 'git repack' even need to see what the command does > under the hood, driving what other low-level commands by passing > what options, in the first place? Such implementation details can > change without affecting end-users, no? So do you suggest instead to remove all references to 'git-pack-objects' in 'git-repack'? As I explained in my previous email, if some options reference pack-objects, I think they should all do for consistency. I also think that the situation of git-repack is a bit special: first it is a very thin wrapper around git-pack-objects, so the implementation details are not really abstracted from git-pack-objects. Furthermore it is at an intermediate 'level' between a high level command like 'git gc' and a plumbing command like 'git pack-objects'. So the user interested in 'git repack' is probably interested in some low level details. Now to give an exemple, the doc of git-repack states: This command is used to combine all objects that do not currently reside in a "pack", into a pack. This is a high level overview, but the user who knows a bit about Git internals may wonder what exactly 'all' entails: non local objects, kept objects, promisor objects, unreachable objects? Knowing that the default options passed are: `--keep-true-parents`, `--all`, `--reflog`, `--indexed-objects`, `--exclude-promisor-objects` answers this questions: it is essentially all objects except unreachable ones. Here I think that these technical details are more precise that whatever sentence I could come up with, but I am happy to hear suggestions :) I agree however that `--non-empty` is an implementation detail.
next prev parent reply index Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-02-28 15:43 [PATCH 0/2] Documentation of pack " Damien Robert 2020-02-28 15:43 ` [PATCH 1/2] doc: update the documentation of pack-objects " Damien Robert 2020-03-02 18:57 ` Junio C Hamano 2020-03-03 17:41 ` Damien Robert 2020-03-03 18:49 ` Junio C Hamano 2020-03-03 21:23 ` Damien Robert [this message] 2020-03-03 22:29 ` Junio C Hamano 2020-03-12 17:09 ` [PATCH v2 0/3] Documentation of pack " Damien Robert 2020-03-12 17:09 ` [PATCH v2 1/3] pack-objects: change the name of add_objects_in_unpacked_packs Damien Robert 2020-03-12 17:09 ` [PATCH v2 2/3] doc: update the documentation of pack-objects and repack Damien Robert 2020-03-12 17:09 ` [PATCH v2 3/3] doc: add a short explanation for git-repack options Damien Robert 2020-03-25 22:15 ` [PATCH v2 0/3] Documentation of pack and repack Damien Robert 2020-03-27 22:21 ` Junio C Hamano 2020-02-28 15:43 ` [PATCH 2/2] pack-objects: change the name of add_objects_in_unpacked_packs Damien Robert 2020-02-28 16:01 ` Damien Robert
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 * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200303212302.znhumbjo7lywyhvh@doriath \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ /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
Git Mailing List Archive on lore.kernel.org Archives are clonable: git clone --mirror https://lore.kernel.org/git/0 git/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 git git/ https://lore.kernel.org/git \ email@example.com public-inbox-index git Example config snippet for mirrors Newsgroup available over NNTP: nntp://nntp.lore.kernel.org/org.kernel.vger.git AGPL code for this site: git clone https://public-inbox.org/public-inbox.git