Log message description

We are using a log message format convention to work with our repository: any change made to the repository (copy, move, commit, delete) should be documented within the log message

Using the log message to document any change allows the developer to use his SVN client of choice (TortoiseSVN, svn CLI, …) with no trouble

The log message format is heavily inspired from the Trac hook scripts :

  • A log message should always start with a keyword that describes the kind of modification that is to be commited to the repository
  • There could be only one kind of modification per commit operation
    • As an example, a developer is not allowed to create and delete a branch within the same changeset
  • In all log messages, free text is always allowed after the initial keyword (and the mandatory options if any)

List of keywords :

  • refs #t: used when a changeset is tied to an open ticket t
  • closes #t: used when a changeset implements a feature that is tied to an open ticket t
  • fixes #t: used when a changeset fixes a bug that is described in a open ticket t
  • creates: used when a developer creates a new development branch or creates a tag branch
  • terminates: used when a developer deletes an existing branch
  • imports: used when a developer imports files from an external source
  • delivers [x]:[y]: used when a developer delivers a development branch to another branch - usually to the trunk. [x]:[y] represents the first (x) and last (y) changeset on the source branch that are actually delivered. If a single changeset is delivered, the log message can be simplified as delivers [x]
  • admins allows the repository administrator(s) to force any kind of operations which would normally be rejected by the hook scripts