harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Tim Ellison <t.p.elli...@gmail.com>
Subject Re: [OT] new tools for Harmony
Date Wed, 24 Oct 2007 09:12:11 GMT
Regis wrote:
> Tim Ellison wrote:
>> Regis wrote:
>>> JavaCC is BSD licensed, it convert grammar file to java file, and
>>> according to it's FAQ[2], the java files produced by javacc
>>> can be used in any way.
>>>
>>> And javacc created java files with first line like this:
>>> "/* Generated By:JavaCC: Do not edit this line. FilterParser.java */"
>>>
>>> Is it acceptable?
>>
>> Yep.  Please ensure that you also contribute the grammar files that you
>> write as input to javacc.  Both the grammar files and the resulting java
>> files should have the ASF standard block comments at the top and be
>> checked into SVN.  It's probably a good idea to also keep the 'Do not
>> edit' instruction just so people know.
>>
> So we must move the 'Do not edit' instruction below the ASF standard block
> comments.

It is not strictly necessary for the ASF comment to be the very first
thing in the file, but given that it is first by convention I would say
you should move the instruction below if it does not require a great effort.

> And I think we should add a additional 'README' file, give some
> instruments about
> how to use the grammar files and generated source files.

Yes, instructions to make the process reproducible are important.

Thanks,
Tim

Mime
View raw message