dev@glassfish.java.net

Code review request: POM file changes to integrate admin/util man pages

From: Paul M Davies (Oracle) <"Paul>
Date: Mon, 08 Nov 2010 08:57:47 -0800

Hi,

To integrate the man pages in the admin/util module, I have edited the
following files in the v3 repo:

    * pom.xml
    * admin/util/pom.xml

SVN diffs:

Index: pom.xml
===================================================================
--- pom.xml (revision 42426)
+++ pom.xml (working copy)
@@ -167,7 +167,7 @@
         <findbugs.exclude></findbugs.exclude>
         <btrace.version>1.0.5</btrace.version>
         <opendmk.version>1.0-b01-ea</opendmk.version>
- <v3-docs.version>3.1-b02</v3-docs.version>
+ <v3-docs.version>3.1-b04</v3-docs.version>
         <l10n.version>3.0-b73</l10n.version>
         <asm.version>3.1</asm.version>
         <shoal.version>1.5.20</shoal.version>

Index: admin/util/pom.xml
===================================================================
--- admin/util/pom.xml (revision 42426)
+++ admin/util/pom.xml (working copy)
@@ -81,6 +81,32 @@
                     </archive>
                 </configuration>
             </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>unpack</id>
+ <phase>process-classes</phase>
+ <goals>
+ <goal>unpack</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+
<groupId>org.glassfish.docs.man</groupId>
+
<artifactId>admin-util-manpage</artifactId>
+
<version>${v3-docs.version}</version>
+ <type>jar</type>
+ <overWrite>true</overWrite>
+
<outputDirectory>${project.build.outputDirectory}</outputDirectory>
+ <excludes>META-INF/**</excludes>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
         </plugins>
         <resources>
             <resource>
@@ -89,6 +115,12 @@
                     <include>**/*.properties</include>
                 </includes>
             </resource>
+ <resource>
+ <directory>src/main/resources</directory>
+ <includes>
+ <include>**/*.1</include>
+ </includes>
+ </resource>
         </resources>
     </build>
     <dependencies>

Tests that I ran:

   1. mvn clean install: build successful
   2. jar tf glassfish/modules/admin-util.jar: man pages packaged correctly
   3. asadmin start-domain: domain started successfully
   4. asadmin --help for each subcommand in the module: man page
      displayed correctly

I have also attached the files that I edited for reference.

Regards,
-Paul Davies


-- 
Oracle <http://www.oracle.com>
Paul Davies| Principal Technical Writer| +1.408.276.3413
Oracle GlassFish Server Documentation
4140 Network Circle, Santa Clara CA 95054, USA
Green Oracle <http://www.oracle.com/commitment> 	Oracle is committed to 
developing practices and products that help protect the environment
-- 
Oracle <http://www.oracle.com>
Paul Davies| Principal Technical Writer| +1.408.276.3413
Oracle GlassFish Server Documentation
4140 Network Circle, Santa Clara CA 95054, USA
Green Oracle <http://www.oracle.com/commitment> 	Oracle is committed to 
developing practices and products that help protect the environment