Changes between Version 14 and Version 15 of CommitPolicy


Ignore:
Timestamp:
Jun 9, 2007, 3:38:54 PM (14 years ago)
Author:
Dominic Hargreaves
Comment:

add docs

Legend:

Unmodified
Added
Removed
Modified
  • CommitPolicy

    v14 v15  
    6161NB this doesn't work at the moment (confirmed on the mailing list by DominicHargreaves) --KakePugh
    6262
     63{{{
     64# It searches commit messages for text in the form of:
     65#   command #1
     66#   command #1, #2
     67#   command #1 & #2
     68#   command #1 and #2
     69#
     70# Instead of the short-hand syntax "#1", "ticket:1" can be used as well, e.g.:
     71#   command ticket:1
     72#   command ticket:1, ticket:2
     73#   command ticket:1 & ticket:2
     74#   command ticket:1 and ticket:2
     75#
     76# In addition, the ':' character can be omitted and issue or bug can be used
     77# instead of ticket.
     78#
     79# You can have more then one command in a message. The following commands
     80# are supported. There is more then one spelling for each command, to make
     81# this as user-friendly as possible.
     82#
     83#   close, closed, closes, fix, fixed, fixes
     84#     The specified issue numbers are closed with the contents of this
     85#     commit message being added to it.
     86#   references, refs, addresses, re, see
     87#     The specified issue numbers are left in their current status, but
     88#     the contents of this commit message are added to their notes.
     89#
     90# A fairly complicated example of what you can do is with a commit message
     91# of:
     92#
     93#    Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.
     94#
     95# This will close #10 and #12, and add a note to #12.
     96}}}
     97
    6398You can also just refer to a ticket, which means that hyperlinks between the two will appear but the status will not change. The full specification of this functionality is as follows:
    6499