[PATCH] core.legacyheaders: Use the description used in RelNotes-1.5.0

[PATCH] core.legacyheaders: Use the description used in RelNotes-1.5.0

[Santi Béjar]

It explains what it does and why, and says how to use the new format.

Signed-off-by: Santi Béjar <sbejar@gmail.com>
---
 Documentation/config.txt |   15 +++++++++++----
 1 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 9d045d8..9566ae8 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -192,10 +192,17 @@ core.compression::
 	slowest.
 
 core.legacyheaders::
-	A boolean which enables the legacy object header format in case
-	you want to interoperate with old clients accessing the object
-	database directly (where the "http://" and "rsync://" protocols
-	count as direct access).
+	A boolean which
+	changes the format of loose objects so that they are more
+	efficient to pack and to send out of the repository over git
+	native protocol, since v1.4.2.  However, loose objects
+	written in the new format cannot be read by git older than
+	that version; people fetching from your repository using
+	older clients over dumb transports (e.g. http) using older
+	versions of git will also be affected.
++
+To let git use the new loose object format, you have to
+set core.legacyheaders to false.
 
 core.packedGitWindowSize::
 	Number of bytes of a pack file to map into memory in a
-- 
1.5.0.1.576.g78541

Re: [PATCH] core.legacyheaders: Use the description used in RelNotes-1.5.0

[Junio C Hamano]

Santi Béjar <sbejar@gmail.com> writes:

> +	A boolean which
> +	changes the format of loose objects so that they are more
> +	efficient to pack and to send out of the repository over git
> +	native protocol, since v1.4.2.  However, loose objects
> +	written in the new format cannot be read by git older than
> +	that version; people fetching from your repository using
> +	older clients over dumb transports (e.g. http) using older
> +	versions of git will also be affected.

Much better than the original but "using older clients" and
"using older versions of git" sounds duplicated.

> ++
> +To let git use the new loose object format, you have to
> +set core.legacyheaders to false.
>  
>  core.packedGitWindowSize::
>  	Number of bytes of a pack file to map into memory in a
> -- 
> 1.5.0.1.576.g78541