[weld-commits] Weld SVN: r6588 - archetypes/trunk/javaee6-webapp-src.

weld-commits at lists.jboss.org weld-commits at lists.jboss.org
Thu Jul 8 17:34:30 EDT 2010


Author: dan.j.allen
Date: 2010-07-08 17:34:30 -0400 (Thu, 08 Jul 2010)
New Revision: 6588

Modified:
   archetypes/trunk/javaee6-webapp-src/pom.xml
Log:
add/revise comments


Modified: archetypes/trunk/javaee6-webapp-src/pom.xml
===================================================================
--- archetypes/trunk/javaee6-webapp-src/pom.xml	2010-07-08 21:07:33 UTC (rev 6587)
+++ archetypes/trunk/javaee6-webapp-src/pom.xml	2010-07-08 21:34:30 UTC (rev 6588)
@@ -12,14 +12,13 @@
 
    <properties>
       <!-- Explicitly declaring the source encoding eliminates the following message: -->
-      <!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent!      -->
+      <!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered resources, i.e. build is platform dependent! -->
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-      <!--Timestamp format for the maven.build.timestamp property; -->
-      <!--you can reference property in pom.xml or filtered resources (must enable third-party plugin if using Maven < 2.1)-->
+      <!-- Timestamp format for the maven.build.timestamp property -->
+      <!-- You can reference property in pom.xml or filtered resources (must enable third-party plugin if using Maven < 2.1) -->
       <maven.build.timestamp.format>yyyyMMdd'T'HHmmss</maven.build.timestamp.format>
-      <!--
-         To set the jboss.home environment variable the Maven way, set the jboss.home property in an active profile in the Maven 2 settings.xml file
-      -->
+      <!-- Set the jboss.home property in an active profile of the $HOME/.m2/settings.xml to specify the JBoss AS directory the "Maven way" -->
+      <!-- By default, we assign it to the value of the JBOSS_HOME envrionment variable -->
       <jboss.home>${env.JBOSS_HOME}</jboss.home>
       <jboss.domain>default</jboss.domain>
       <arquillian.version>1.0.0-SNAPSHOT</arquillian.version>
@@ -27,14 +26,14 @@
    </properties>
 
    <repositories>
-      <!-- The JBoss public Nexus repository is a composite repository of several major repositories -->
+      <!-- The JBoss Community public repository is a composite repository of several major repositories -->
       <!-- see http://community.jboss.org/wiki/MavenGettingStarted-Users -->
-      <!-- At the time of writing, Arquillian and the JBoss Spec POMs have newer versions in the JBoss repo than Maven central. -->
+      <!-- At the time of writing, Arquillian and the JBoss Spec POMs are only in the JBoss Community public repository (not Maven central) -->
       <repository>
          <id>jboss-public-repository</id>
          <name>JBoss Repository</name>
          <url>https://repository.jboss.org/nexus/content/groups/public</url>
-         <!-- These optional flags are designed to speed up your builds by reducing remote server calls. -->
+         <!-- These optional flags are designed to speed up your builds by reducing remote server calls -->
          <releases>
             <enabled>true</enabled>
             <updatePolicy>never</updatePolicy>
@@ -51,7 +50,7 @@
          <id>jboss-public-repository</id>
          <name>JBoss Repository</name>
          <url>https://repository.jboss.org/nexus/content/groups/public</url>
-         <!-- These optional flags are designed to speed up your builds by reducing remote server calls. -->
+         <!-- These optional flags are designed to speed up your builds by reducing remote server calls -->
          <releases>
             <enabled>true</enabled>
             <updatePolicy>never</updatePolicy>
@@ -59,7 +58,6 @@
          <snapshots>
             <!-- Set to true to fix error in which Maven cannot find org.apache.maven.plugins:maven-archetype-plugin:maven-plugin:2.0-alpha-6-SNAPSHOT -->
             <enabled>true</enabled>
-            <!-- <enabled>false</enabled>-->
             <updatePolicy>daily</updatePolicy>
          </snapshots>
       </pluginRepository>
@@ -89,15 +87,15 @@
          <version>4.0.0.GA</version>
          <scope>provided</scope>
       </dependency>
-      <!-- Optional, but highly recommended. -->
+      <!-- Needed for running tests (you may also use TestNG) -->
       <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.8.1</version>
          <scope>test</scope>
       </dependency>
-      <!-- Optional, but highly recommended. -->
-      <!-- Arquillian allows you to test enterprise code such as EJBs and Transactional JPA from JUnit/TestNG. -->
+      <!-- Optional, but highly recommended -->
+      <!-- Arquillian allows you to test enterprise code such as EJBs and Transactional JPA from JUnit/TestNG -->
       <dependency>
          <groupId>org.jboss.arquillian</groupId>
          <artifactId>arquillian-junit</artifactId>
@@ -117,7 +115,7 @@
             <configuration>
                <source>1.6</source>
                <target>1.6</target>
-               <!-- Please note you have to compile twice after changing an @Entity class -->
+               <!-- Please note you have to compile twice after changing an @Entity class in order for the JPA metamodel to be compiled -->
                <generatedSourcesDirectory>src/main/java</generatedSourcesDirectory>
             </configuration>
          </plugin>
@@ -126,13 +124,15 @@
 
    <profiles>
       <profile>
+         <!-- The default profile skips all tests, though you can tune it to run just unit tests -->
+         <!-- Seperate profiles are provided for running all tests, including Arquillian tests, which execute in the specified container -->
          <id>default</id>
          <activation>
             <activeByDefault>true</activeByDefault>
          </activation>
          <dependencies>
             <!-- Java EE Specification POM -->
-            <!-- This one dependency imports all APIs available for a Java EE 6.0 application. -->
+            <!-- This one dependency imports all APIs available for a Java EE 6.0 application -->
             <dependency>
                <groupId>org.jboss.spec</groupId>
                <artifactId>jboss-javaee-6.0</artifactId>
@@ -150,8 +150,8 @@
                      <skip>true</skip>
                   </configuration>
                </plugin>
-               <!-- Optional JBoss deployer plugin will deploy your war to a local JBoss AS container if you've declared $JBOSS_HOME in your OS.-->
-               <!-- To use, declare $JBOSS_HOME and run 'mvn package jboss:hard-deploy' -->
+               <!-- Optional JBoss deployer plugin will deploy your war to a local JBoss AS container if you've declared $JBOSS_HOME in your OS -->
+               <!-- To use, set the JBOSS_HOME environment variable (or jboss.home in $HOME/.m2/settings.xml) and run 'mvn package jboss:hard-deploy' -->
                <plugin>
                   <groupId>org.codehaus.mojo</groupId>
                   <artifactId>jboss-maven-plugin</artifactId>
@@ -161,7 +161,7 @@
                      <serverName>${jboss.domain}</serverName>
                      <fileNames>
                         <fileName>${project.build.directory}/${project.build.finalName}.war</fileName>
-                        <!-- JNDI Datasource hitting Derby to demonstrate JPA. -->
+                        <!-- JNDI Datasource that connects to in-memory HSQLDB to demonstrate JPA -->
                         <fileName>src/main/resources-jbossas/default-ds.xml</fileName>
                         <fileName>${project.build.directory}/${project.build.finalName}.war</fileName>
                      </fileNames>
@@ -172,6 +172,8 @@
       </profile>
 
       <profile>
+         <!-- An Arquillian testing profile that executes tests in GlassFish Embedded -->
+         <!-- Run with 'mvn test -Pglassfish-embedded-3' -->
          <id>glassfish-embedded-3</id>
          <dependencies>
             <dependency>
@@ -180,7 +182,7 @@
                <version>${arquillian.version}</version>
                <scope>test</scope>
             </dependency>
-            <!-- This imports all APIs needed for a Java EE 6 application. -->
+            <!-- This imports the Java EE 6 runtime provided by GlassFish Embedded -->
             <dependency>
                <groupId>org.glassfish.extras</groupId>
                <artifactId>glassfish-embedded-all</artifactId>
@@ -193,7 +195,7 @@
                <testResource>
                   <directory>src/test/resources</directory>
                </testResource>
-               <!-- Overrides default configuration to use alternate persistence.xml with eclipselink settings and declare a Glassfish Datasource. -->
+               <!-- Overrides default configuration to use alternate persistence.xml with eclipselink settings and declare a Glassfish Datasource -->
                <!-- Used by Arquillian -->
                <testResource>
                   <directory>src/test/resources-glassfish-embedded</directory>
@@ -206,10 +208,10 @@
                   <version>2.4.3</version>
                   <configuration>
                      <systemProperties>
-                        <!-- This optional property fixes an annoyance with Glassfish that puts derby.log in the project root.  -->
+                        <!-- This optional property fixes an annoyance with Glassfish that puts derby.log in the project root -->
                         <property>
                            <name>derby.stream.error.file</name>
-                           <!-- If you save the log in target it is less likely to get committed in your project. -->
+                           <!-- If you save the log in target it is less likely to get committed in your project -->
                            <value>target/derby.log</value>
                         </property>
                      </systemProperties>
@@ -219,6 +221,8 @@
          </build>
       </profile>
       <profile>
+         <!-- An Arquillian testing profile that executes tests in a remote JBoss AS instance -->
+         <!-- Run with 'mvn test -Pjbossas-remote-6' -->
          <id>jbossas-remote-6</id>
          <dependencies>
             <dependency>
@@ -228,7 +232,7 @@
                <scope>test</scope>
             </dependency>
             <!-- Java EE Specification POM -->
-            <!-- This one dependency imports all APIs available for a Java EE 6.0 application. -->
+            <!-- This one dependency imports all APIs available for a Java EE 6.0 application -->
             <dependency>
                <groupId>org.jboss.spec</groupId>
                <artifactId>jboss-javaee-6.0</artifactId>
@@ -250,7 +254,7 @@
                <testResource>
                   <directory>src/test/resources</directory>
                </testResource>
-               <!-- Overrides default configuration to use alternate persistence.xml with Hibernate settings and declare a JBossAS Datasource. -->
+               <!-- Overrides default configuration to use alternate persistence.xml with Hibernate settings and declare a JBoss AS Datasource -->
                <!-- Used by Arquillian -->
                <testResource>
                   <directory>src/test/resources-jbossas</directory>



More information about the weld-commits mailing list