Issue 2102 use of repository packs needs to be documented in the manual

Title use of repository packs needs to be documented in the manual
Priority bug Status resolved
Milestone 2.10.0 Resolved in 2.10.0
Superseder Nosy List markstos, mndrix, twb
Assigned To
Topics Documentation, Performance

Created on 2011-10-11.16:21:08 by markstos, last changed 2015-04-18.15:50:03 by noreply.

msg14743 (view) Author: markstos Date: 2011-10-11.16:21:05
I was looking at the manual online: 

And I found a mention of "repository packs" in the "darcs get"
documentation. I thought it sounded interesting, so searched further for
information about "repository packs", but there are no other hits. The
manual lacks a definition for what this term means, as well as how to
evaluate when to choose "--packs" vs "--no-packs" when using "darcs

I look forward towards taking advantage of this great feature.

Below is some proposed enhanced documentation for "darcs get" and "darcs
optimize" to improve the situation, based on what I've figured out so
far. However, I still have further questions which excellent
documentation should address:

* What happens if you run "darcs optimize --http" and then don't do it 
  for a month? How would performance and correctness change over time?

* Assuming you want to provide the best performance consistently over
  HTTP, is there a best practice to make sure that the repository always
  stays optimized?

* What kind of additional disk space usage are packs expected to use,
  proportional the repo size?

* In what cases would a user want to use --no-packs instead of --packs?


In the documentation for "optimize --http", it should say:


Using this option creates "repository packs" that could dramatically
speed up performance when a user does a "darcs get" of the repository
over HTTP. To make use of packs, the clients must have a darcs of at
least version 2.x.x. For more details, see


Then, in the "darcs get" documentation, it should say:


By default, darcs will look for and attempt to use packs created by
"darcs optimize --http"
msg18376 (view) Author: noreply Date: 2015-04-18.15:50:02
The following patch sent by Guillaume Hoffmann <guillaumh@gmail.com> updated issue issue2102 with
status=resolved;resolvedin=2.10.0 HEAD

* resolve issue2102: document packs in help of clone and optimize http 
Ignore-this: 73d9d62c3d4032588aa7d5bc56ac5570
help string suggestions by Mark Stosberg
Date User Action Args
2011-10-11 16:21:08markstoscreate
2011-10-13 13:27:19markstossetmilestone: 2.10.0
2012-02-24 15:18:26mndrixsetnosy: + mndrix
2015-04-18 15:50:03noreplysetstatus: unknown -> resolved
messages: + msg18376
resolvedin: 2.10.0