diff --git a/README b/README index 5abc5ad..0f72321 100644 --- a/README +++ b/README @@ -56,27 +56,34 @@ Implemented subcommands: - revert all affected files under given target path(s) root - output root URL (for use on shell such as "svn log $(svn root)/tags") - stash [command] + stash [options] [file...] - allow temporarily saving changes to the working copy without committing - - the stashes behaves as a "stack" where "save" pushes a new stash object - and "pop" pops the newest one from the top of the stack - commands: - save [-k] (default if not specified): - - save changes as a "stash" object - - revert changes from working copy unless -k (keep working copy) given - - this only works with text files, not binary files - list: - - show a list of all stash objects - pop [-k] [id]: - - apply the stash object back to the working copy - - the stash object is removed unless -k (keep) given - - defaults to the newest stash object created - show [id]: - - display the diff stored in stash with ID - - defaults to the newest stash object created - drop [id]: - - delete stash object - - defaults to the newest stash object created + - the stashes behaves as a "stack" where stashing pushes a new stash object + and popping removes the newest one from the top of the stack + - binary files are ignored (a warning is printed) and not stashed + options: + -e, --externals + - also stash changes in externals (if no explicit targets given) + -k, --keep + - create the stash object, but keep the changes locally as well + - with --pop, do not remove the stash object after reapplying it + -p, --patch + - interactively prompt for whether to stash each hunk + --list + - show a list of all stash objects + --pop [id] + - apply the stash object back to the working copy + - the stash object is removed unless -k (keep) given + - defaults to the newest stash object created + --show [id] + - display the diff stored in stash with ID + - defaults to the newest stash object created + --drop [id] + - delete stash object + - defaults to the newest stash object created + - if none of --list, --pop, --show, or --drop is given, a new stash object + is created containing the chosen differences + - if file is given, only the changes from the listed files will be stashed switch - switch to 'trunk', branch name, or tag name without having to specify the full URL