Hi,

JIRA TRAFODION-2283 notes that our Messages Guide is getting increasingly 
out-of-date with respect to the code.

I recently developed a script (see JIRA TRAFODION-2380) which measures the 
differences between the Messages Guide and the code. With the latest Trafodion 
code, we have 579 matching messages and 2864 mismatching messages.

Analyzing the differences, it's clear that some work was done on the Messages 
Guide side to improve the English but that text didn't get back into the code. 
Meanwhile, SqlciErrors.txt has evolved significantly as new errors have been 
added and old ones changed. So there is a rather lengthy picking-and-choosing 
exercise required to bring them back into sync, selecting the best text from 
each.

Going forward, I think it would be good for developers to get into the habit of 
updating the Messages Guide when they update SqlciErrors.txt.

One way to make this happen would be to add a Jenkins Build-time check that 
measures the difference (as the script above does) and insures that the 
difference isn't getting larger with the check-in. JIRA TRAFODION-2390 
describes this idea.

What do you think? Is this a good idea? Please feel free to comment in the JIRA 
itself. Here's a link: https://issues.apache.org/jira/browse/TRAFODION-2390

Thanks,

Dave


Reply via email to