fcm-mkpatch.pod 2.2 KB

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