[PATCH] Optimize the description of the configuration in packfile-uris doc

[PATCH] Optimize the description of the configuration in packfile-uris doc

[Teng Long]

There is a description problem in the document about packfile-uris. This
patch describes the configuration format of `uploadpack.blobPackfileUri`
more accurately.

Signed-off-by: Teng Long <dyroneteng@gmail.com>
---
 Documentation/technical/packfile-uri.txt | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/Documentation/technical/packfile-uri.txt b/Documentation/technical/packfile-uri.txt
index f7eabc6c76..1eb525fe76 100644
--- a/Documentation/technical/packfile-uri.txt
+++ b/Documentation/technical/packfile-uri.txt
@@ -35,13 +35,14 @@ include some sort of non-trivial implementation in the Minimum Viable Product,
 at least so that we can test the client.
 
 This is the implementation: a feature, marked experimental, that allows the
-server to be configured by one or more `uploadpack.blobPackfileUri=<sha1>
-<uri>` entries. Whenever the list of objects to be sent is assembled, all such
-blobs are excluded, replaced with URIs. As noted in "Future work" below, the
-server can evolve in the future to support excluding other objects (or other
-implementations of servers could be made that support excluding other objects)
-without needing a protocol change, so clients should not expect that packfiles
-downloaded in this way only contain single blobs.
+server to be configured by one or more `uploadpack.blobPackfileUri=
+<object-hash> <pack-hash> <uri>` entries. Whenever the list of objects to be
+sent is assembled, all such blobs are excluded, replaced with URIs. As noted
+in "Future work" below, the server can evolve in the future to support
+excluding other objects (or other implementations of servers could be made
+that support excluding other objects) without needing a protocol change, so
+clients should not expect that packfiles downloaded in this way only contain
+single blobs.
 
 Client design
 -------------
-- 
2.31.1

Re: [PATCH] Optimize the description of the configuration in packfile-uris doc

[Jonathan Tan]

> There is a description problem in the document about packfile-uris. This
> patch describes the configuration format of `uploadpack.blobPackfileUri`
> more accurately.

Thanks for noticing this. The diff itself is correct, of course.

As for the commit message, limit the title to 50 characters or fewer if
possible. Maybe something like "packfile-uri.txt: fix blobPackfileUri
description" or something like that.

Also in the commit message, maybe mention that the correct format can be
seen in t5702.

Re: [PATCH] Optimize the description of the configuration in packfile-uris doc

[Junio C Hamano]

Jonathan Tan <jonathantanmy@google.com> writes:

>> There is a description problem in the document about packfile-uris. This
>> patch describes the configuration format of `uploadpack.blobPackfileUri`
>> more accurately.
>
> Thanks for noticing this. The diff itself is correct, of course.
>
> As for the commit message, limit the title to 50 characters or fewer if
> possible. Maybe something like "packfile-uri.txt: fix blobPackfileUri
> description" or something like that.
>
> Also in the commit message, maybe mention that the correct format can be
> seen in t5702.

Thanks for giving a review with clear suggestion for improvements,
Jonathan.  And thanks for contributing, Teng.

Will look forward to seeing an updated patch.

Re: [PATCH] Optimize the description of the configuration in packfile-uris doc

[Teng Long]

Jonathan Tan <jonathantanmy@google.com> writes:

>As for the commit message, limit the title to 50 characters or fewer if
>possible. Maybe something like "packfile-uri.txt: fix blobPackfileUri
>description" or something like that.

Thanks for mention this, "packfile-uri.txt: fix blobPackfileUri
description" is good and meets the "50 characters" requirement.

So, you are right and the title will be changed in the next patch.

>Also in the commit message, maybe mention that the correct format can be
>seen in t5702.

Because I am implementing another patch[1] about supporting the commit
object in packfile-uri, so I noticed the `configure_exclusion` function in
t5702.

Agree and will include it in the next patch.

Thanks.

[1] https://public-inbox.org/git/20210507021140.31372-1-dyroneteng@gmail.com