extensions/maven-plugin/xdocs/goals.xml - turbine-core - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 /*
  * Copyright 2001-2004 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
  -->

 <document>
   <properties>
     <title>Goals reference</title>
     <author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
   </properties>
   <body>
     <section name="Public goals">
       <p>These are the visible goals of the M.E.T.A. plugin, that you can use for building and
          deploying your application.
      </p>
     <goals>
       <goal>
         <a name="turbine_setup"/>
         <name>turbine:setup</name>
         <description><a href="using_meta.html#Setting_up_your_application_for_the_first_time">Setup a new Turbine web application</a></description>
       </goal>
       <goal>
         <a name="turbine_deploy"/>
         <name>turbine:deploy</name>
         <description>Deploys the Application into a local web container for testing</description>
       </goal>
       <goal>
         <a name="turbine_sql"/>
         <name>turbine:sql</name>
         <description>Build the SQL files necessary for the application</description>
       </goal>
       <goal>
         <a name="turbine_war"/>
         <name>turbine:war</name>
         <description>Generate a Turbine based Web application (war)</description>
       </goal>
       <goal>
         <a name="turbine_install_libs"/>
         <name>turbine:install-libs</name>
         <description> Updates the libraries for an inplace application</description>
       </goal>
     </goals>
     </section>
     <section name="Callback goals">
       <p>These goals are called from the M.E.T.A.-installed maven.xml file in your application. They
          hook into other plugins and allow M.E.T.A. to integrate with the regular maven build process.
      </p>
     <goals>
       <goal>
         <name>turbine:clean-clean</name>
         <description>
 <b>postGoal</b> When you run the clean:clean (or just clean) goal in your web
 application and you use inplace deployment, then the clean goal also
 removes your WEB-INF/lib and WEB-INF/classes directory. This ensures
 that no stale classes or libraries from previous compile-deploy-test
 cycles have been left behind.
         </description>
       </goal>
       <goal>
         <name>turbine:java-compile</name>
         <description>
 <b>preGoal</b> Most Turbine applications generate some classes (the Torque peer
 classes) at compile time. This preGoal ensures that java tree from
 src/java gets copied into target/src and the auto-generated classes
 are mixed in correctly.<br/>
 Also runs the om generation goals if the peer classes are out of
 date.
         </description>
       </goal>
       <goal>
         <name>turbine:java-compile</name>
         <description>
 <b>postGoal</b> For an inplace application, this updates the needed
 libraries in the <a href="tree.html#web_inf_lib">library location</a> of
 an inplace application.
         </description>
       </goal>
       <goal>
         <name>turbine:torque-datadtd</name>
         <description>
 <b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
         </description>
       </goal>
       <goal>
         <name>turbine:torque-datasql</name>
         <description>
 <b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
         </description>
       </goal>
       <goal>
         <name>turbine:torque-init</name>
         <description>
 <b>preGoal</b> Copies the schema files from src/schema into the build tree and
 replaces properties on the fly. As torque:init is run before every
 other torque goal, this preGoal ensures that all torque goals work on
 the latest schema file versions.
         </description>
       </goal>
       <goal>
         <name>turbine:torque-insert-sql</name>
         <description>
 <b>preGoal</b> Makes sure that all SQL files are up-to-date before torque tries to
 insert them into your databases.
         </description>
       </goal>
       <goal>
         <name>turbine:war-webapp</name>
         <description>
 <b>postGoal</b> Copies the Turbine specific parts of a web application (templates,
 scripts, styles, images and configuration) into the web application
 tree.
         </description>
       </goal>
     </goals>
     </section>
     <section name="Private goals">
       <p>There are a few more goals in this plugin which are for internal use and you should never
          need to call them directly.<br/>
          These goals might change from relase to release (or even between
          releases). They're not public and their function outside the M.E.T.A. plugin.jelly
          file is undefined.
      </p>
     <goals>
       <goal>
         <name>turbine:check-runtime-environment</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:check-setup-environment</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:copy-app-om</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:copy-data-dtd</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:copy-id-table-om</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:copy-om</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:copy-security-om</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:init</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:om-check</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:security-datadtd</name>
         <description>
         </description>
       </goal>
       <goal>
         <name>turbine:security-datasql</name>
         <description>
         </description>
       </goal>
     </goals>
     </section>

     <section name="Deprecated goals">
       <p>These goals should no longer be used and might be removed in a later version.</p>
     <goals>
       <goal>
         <name>turbine:webapp</name>
         <description>
           Replaced by <a href="#turbine_war">turbine:war</a>.
         </description>
       </goal>
     </goals>
     </section>

   </body>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>
	<!--
	/*
	* Copyright 2001-2004 The Apache Software Foundation.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/
	-->

	<document>
	<properties>
	<title>Goals reference</title>
	<author email="hps@intermeta.de">Henning P. Schmiedehausen</author>
	</properties>
	<body>
	<section name="Public goals">
	<p>These are the visible goals of the M.E.T.A. plugin, that you can use for building and
	deploying your application.
	</p>
	<goals>
	<goal>
	<a name="turbine_setup"/>
	<name>turbine:setup</name>
	<description><a href="using_meta.html#Setting_up_your_application_for_the_first_time">Setup a new Turbine web application</a></description>
	</goal>
	<goal>
	<a name="turbine_deploy"/>
	<name>turbine:deploy</name>
	<description>Deploys the Application into a local web container for testing</description>
	</goal>
	<goal>
	<a name="turbine_sql"/>
	<name>turbine:sql</name>
	<description>Build the SQL files necessary for the application</description>
	</goal>
	<goal>
	<a name="turbine_war"/>
	<name>turbine:war</name>
	<description>Generate a Turbine based Web application (war)</description>
	</goal>
	<goal>
	<a name="turbine_install_libs"/>
	<name>turbine:install-libs</name>
	<description> Updates the libraries for an inplace application</description>
	</goal>
	</goals>
	</section>
	<section name="Callback goals">
	<p>These goals are called from the M.E.T.A.-installed maven.xml file in your application. They
	hook into other plugins and allow M.E.T.A. to integrate with the regular maven build process.
	</p>
	<goals>
	<goal>
	<name>turbine:clean-clean</name>
	<description>
	<b>postGoal</b> When you run the clean:clean (or just clean) goal in your web
	application and you use inplace deployment, then the clean goal also
	removes your WEB-INF/lib and WEB-INF/classes directory. This ensures
	that no stale classes or libraries from previous compile-deploy-test
	cycles have been left behind.
	</description>
	</goal>
	<goal>
	<name>turbine:java-compile</name>
	<description>
	<b>preGoal</b> Most Turbine applications generate some classes (the Torque peer
	classes) at compile time. This preGoal ensures that java tree from
	src/java gets copied into target/src and the auto-generated classes
	are mixed in correctly.<br/>
	Also runs the om generation goals if the peer classes are out of
	date.
	</description>
	</goal>
	<goal>
	<name>turbine:java-compile</name>
	<description>
	<b>postGoal</b> For an inplace application, this updates the needed
	libraries in the <a href="tree.html#web_inf_lib">library location</a> of
	an inplace application.
	</description>
	</goal>
	<goal>
	<name>turbine:torque-datadtd</name>
	<description>
	<b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
	</description>
	</goal>
	<goal>
	<name>turbine:torque-datasql</name>
	<description>
	<b>preGoal</b> Ensures that the the data definition files and their dtds are copied into the build tree before running the goal.
	</description>
	</goal>
	<goal>
	<name>turbine:torque-init</name>
	<description>
	<b>preGoal</b> Copies the schema files from src/schema into the build tree and
	replaces properties on the fly. As torque:init is run before every
	other torque goal, this preGoal ensures that all torque goals work on
	the latest schema file versions.
	</description>
	</goal>
	<goal>
	<name>turbine:torque-insert-sql</name>
	<description>
	<b>preGoal</b> Makes sure that all SQL files are up-to-date before torque tries to
	insert them into your databases.
	</description>
	</goal>
	<goal>
	<name>turbine:war-webapp</name>
	<description>
	<b>postGoal</b> Copies the Turbine specific parts of a web application (templates,
	scripts, styles, images and configuration) into the web application
	tree.
	</description>
	</goal>
	</goals>
	</section>
	<section name="Private goals">
	<p>There are a few more goals in this plugin which are for internal use and you should never
	need to call them directly.<br/>
	These goals might change from relase to release (or even between
	releases). They're not public and their function outside the M.E.T.A. plugin.jelly
	file is undefined.
	</p>
	<goals>
	<goal>
	<name>turbine:check-runtime-environment</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:check-setup-environment</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:copy-app-om</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:copy-data-dtd</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:copy-id-table-om</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:copy-om</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:copy-security-om</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:init</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:om-check</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:security-datadtd</name>
	<description>
	</description>
	</goal>
	<goal>
	<name>turbine:security-datasql</name>
	<description>
	</description>
	</goal>
	</goals>
	</section>

	<section name="Deprecated goals">
	<p>These goals should no longer be used and might be removed in a later version.</p>
	<goals>
	<goal>
	<name>turbine:webapp</name>
	<description>
	Replaced by <a href="#turbine_war">turbine:war</a>.
	</description>
	</goal>
	</goals>
	</section>

	</body>
	</document>