source: branches/UKMO/r6232_tracer_advection/NEMOGCM/EXTERNAL/fcm/lib/Fcm/CLI/fcm-branch.pod @ 9295

Last change on this file since 9295 was 9295, checked in by jcastill, 3 years ago

Remove svn keywords

File size: 4.2 KB
Line 
1=head1 NAME
2
3fcm branch (br)
4
5=head1 SYNOPSIS
6
7Create, delete or display information of a branch, or list branches in a
8project.
9
10    fcm branch [--info] [OPTIONS] [TARGET]
11    fcm branch --delete [OPTIONS] [TARGET]
12    fcm branch --create [OPTIONS] [SOURCE]
13    fcm branch --list   [OPTIONS] [SOURCE]
14
15=head1 ARGUMENTS
16
17TARGET (and SOURCE) can be an URL or a Subversion working copy. Otherwise,
18the current working directory must be a working copy. For --info and
19--delete, the specified URL (or the URL of the working copy) must be a URL
20under a valid branch in a standard FCM project. For --create and --list, it
21must be a URL under a standard FCM project.
22
23=head1 OPTIONS
24
25=over 4
26
27=item --info or -i
28
29Display information about a branch. This is the default option if --create,
30--delete and --list are not specified.
31
32=item --delete or -d
33
34Delete a branch.
35
36=item --create or -c
37
38Create a new branch from SOURCE. The --name option must be used to specify a
39short name for the new branch.
40
41=item --list or -l
42
43List all the branches owned by the current user in SOURCE. If the --user option
44is specified with a list of users, list all the branches owned by these users
45instead of the current user.
46
47=back
48
49Valid options with --info and --delete:
50
51=over 4
52
53=item -v [--verbose]
54
55Print extra information.
56
57=item -a [--show-all]
58
59Set --show-children, --show-other and --show-siblings.
60
61=item --show-children
62
63Report children of the current branch.
64
65=item --show-other
66
67Report custom/ reverse merges into the current branch.
68
69=item --show-siblings
70
71Report merges with siblings of the current branch.
72
73=back
74
75Valid options with --delete and --create:
76
77=over 4
78
79=item --non-interactive
80
81Do no interactive prompting. This option implies --svn-non-interactive.
82
83=item --password arg
84
85Specify a password for write access to the repository.
86
87=item --svn-non-interactive
88
89Do no interactive prompting at commit time. This option is implied by
90--non-interactive.
91
92=back
93
94Valid options with --create and --list:
95
96=over 4
97
98=item -r [--revision] arg
99
100Specify the operative revision of the SOURCE for creating the branch.
101
102=back
103
104Valid options with --create:
105
106=over 4
107
108=item --branch-of-branch
109
110If this option is specified and the SOURCE is a branch, it will create a new
111branch from the SOURCE branch. Otherwise, the branch is created from the trunk.
112
113=item -k [--ticket] arg
114
115Specify one (or more) Trac ticket. If specified, the command will add to the
116commit log the line "Relates to ticket #<ticket>". Multiple tickets can be set
117by specifying this option multiple times, or by specifying the tickets in a
118comma-separated list.
119
120=item -n [--name] arg
121
122Specify a short name for the branch, which should contain only characters in the
123set [A-Za-z0-9_-.].
124
125=item --rev-flag arg
126
127Specify a flag for determining the prefix of the branch name. The flag can be
128the the string "NORMAL", "NUMBER" or "NONE".  "NORMAL" is the default behaviour,
129in which the branch name will be prefixed with a Subversion revision number if
130the revision is not associated with a registered FCM revision keyword. If the
131revision is registered with a FCM revision keyword, the keyword will be used in
132place of the number. If "NUMBER" is specified, the branch name will always be
133prefixed with a Subversion revision number. If "NONE" is specified, the branch
134name will not be prefixed by a revision number or keyword.
135
136=item -t [--type] arg
137
138Specify the type of the branch to be created. It must be one of the following:
139
140 DEV::USER [DEV, USER] - a development branch for the user
141 DEV::SHARE [SHARE]    - a shared development branch
142 TEST::USER [TEST]     - a test branch for the user
143 TEST::SHARE           - a shared test branch
144 PKG::USER [PKG]       - a package branch for the user
145 PKG::SHARE            - a shared package branch
146 PKG::CONFIG [CONFIG]  - a configuration branch
147 PKG::REL [REL]        - a release branch
148
149If not specified, the default is to create a development branch for the current
150user, i.e.  DEV::USER.
151
152=back
153
154Valid options with --list:
155
156=over 4
157
158=item -a [--show-all]
159
160Print all branches.
161
162=item -u [--user] arg
163
164Specify a colon-separated list of users. List branches owned by these users
165instead of the current user.
166
167=item -v [--verbose]
168
169Print Subversion URL instead of FCM URL keywords.
170
171=back
172
173=cut
Note: See TracBrowser for help on using the repository browser.