fcm-branch.pod 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. =head1 NAME
  2. fcm branch (br)
  3. =head1 SYNOPSIS
  4. Create, delete or display information of a branch, or list branches in a
  5. project.
  6. fcm branch [--info] [OPTIONS] [TARGET]
  7. fcm branch --delete [OPTIONS] [TARGET]
  8. fcm branch --create [OPTIONS] [SOURCE]
  9. fcm branch --list [OPTIONS] [SOURCE]
  10. =head1 ARGUMENTS
  11. TARGET (and SOURCE) can be an URL or a Subversion working copy. Otherwise,
  12. the current working directory must be a working copy. For --info and
  13. --delete, the specified URL (or the URL of the working copy) must be a URL
  14. under a valid branch in a standard FCM project. For --create and --list, it
  15. must be a URL under a standard FCM project.
  16. =head1 OPTIONS
  17. =over 4
  18. =item --info or -i
  19. Display information about a branch. This is the default option if --create,
  20. --delete and --list are not specified.
  21. =item --delete or -d
  22. Delete a branch.
  23. =item --create or -c
  24. Create a new branch from SOURCE. The --name option must be used to specify a
  25. short name for the new branch.
  26. =item --list or -l
  27. List all the branches owned by the current user in SOURCE. If the --user option
  28. is specified with a list of users, list all the branches owned by these users
  29. instead of the current user.
  30. =back
  31. Valid options with --info and --delete:
  32. =over 4
  33. =item -v [--verbose]
  34. Print extra information.
  35. =item -a [--show-all]
  36. Set --show-children, --show-other and --show-siblings.
  37. =item --show-children
  38. Report children of the current branch.
  39. =item --show-other
  40. Report custom/ reverse merges into the current branch.
  41. =item --show-siblings
  42. Report merges with siblings of the current branch.
  43. =back
  44. Valid options with --delete and --create:
  45. =over 4
  46. =item --non-interactive
  47. Do no interactive prompting. This option implies --svn-non-interactive.
  48. =item --password arg
  49. Specify a password for write access to the repository.
  50. =item --svn-non-interactive
  51. Do no interactive prompting at commit time. This option is implied by
  52. --non-interactive.
  53. =back
  54. Valid options with --create and --list:
  55. =over 4
  56. =item -r [--revision] arg
  57. Specify the operative revision of the SOURCE for creating the branch.
  58. =back
  59. Valid options with --create:
  60. =over 4
  61. =item --branch-of-branch
  62. If this option is specified and the SOURCE is a branch, it will create a new
  63. branch from the SOURCE branch. Otherwise, the branch is created from the trunk.
  64. =item -k [--ticket] arg
  65. Specify one (or more) Trac ticket. If specified, the command will add to the
  66. commit log the line "Relates to ticket #<ticket>". Multiple tickets can be set
  67. by specifying this option multiple times, or by specifying the tickets in a
  68. comma-separated list.
  69. =item -n [--name] arg
  70. Specify a short name for the branch, which should contain only characters in the
  71. set [A-Za-z0-9_-.].
  72. =item --rev-flag arg
  73. Specify a flag for determining the prefix of the branch name. The flag can be
  74. the the string "NORMAL", "NUMBER" or "NONE". "NORMAL" is the default behaviour,
  75. in which the branch name will be prefixed with a Subversion revision number if
  76. the revision is not associated with a registered FCM revision keyword. If the
  77. revision is registered with a FCM revision keyword, the keyword will be used in
  78. place of the number. If "NUMBER" is specified, the branch name will always be
  79. prefixed with a Subversion revision number. If "NONE" is specified, the branch
  80. name will not be prefixed by a revision number or keyword.
  81. =item -t [--type] arg
  82. Specify the type of the branch to be created. It must be one of the following:
  83. DEV::USER [DEV, USER] - a development branch for the user
  84. DEV::SHARE [SHARE] - a shared development branch
  85. TEST::USER [TEST] - a test branch for the user
  86. TEST::SHARE - a shared test branch
  87. PKG::USER [PKG] - a package branch for the user
  88. PKG::SHARE - a shared package branch
  89. PKG::CONFIG [CONFIG] - a configuration branch
  90. PKG::REL [REL] - a release branch
  91. If not specified, the default is to create a development branch for the current
  92. user, i.e. DEV::USER.
  93. =back
  94. Valid options with --list:
  95. =over 4
  96. =item -a [--show-all]
  97. Print all branches.
  98. =item -u [--user] arg
  99. Specify a colon-separated list of users. List branches owned by these users
  100. instead of the current user.
  101. =item -v [--verbose]
  102. Print Subversion URL instead of FCM URL keywords.
  103. =back
  104. =cut