[Building Sakai] SAK-15801: Commenting syntax for conversion scripts

[David Haines]

+1

David Haines
CTools Developer
Digital Media Commons
University of Michigan
dlhaines at umich.edu



On Mar 30, 2009, at 4:05 PM, Anthony Whyte wrote:

> +1
>
> Anth
>
> On Mar 30, 2009, at 3:12 PM, May, Megan Marie wrote:
>
>> Hi everyone,
>>
>>    It’s been raised that the DB upgrade scripts in /reference/ 
>> conversion contain incorrect comment syntax that can break the  
>> script (ie manual intervention/resolution is necessary).
>>
>> The offending lines are those like:
>>
>> ----------------
>>
>> This is invalid for MySQL which requires a space, whitespace or  
>> control character after the first two dashes.
>>
>> ie
>>
>> -- this is a comment
>>
>> --this is an invalid comment
>>
>> ------------------ is just a bunch of dashes that will break
>>
>>
>>
>> MySQL syntax notation: http://dev.mysql.com/doc/refman/5.1/en/comments.html
>>
>>
>>
>> Note that the interpretation of the standard is different in MySQL  
>> and Oracle.
>>
>>
>>
>> Oracle DOES NOT support the # character and will execute anything  
>> inside it.
>>
>> Oracle DOES support ----------------- as a comment line
>>
>>
>>
>> The only consistent comment syntax between the two is:
>>
>>
>>
>> /* this is a comment */
>>
>>
>>
>> This can also be used as multiline comments:
>>
>>
>>
>> /* this is
>>
>> a
>>
>> multiline
>>
>> comment
>>
>> */
>>
>>
>>
>> Steve Swinsburg has proposed that all upgrade scripts from the 2.4  
>> series onwards be updated to this cross vendor syntax, /* */ to  
>> save possible upgrade headaches.  This proposal was well received  
>> at the last QA / Release WG meeting.  Before making the plunge, I’d  
>> like to gather wider support and or comments for the practice.
>>
>> This JIRA tracking this proposal is http://bugs.sakaiproject.org/jira/browse/SAK-15801
>>
>>
>>
>> +1, -1, 0?
>>
>>
>>
>> Megan
>>
>> _______________________________________________
>> sakai-dev mailing list
>> sakai-dev at collab.sakaiproject.org
>> http://collab.sakaiproject.org/mailman/listinfo/sakai-dev
>>
>> TO UNSUBSCRIBE: send email to sakai-dev-unsubscribe at collab.sakaiproject.org 
>>  with a subject of "unsubscribe"
>
> _______________________________________________
> sakai-dev mailing list
> sakai-dev at collab.sakaiproject.org
> http://collab.sakaiproject.org/mailman/listinfo/sakai-dev
>
> TO UNSUBSCRIBE: send email to sakai-dev-unsubscribe at collab.sakaiproject.org 
>  with a subject of "unsubscribe"

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/sakai-dev/attachments/20090330/4c713a57/attachment.html