diff mbox series

config.txt: correct the note about uploadpack.packObjectsHook

Message ID 20180929065056.9960-1-pclouds@gmail.com (mailing list archive)
State New, archived
Headers show
Series config.txt: correct the note about uploadpack.packObjectsHook | expand

Commit Message

Duy Nguyen Sept. 29, 2018, 6:50 a.m. UTC
Document for uploadpack.packObjectsHook is added in [1] and consists
of two paragraphs, the second one is quite important about where this
variable can stay.

When the paragraph about uploadpack.allowFilter is added in [2], it's
added in between the two paragraphs. This makes the "this is non-repo
level config" note incorrectly apply to allowFilter instead of
packObjectsHook. Move allowFilter paragraph down to fix this.

[1] 20b20a22f8 (upload-pack: provide a hook for running pack-objects -
    2016-05-18)

[2] 10ac85c785 (upload-pack: add object filtering for partial clone -
    2017-12-08)

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 Documentation/config.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Jeff King Sept. 29, 2018, 6:58 a.m. UTC | #1
On Sat, Sep 29, 2018 at 08:50:56AM +0200, Nguyễn Thái Ngọc Duy wrote:

> Document for uploadpack.packObjectsHook is added in [1] and consists
> of two paragraphs, the second one is quite important about where this
> variable can stay.
> 
> When the paragraph about uploadpack.allowFilter is added in [2], it's
> added in between the two paragraphs. This makes the "this is non-repo
> level config" note incorrectly apply to allowFilter instead of
> packObjectsHook. Move allowFilter paragraph down to fix this.

Nice catch, and the patch looks obviously correct. Thanks.

-Peff
diff mbox series

Patch

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ad0f4510c3..907b1d0cb9 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -3666,15 +3666,15 @@  uploadpack.packObjectsHook::
 	was run. I.e., `upload-pack` will feed input intended for
 	`pack-objects` to the hook, and expects a completed packfile on
 	stdout.
-
-uploadpack.allowFilter::
-	If this option is set, `upload-pack` will support partial
-	clone and partial fetch object filtering.
 +
 Note that this configuration variable is ignored if it is seen in the
 repository-level config (this is a safety measure against fetching from
 untrusted repositories).
 
+uploadpack.allowFilter::
+	If this option is set, `upload-pack` will support partial
+	clone and partial fetch object filtering.
+
 uploadpack.allowRefInWant::
 	If this option is set, `upload-pack` will support the `ref-in-want`
 	feature of the protocol version 2 `fetch` command.  This feature