source: branches/2015/dev_r5021_UKMO1_CICE_coupling/NEMOGCM/EXTERNAL/fcm/lib/Fcm/CLI/fcm-mkpatch.pod @ 5445

Last change on this file since 5445 was 5445, checked in by davestorkey, 5 years ago

Clear SVN keywords from 2015/dev_r5021_UKMO1_CICE_coupling branch.

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