db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] Created: (DERBY-4809) Systematically add header comments to our public ant targets.
Date Tue, 21 Sep 2010 19:18:33 GMT
Systematically add header comments to our public ant targets.
-------------------------------------------------------------

                 Key: DERBY-4809
                 URL: https://issues.apache.org/jira/browse/DERBY-4809
             Project: Derby
          Issue Type: Improvement
          Components: Build tools
            Reporter: Rick Hillegas


Ant expects that you will document your public targets so that ant scripts are self-describing.
The following command prints out the header comments on your public targets:

ant -projecthelp

Here's what you that command prints out today when issued in the top directory of a Derby
subversion client. As you can see, we could do a more thorough job of commenting our public
build targets:

Main targets:

 checkCompilerLevel     Make sure compiler level is Java 5 level or higher.
 class_size_catalog     create the class size catalog -- a java file
 cleancatalog           Remove the generated catalog java file.
 cleantoursdb           Remove the generated sample database.
 parsers                Build the parsers
 setCompilerProperties  Set the ant variables which identify the compiler classpaths. Remove
the autosetProps logic when this target becomes mandatory.
 setInitialProperties   Set the initial properties for this build script. This duplicates
the property setting block in setCompilerProperties. Once we make setCompilerProperties mandatory,
this target should be removed.
 state                  Build SanityState.java
Default target: buildsource

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message