MantisBT - Open CASCADE
View Issue Details
0028814Open CASCADE[OCCT] OCCT:Documentationpublic2017-06-05 16:122017-09-29 16:25
kgv 
bugmaster 
normalintegration request 
closedfixed 
 
[OCCT] 7.2.0[OCCT] 7.2.0 
0028814: Documentation - suggest using # instead of // for temporary comments in commit description
Existing bug advancement workflow suggest the following syntax:
Minor corrections
...
Minor commits should have a single-line message starting with //. These messages will be ignored when 
the branch is squashed at integration.


The // syntax is familiar to C++ developers, but incompatible with native git tools. When using git, the automatically added comments (e.g. within merge conflict or re-base operation) are started with #, and such comments are automatically withdrawn while confirming commit description within rebase operation.

Therefore, it is proposed using # instead of // for consistency with native git tools (or allow both).
N/A
No tags attached.
Issue History
2017-06-05 16:12kgvNew Issue
2017-06-05 16:12kgvAssigned To => kgv
2017-06-05 16:15gitNote Added: 0067083
2017-06-05 16:15kgvNote Added: 0067084
2017-06-05 16:15kgvAssigned Tokgv => abv
2017-06-05 16:15kgvStatusnew => resolved
2017-06-07 11:13abvNote Added: 0067171
2017-06-07 11:13abvAssigned Toabv => bugmaster
2017-06-07 11:13abvStatusresolved => reviewed
2017-06-09 14:06bugmasterChangeset attached => occt master d2e4d7b9
2017-06-09 14:06bugmasterStatusreviewed => verified
2017-06-09 14:06bugmasterResolutionopen => fixed
2017-06-13 17:34gitNote Added: 0067354
2017-09-29 16:18aivFixed in Version => 7.2.0
2017-09-29 16:25aivStatusverified => closed

Notes
(0067083)
git   
2017-06-05 16:15   
Branch CR28814 has been created by kgv.

SHA-1: f40d05c0709d108217b81ef046cd922e0b1e9e82


Detailed log of new commits:

Author: kgv
Date: Mon Jun 5 16:15:04 2017 +0300

    0028814: Documentation - suggest using # instead of // for temporary comments in commit description
(0067084)
kgv   
2017-06-05 16:15   
Patch is ready for review.
(0067171)
abv   
2017-06-07 11:13   
No remarks, please integrate. Please also announce this change internally
(0067354)
git   
2017-06-13 17:34   
Branch CR28814 has been deleted by kgv.

SHA-1: f40d05c0709d108217b81ef046cd922e0b1e9e82