diff options
| author | Shawn O. Pearce <sop@google.com> | 2009-06-15 18:31:12 -0700 |
|---|---|---|
| committer | Shawn O. Pearce <sop@google.com> | 2009-06-15 18:31:12 -0700 |
| commit | 1f8d0a27b1b104b21d79a709e6e70c3798a78b8c (patch) | |
| tree | 6d65790da42d1a89c6a8f8064446ef3499562901 | |
| parent | c450ab8f36334fb31aa0092bb2247b410ca35a6c (diff) | |
Document the new gerrit-cherry-pick command
Signed-off-by: Shawn O. Pearce <sop@google.com>
| -rw-r--r-- | Documentation/cmd-cherry-pick.txt | 39 | ||||
| -rw-r--r-- | Documentation/cmd-index.txt | 14 |
2 files changed, 53 insertions, 0 deletions
diff --git a/Documentation/cmd-cherry-pick.txt b/Documentation/cmd-cherry-pick.txt new file mode 100644 index 0000000000..64ae2454bd --- /dev/null +++ b/Documentation/cmd-cherry-pick.txt @@ -0,0 +1,39 @@ +gerrit-cherry-pick +================== + +NAME +---- +gerrit-cherry-pick - Download and cherry pick one or more changes + +SYNOPSIS +-------- +[verse] +'gerrit-cherry-pick' <remote> <changeid>... + +'gerrit-cherry-pick' \--continue | \--skip | \--abort +'gerrit-cherry-pick' \--close <remote> + +DESCRIPTION +----------- +Downloads the listed changes specified on the command line and +proceeds to cherry-pick them (rewriting commit SHA-1s as it goes) +onto the current branch. + +If a merge failure prevents this from being completely automatic, +you will be asked to resolve the conflict and restart the command +with the `\--continue` option. + +Change ids may be specified as either the change id (e.g. 1234) +or as change id slash patch set number (e.g. 1234/8). If the patch +set number is not supplied, `/1` is assumed. + +OBTAINING +--------- +To obtain the 'gerrit-cherry-pick' script use scp to copy it to +your local system: + + $ scp -P 29418 gerrit.example.com:bin/gerrit-cherry-pick ~/bin + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] diff --git a/Documentation/cmd-index.txt b/Documentation/cmd-index.txt index 529241c0f8..d45e0767c0 100644 --- a/Documentation/cmd-index.txt +++ b/Documentation/cmd-index.txt @@ -1,6 +1,20 @@ Gerrit2 - Command Line Tool =========================== +Client Commands +--------------- + +Client commands can be downloaded via scp, and then executed on +the client system. + +link:cmd-cherry-pick.html[gerrit-cherry-pick]:: + Download and cherry-pick one or more changes (commits). + +To download a client command, use scp: + + $ scp -P 29418 review.example.com:bin/gerrit-cherry-pick ~/bin + + Executing Commands ------------------ |