[PATCHv3] Documentation: describe --thin more accurately
- From
Stephen Boyd <bebarino@gmail.com>
- Date
- Feb 15, 2010, 19:33 UTC
- Message-ID
- <1266262395-11864-1-git-send-email-bebarino@gmail.com>
- In-Reply-To
- <1265961646-28585-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 v2: - Address Junio's comments
Documentation/git-fetch-pack.txt | 4 ++-- Documentation/git-index-pack.txt | 11 ++++++----- Documentation/git-pack-objects.txt | 9 +++++++++ Documentation/git-push.txt | 7 ++++--- Documentation/git-send-pack.txt | 4 ++-- 5 files changed, 23 insertions(+), 12 deletions(-)
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index e9952e8..0ad94e3 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -44,8 +44,8 @@ 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. --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..b4fa98e 100644 --- a/Documentation/git-index-pack.txt +++ b/Documentation/git-index-pack.txt @@ -46,14 +46,15 @@ OPTIONS 'git repack'. --fix-thin:: - It is possible for 'git pack-objects' to build + It's 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 - conjunction with --stdin. + contained and indexable. This option fixes the "thin" pack by + adding the missing objects to the pack. Without this option any + attempt to index a "thin" pack will fail. This option only makes + sense in conjunction with --stdin. --keep:: Before moving the index into its final destination diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index ffd5025..fd9181a 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -179,6 +179,15 @@ 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 (see the \--fix-thin option of + linkgit:git-index-pack[1] for more details). 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..c86ad29 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 amount of sent data 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..deaa7d9 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -48,8 +48,8 @@ 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. <host>:: A remote host to house the repository. When this
-- 1.7.0.17.g7e5eb