diff mbox series

Doc: no midx and partial clone relation

Message ID 20211122184114.3328662-1-jonathantanmy@google.com (mailing list archive)
State Accepted
Commit eac9f263ae97812effac01a432dbc91c4778b382
Headers show
Series Doc: no midx and partial clone relation | expand

Commit Message

Jonathan Tan Nov. 22, 2021, 6:41 p.m. UTC
The multi-pack index treats promisor packfiles (that is, packfiles that
have an accompanying .promisor file) the same as other packfiles. Remove
a section in the documentation that seems to indicate otherwise.

Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
---
Stolee, can you check if my understanding is correct?

To my recollection, midx does not treat promisor packfiles specially,
and searching for "promisor" in midx.c seems to support that (the only
results are relating to selection of commits for midx bitmap creation).
---
 Documentation/technical/multi-pack-index.txt | 5 -----
 1 file changed, 5 deletions(-)

Comments

Derrick Stolee Nov. 22, 2021, 7:29 p.m. UTC | #1
On 11/22/2021 1:41 PM, Jonathan Tan wrote:
> The multi-pack index treats promisor packfiles (that is, packfiles that
> have an accompanying .promisor file) the same as other packfiles. Remove
> a section in the documentation that seems to indicate otherwise.
> 
> Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
> ---
> Stolee, can you check if my understanding is correct?
> 
> To my recollection, midx does not treat promisor packfiles specially,
> and searching for "promisor" in midx.c seems to support that (the only
> results are relating to selection of commits for midx bitmap creation).

Yes, you are correct that the promisor packfiles are included in
the multi-pack-index.

> -- The partial clone feature records special "promisor" packs that
> -  may point to objects that are not stored locally, but available
> -  on request to a server. The multi-pack-index does not currently
> -  track these promisor packs.
> -

The intention of this paragraph was probably that the multi-pack-index
file does not track the properties of a pack-file such as whether a
.promisor or .keep file exists. I think one thought was to eventually
let the multi-pack-index track those properties, but there wasn't much
value in it.

Deleting this paragraph is a suitable clarification.

Thanks,
-Stolee
diff mbox series

Patch

diff --git a/Documentation/technical/multi-pack-index.txt b/Documentation/technical/multi-pack-index.txt
index 86f40f2490..fc213cd1e6 100644
--- a/Documentation/technical/multi-pack-index.txt
+++ b/Documentation/technical/multi-pack-index.txt
@@ -87,11 +87,6 @@  Future Work
   helpful to organize packfiles by object type (commit, tree, blob,
   etc.) and use this metadata to help that maintenance.
 
-- The partial clone feature records special "promisor" packs that
-  may point to objects that are not stored locally, but available
-  on request to a server. The multi-pack-index does not currently
-  track these promisor packs.
-
 Related Links
 -------------
 [0] https://bugs.chromium.org/p/git/issues/detail?id=6