Message formats for committing code SVN

This page describes some guidelines when committing code to dCache. They're based on the email Gerd sent. Since no-one argued against them, I'm documenting the ideas here.

SVN log file

Overall format: a one-line summary followed by a more detailed description (probably copied from the original message to code-review). If the patch is to fix a specific support ticket then "ticket #<RT number>" should be included.

The normal process is for whoever submitted the code for review to finally commit the code. If this isn't followed, then a "Committing on behalf of" should be included.

<one line summary>

<more detailed summary>

[Committing on behalf of: <name of person>]
Signed-off by: <name of person>
patch #<RT number>
[ticket #<RT number>]

For example:

gplazma - fix formatting of log4j appenders

This patch fixes a bug in the formatting of the log4j appenders in 
gPlazma. The previous formatting acted on the parent console appender, 
which caused the formatting to remain in the log statements after the 
authorization had finished. The fix is to format each classes own log4j 
appender instead of the parent's.

Signed-off by: Timur
Patch: #3882

or

Fix bug introduced in r10433.

Patch #3874 intended to change the domain name of the domain hosting the
admin door. It did this by changing the service name from admin to
adminDoor and then relied on the automatic derivation of the domain
name. A bug was introduced in that the service name was not updated
throughout the script.

Committing on behalf of: Gerd
Signed-off by: Owen
Patch: #3878

For RT tracking

When closing the RT ticket associated with a patch, the message should finish with one line per branch the code was committed into.

<branch-name>: r.<SVN revision>
[<branch-name>: r.<SVN revision>]
[<branch-name>: r.<SVN revision>]

For example, when committing to Trunk:

Trunk: r.1295

or, when committing to multiple branches:

Trunk:        r.1380
branch-1.9:   r.1381
branch-1.9.0: r.1382

NB. the commit numbers don't have to be aligned!