From: Stephen Boyd <bebarino@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Nicolas Pitre <nico@fluxnic.net>
Subject: [PATCHv2] Documentation: describe --thin more accurately
Date: Fri, 12 Feb 2010 00:00:46 -0800 [thread overview]
Message-ID: <1265961646-28585-1-git-send-email-bebarino@gmail.com> (raw)
In-Reply-To: <1265778851-5397-1-git-send-email-bebarino@gmail.com>
The description for --thin was misleading and downright wrong. Correct
it with some inspiration from the description of index-pack's --fix-thin
and some background information from Nicolas Pitre <nico@fluxnic.net>.
Signed-off-by: Stephen Boyd <bebarino@gmail.com>
---
Changes since v1:
- No longer bollocks ;-)
- Document --thin for pack-object
Documentation/git-fetch-pack.txt | 6 ++++--
Documentation/git-index-pack.txt | 4 ++--
Documentation/git-pack-objects.txt | 8 ++++++++
Documentation/git-push.txt | 7 ++++---
Documentation/git-send-pack.txt | 6 ++++--
5 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index e9952e8..c428f6d 100644
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -44,8 +44,10 @@ OPTIONS
locked against repacking.
--thin::
- Spend extra cycles to minimize the number of objects to be sent.
- Use it on slower connection.
+ Fetch a "thin" pack, which records objects in deltified form based
+ on objects not included in the pack to reduce network traffic.
+ The excluded objects are expected to be present on the receiving
+ end.
--include-tag::
If the remote side supports it, annotated tags objects will
diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index 65a301b..73fe51a 100644
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -46,10 +46,10 @@ OPTIONS
'git repack'.
--fix-thin::
- It is possible for 'git pack-objects' to build
+ It is possible for 'git pack-objects' to build a
"thin" pack, which records objects in deltified form based on
objects not included in the pack to reduce network traffic.
- Those objects are expected to be present on the receiving end
+ The excluded objects are expected to be present on the receiving end
and they must be included in the pack for that pack to be self
contained and indexable. Without this option any attempt to
index a thin pack will fail. This option only makes sense in
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index ffd5025..f32c322 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -179,6 +179,14 @@ base-name::
Add --no-reuse-object if you want to force a uniform compression
level on all data no matter the source.
+--thin::
+ Create a "thin" pack, which records objects in deltified form based
+ on objects not included in the pack to reduce network traffic.
+ The excluded objects are expected to be present on the receiving end
+ and eventually must be included in the pack for that pack to be self
+ contained and indexable. This option only makes sense in
+ conjunction with --stdout.
+
--delta-base-offset::
A packed archive can express base object of a delta as
either 20-byte object name or as an offset in the
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index bd79119..c67b06c 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -141,9 +141,10 @@ useful if you write an alias or script around 'git push'.
--thin::
--no-thin::
- These options are passed to 'git send-pack'. Thin
- transfer spends extra cycles to minimize the number of
- objects to be sent and meant to be used on slower connection.
+ These options are passed to linkgit:git-send-pack[1]. A thin transfer
+ significantly reduces the number of sent objects when the sender and
+ receiver share many of the same objects in common. The default is
+ \--thin.
-v::
--verbose::
diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index 8178d92..1d7c4d4 100644
--- a/Documentation/git-send-pack.txt
+++ b/Documentation/git-send-pack.txt
@@ -48,8 +48,10 @@ OPTIONS
Run verbosely.
--thin::
- Spend extra cycles to minimize the number of objects to be sent.
- Use it on slower connection.
+ Send a "thin" pack, which records objects in deltified form based
+ on objects not included in the pack to reduce network traffic.
+ The excluded objects are expected to be present on the receiving
+ end.
<host>::
A remote host to house the repository. When this
--
1.7.0.rc2.28.gf476c0
next prev parent reply other threads:[~2010-02-12 8:00 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-02-10 5:14 [PATCH] Documentation: reword --thin description Stephen Boyd
2010-02-10 16:07 ` Nicolas Pitre
2010-02-10 16:52 ` Stephen Boyd
2010-02-10 18:59 ` Junio C Hamano
2010-02-10 21:04 ` Nicolas Pitre
2010-02-12 8:00 ` Stephen Boyd [this message]
2010-02-12 17:36 ` [PATCHv2] Documentation: describe --thin more accurately Junio C Hamano
2010-02-15 19:33 ` [PATCHv3] " Stephen Boyd
2010-02-15 20:44 ` Junio C Hamano
2010-02-18 8:33 ` Stephen Boyd
2010-02-18 9:10 ` [PATCHv4] " Stephen Boyd
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=1265961646-28585-1-git-send-email-bebarino@gmail.com \
--to=bebarino@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=nico@fluxnic.net \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).