[darcs-users] organizing the command quick-ref docs
Zooko Journeyman
zooko at zooko.com
Fri Aug 13 13:27:39 UTC 2004
I'm resending this because David didn't respond to it last time. Last
time I combined three different suggestions into one letter. This time
I'm sending each suggestion separately. If David doesn't respond to it
this time I'll let it drop. ;-)
My motivation for writing this was that I couldn't find the command
that would list which patches are in the current repo even after
scanning the manual and the output of "darcs help". It turns out that
command is named "darcs changes" and is documented in both places, but
I didn't see it. Since the number of different darcs commands has
grown, it is increasingly hard to find the one you want when you are
just learning darcs, therefore I proposed:
On 2004, Aug 03, , at 10:52, Zooko wrote:
> Another thing that might help is if the output from "darcs help" and
> from the manual were broken up into use cases. Appended is one
> attempt. I also changed the description of "darcs trackdown".
> -- getting started
> initialize Initialize a new source tree as a darcs repository.
> get Get a repository.
>
> -- changing your source code
> add Add a one or more new files or directories.
> remove Remove one or more files or directories from the
> repository.
> mv Move a file or directory to a different location or
> name.
> replace Replace a token with a new value for that token.
>
> -- managing your changes
> record Record changes as a named patch.
> unrecord Unrecord a named patch.
> revert Revert to recorded version.
> unrevert Undo the last revert operation.
> rollback Roll back a named patch.
>
> -- sharing changes
> pull Pull patches from another repo.
> unpull Unpull a named patch.
> send Send patches to another repo via email.
> apply Apply patches to a repo.
> push Push patches into another repo.
>
> -- examining your changes
> whatsnew Display unrecorded changes in the working directory.
> diff Create a diff between two versions of the repository.
> changes Gives a human-readable list of changes between
> versions.
> annotate Display useful information about the repository
> history.
>
> -- tagging and distribution
> tag Tag the contents of a repo with a given version name.
> dist Create a distribution tarball.
>
> -- administration
> setpref Set the value for a preferences thingy.
> optimize Optimize your repository.
> check Check the repository for consistency.
> repair Repair a corrupted repository.
>
> -- advanced features
> trackdown Find the most recent version which passes a test.
More information about the darcs-users
mailing list