[darcs-users] questions about '--partial' for doc enhancement.

Mark Stosberg mark at summersault.com
Wed Jan 5 22:16:07 UTC 2005


Hello,

I'd like to enhance the docs for 'optimize'. I'm looking for good
answers to these questions, which I can create 'doc patches' for,
or you can patch yourself if you are so included:

1. What are examples of when 'optimize' should be used? 

The first couple sentences of the docs should explain why you would 
want to use the command and briefly what it does. 

2. What happens if you don't specify any of the compression options?  
   Are the checkpoint and compression flags inter-related at all? 

I'll also suggest moving the docs for "--partial" and "--checkpoint"
out of the "common options" section. In fact, they are used by less than 
10% of the sub commands. (Just two, "get" and "check", I believe)

A related question: Is there an easy way in Latex to link mention of
common flags back to their entries in the "common flags" reference? 

    Mark






More information about the darcs-users mailing list