| 1 | =head1 NAME |
|---|
| 2 | |
|---|
| 3 | fcm mkpatch |
|---|
| 4 | |
|---|
| 5 | =head1 SYNOPSIS |
|---|
| 6 | |
|---|
| 7 | Create patches from specified revisions of a URL |
|---|
| 8 | |
|---|
| 9 | fcm mkpatch [OPTIONS] URL [OUTDIR] |
|---|
| 10 | |
|---|
| 11 | =head1 ARGUMENTS |
|---|
| 12 | |
|---|
| 13 | If OUTDIR is specified, the output is sent to OUTDIR. Otherwise, the output will |
|---|
| 14 | be sent to a default location in the current directory ($PWD/fcm-mkpatch-out). |
|---|
| 15 | The output directory will contain the patch for each revision as well as a |
|---|
| 16 | script for importing the patch. |
|---|
| 17 | |
|---|
| 18 | A warning is given if the URL is not of a branch in a FCM project or if it is a |
|---|
| 19 | sub-directory of a branch. |
|---|
| 20 | |
|---|
| 21 | =head1 OPTIONS |
|---|
| 22 | |
|---|
| 23 | =over 4 |
|---|
| 24 | |
|---|
| 25 | =item --exclude arg |
|---|
| 26 | |
|---|
| 27 | Exclude a path in the URL. Multiple paths can be specified by using a |
|---|
| 28 | colon-separated list of paths, or by specifying this option multiple times. |
|---|
| 29 | |
|---|
| 30 | The specified path must be a relative path of the URL. Glob patterns such as * |
|---|
| 31 | and ? are acceptable. Changes in an excluded path will not be considered in the |
|---|
| 32 | patch. A changeset containing changes only in the excluded path will not be |
|---|
| 33 | considered at all. |
|---|
| 34 | |
|---|
| 35 | =item --organisation arg |
|---|
| 36 | |
|---|
| 37 | This option can be used to specify the name of your organisation. |
|---|
| 38 | |
|---|
| 39 | The command will attempt to parse the commit log message for each revision in |
|---|
| 40 | the patch. It will remove all merge templates, replace Trac links with a |
|---|
| 41 | modified string, and add information about the original changeset. If you |
|---|
| 42 | specify the name of your organisation, it will replace Trac links such as |
|---|
| 43 | "ticket:123" with "$organisation_ticket:123", and report the original changeset |
|---|
| 44 | with a message such as "$organisation_changeset:1000". If the organisation |
|---|
| 45 | name is not specified then it defaults to "original". |
|---|
| 46 | |
|---|
| 47 | =item --revision=arg, -r arg |
|---|
| 48 | |
|---|
| 49 | Specify a revision number or a revision number range. |
|---|
| 50 | |
|---|
| 51 | If a revision is specified with the --revision option, it will attempt to create |
|---|
| 52 | a patch based on the changes at that revision. If a revision is not specified, |
|---|
| 53 | it will attempt to create a patch based on the changes at the HEAD revision. If |
|---|
| 54 | a revision range is specified, it will attempt to create a patch for each |
|---|
| 55 | revision in that range (including the change in the lower range) where changes |
|---|
| 56 | have taken place in the URL. No output will be written if there is no change in |
|---|
| 57 | the given revision (range). |
|---|
| 58 | |
|---|
| 59 | =back |
|---|
| 60 | |
|---|
| 61 | =cut |
|---|
