[darcs-users] organizing the command quick ref docs (was: echo "cvs * | sed s/cvs/darcs/)

[Michael Milverton]

I also found that --summary was a bit counter intuitive, as I always had in my 
mind that --summary would give less information than I already had.

I stick my vote in for --log being more intuitive.

On Tue, 3 Aug 2004 09:52 pm, Zooko wrote:
> Ketil:
>
> Thanks!
>
> I'm sorry I didn't take more time to look at the docs so that I would
> have seen this.  I wonder if something could be changed to minimize the
> chance of people missing this command when they are looking for it.
>
> One thing that would help is if this command were named "darcs log",
> since it is analogous to "cvs log" and "svn log" and "tla logs".  I
> tried "darcs log" before I looked at the docs, and when I looked at the
> docs I was probably scanning for the word "log" or a similar word.
>
> 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".
>
> A third thing that might help is if there were fewer commands, or if
> some commands were relegated to an "advanced" section of the docs.
> Darcs has a well-deserved reputation for being simpler and easier to
> learn than its competitors, but it appears that the number of commands
> continues to grow, so this advantage might be lessening.
>
> I guess "darcs get" can always be implemented with "mkdir d && cd d &&
> darcs initialize && darcs fetch", so "darcs get" could be relegated to
> an "advanced" or "convenience" category.  Likewise, I could write
> "darcs diff -u > p && darcs revert && patch -p0 < p" instead of "darcs
> revert && darcs unrevert" (I also used that trick when I was using
> CVS).  I wonder if "darcs diff" and "darcs whatsnew" shouldn't be a
> single command which behaves differently depending on its arguments (as
> "cvs diff" does).  I still don't understand how "darcs unpull" relates
> to "darcs unrecord" and "darcs rollback", so even if "unpull" and
> "rollback" aren't convenience commands, they are certainly advanced
> commands.  Okay, I'll stop for now and see what kind of reception this
> line of though receives.
>
> Regards,
>
> Zooko
>
> -- 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.
>
>
> _______________________________________________
> darcs-users mailing list
> darcs-users at abridgegame.org
> http://www.abridgegame.org/mailman/listinfo/darcs-users

-- 
GNU/Linux: Secure, Stable, Free
Michael <camel78 at iprimus.com.au>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 307 bytes
Desc: signature
Url : http://lists.osuosl.org/pipermail/darcs-users/attachments/20040804/b054e3e8/attachment.pgp