Changes between Version 22 and Version 23 of CommitMessageFormat


Ignore:
Timestamp:
11/11/15 16:18:52 (5 years ago)
Author:
tigran
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CommitMessageFormat

    v22 v23  
    1 = Message formats for committing code SVN = 
     1= Message formats for committing code GIT = 
    22 
    33This page describes some guidelines when committing code to dCache. 
     
    1919The description may also include additional notes such as limitations of the patch. 
    2020 
    21 == SVN log file == 
     21== Git log file == 
    2222 
    2323 
     
    3333<one line summary> 
    3434 
    35 <more detailed summary> 
     35Motivation: 
     36<describe why you want change the code> 
    3637 
    37 <which may be split over several paragraphs> 
     38Modification: 
     39<describe changes was made> 
    3840 
    39 [RELEASE NOTES: 
    40 <notes for whoever is collating the release notes>] 
     41Result: 
     42<describe user visible changes> 
    4143 
    42 [BOOK: 
    43 <notes for whoever is updating the book>] 
    4444 
    45 Patch: <ReviewBoard URL> 
    4645Require-notes: <yes|no> 
    4746Require-book: <yes|no> 
     
    10099 
    101100{{{ 
    102 gplazma: fix formatting of log4j appenders 
     101Motivation: 
    103102 
    104 This patch fixes a bug in the formatting of the log4j appenders in  
    105 gPlazma. The previous formatting acted on the parent console appender,  
    106 which caused the formatting to remain in the log statements after the  
    107 authorization had finished. The fix is to format each classes own log4j  
    108 appender instead of the parent's. 
     103Currently we have a mechanism for injecting a custom executor into the cell 
     104nucleus to be used for message processing. This is used both to tune the 
     105concurrency/queue limits of the cell, as well as to inject shared executors 
     106to use accross several cells. 
    109107 
    110 Acked-by: Timur 
    111 Require-notes: no 
    112 Require-book: no 
    113 Patch: http://rb.dcache.org/r/536/ 
     108The problem with the current design is that it presents a problem with how to 
     109initialize the custom executor: Initialization should be done on the message 
     110executor to get the correct thread group and CDC inheritance, but that means 
     111a custom executor should be created before regular initialization or we have 
     112to first start on executor for initialization and then replace it with another 
     113one. The latter is currently done for UniversalSpringCell. 
     114 
     115Modification: 
     116 
     117With this patch a bounded executor is used for message delivery and cannot 
     118be replaced. The thread and queue limits are however configurable through 
     119cell arguments. Since a bounded executor wraps another executor, a shared 
     120executor can be realized by letting multiple cells wrap the same executor 
     121(this is done by the line based door). 
     122 
     123The cell message executor is exposed to the spring configuration to allow 
     124cell components to execute tasks on it. 
     125 
     126Result: 
     127 
     128Significantly simpler message executor design and no duplicate executor 
     129creation during startup. The configuration properties for setting the limits 
     130have been harmonized and the old names have been deprecated. 
     131 
    114132Target: trunk 
     133Require-notes: yes 
     134Require-book: yes 
    115135}}} 
    116136 
    117 Another example, with back-port requests: 
    118  
    119 {{{ 
    120 Scripts: Fix bug introduced in r10433. 
    121  
    122 Patch #3874 intended to change the domain name of the domain hosting the 
    123 admin door. It did this by changing the service name from admin to 
    124 adminDoor and then relied on the automatic derivation of the domain 
    125 name. A bug was introduced in that the service name was not updated 
    126 throughout the script. 
    127  
    128 RELEASE NOTES: 
    129 Just mention that a bug that had symptom XXX has been fixed. 
    130  
    131 Patch: http://rb.dcache.org/r/201/ 
    132 Bug: http://rt.dcache.org/some-bug 
    133 Require-notes: yes 
    134 Require-book: no 
    135 Signed-off-by: Gerd 
    136 Acked-by: Owen 
    137 Target: trunk 
    138 Request: 1.9.6 
    139 Request: 1.9.5 
    140 Merge-req: http://rt.dcache.org/Ticket/Display.html?id=5811 
    141 }}} 
    142  
    143 Another example, with release-notes: 
    144  
    145 {{{ 
    146 JettyGSIConnector: Automatically refresh host certificates/trust anchors 
    147  
    148 Add setters for intervals in which trust anchors and host certificates 
    149 should be reloaded. Reload if they are undefined or older than the 
    150 given intervals. 
    151  
    152 RELEASE NOTES: 
    153 The SRM door can now reload the host certificate and the trusted 
    154 certificates (trust anchors) at configurable intervals. Between these 
    155 refresh periods both the host certificate and the trusted certificates 
    156 stay cached in the application. This should help the admin to avoid 
    157 having to restart the service when host certificates or trusted 
    158 certificates are replaced. 
    159  
    160 Acked-by: Gerd Behrmann <behrmann@ndgf.org> 
    161 Require-notes: yes 
    162 Require-book: no 
    163 Target: trunk 
    164 Patch: http://rb.dcache.org/r/2382/ 
    165 }}} 
    166  
    167 The following example shows a commit message on a supported branch where 
    168 the patch has been merged from Trunk.  Signed-off-by is the person who 
    169 supplied the original patch.  Merge provides an existing commit. 
    170  
    171 {{{ 
    172 chimera: use exists statement to prevent constrain violations 
    173  
    174 Signed-off-by: Tigran Mkrtchyan 
    175 Merge: trunk@17090 
    176 Merge: trunk@17093 
    177 Acked-by: Paul Millar 
    178 Patch: http://rb.dcache.org/r/4534 
    179 }}} 
    180137 
    181138== For !ReviewBoard tracking == 
     
    183140When closing the !ReviewBoard entry associated with a patch, please update the patches description so it includes a list of which branches the patch was applied to. 
    184141 
    185 The format is to write a line like `Committed: <repository-id>` for each branch the code is committed into.  The `<repository-id>` has the form '<branch-name>@<revision>' for branches and 'trunk@<revision>' when committing into trunk. 
     142The format is to write a line like `Committed: <repository-id>` for each branch the code is committed into.  The `<repository-id>` has the form '<branch-name>@<revision>' for branches and 'masterk@<revision>' when committing into trunk. 
    186143 
    187144Here's a message for a patch committed to the 1.9.5, 1.9.8, 1.9.9, 1.9.10 supported branches and trunk. 
     
    192149Committed: 1.9.9@1382 
    193150Committed: 1.9.10@1383 
    194 Committed: trunk@1384 
     151Committed: master@1384 
    195152}}}