You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by fe...@apache.org on 2011/12/15 16:35:19 UTC
svn commit: r1214811 - in /directory/buildtools/studio-plugin/trunk: pom.xml
src/site/apt/index.apt src/site/fml/faq.fml
Author: felixk
Date: Thu Dec 15 15:35:19 2011
New Revision: 1214811
URL: http://svn.apache.org/viewvc?rev=1214811&view=rev
Log:
Fix documentation
Modified:
directory/buildtools/studio-plugin/trunk/pom.xml
directory/buildtools/studio-plugin/trunk/src/site/apt/index.apt
directory/buildtools/studio-plugin/trunk/src/site/fml/faq.fml
Modified: directory/buildtools/studio-plugin/trunk/pom.xml
URL: http://svn.apache.org/viewvc/directory/buildtools/studio-plugin/trunk/pom.xml?rev=1214811&r1=1214810&r2=1214811&view=diff
==============================================================================
--- directory/buildtools/studio-plugin/trunk/pom.xml (original)
+++ directory/buildtools/studio-plugin/trunk/pom.xml Thu Dec 15 15:35:19 2011
@@ -23,8 +23,9 @@
<parent>
<groupId>org.apache.directory.project</groupId>
- <version>20</version>
+ <version>26</version>
<artifactId>project</artifactId>
+ <relativePath></relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -119,6 +120,17 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <configuration>
+ <reportPlugins combine.children="append">
+ <plugin>
+ <artifactId>maven-plugin-plugin</artifactId>
+ </plugin>
+ </reportPlugins>
+ </configuration>
+ </plugin>
</plugins>
</build>
@@ -207,195 +219,4 @@
<scope>test</scope>
</dependency>
</dependencies>
-
- <reporting>
- <excludeDefaults>true</excludeDefaults>
- <plugins>
- <!--
- Note to myself:
- Plugin configuration in pluginManagement section are *not* applied to reporting plugins!
- See http://jira.codehaus.org/browse/MSITE-443
- -->
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-plugin-plugin</artifactId>
- <version>2.6</version>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-surefire-report-plugin</artifactId>
- <version>2.6</version>
- <configuration>
- <aggregate>true</aggregate>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <version>2.2</version>
- <configuration>
- <aggregate>true</aggregate>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-pmd-plugin</artifactId>
- <version>2.5</version>
- <configuration>
- <linkXref>true</linkXref>
- <sourceEncoding>utf-8</sourceEncoding>
- <minimumTokens>100</minimumTokens>
- <targetJdk>1.5</targetJdk>
- <aggregate>true</aggregate>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.2</version>
- </plugin>
-
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>taglist-maven-plugin</artifactId>
- <version>2.4</version>
- <configuration>
- <tags>
- <tag>TODO</tag>
- <tag>@todo</tag>
- <tag>@deprecated</tag>
- <tag>FIXME</tag>
- </tags>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.7</version>
- <configuration>
- <minmemory>512m</minmemory>
- <maxmemory>1g</maxmemory>
- <linksource>true</linksource>
- <tags>
- <tag>
- <name>todo</name>
- <!-- todo tag for all places -->
- <placement>a</placement>
- <head>To do:</head>
- </tag>
- </tags>
- <source>1.5</source>
- <tagletArtifacts>
- <tagletArtifact>
- <groupId>org.apache.maven.plugin-tools</groupId>
- <artifactId>maven-plugin-tools-javadoc</artifactId>
- <version>2.5.1</version>
- </tagletArtifact>
- <tagletArtifact>
- <groupId>org.codehaus.plexus</groupId>
- <artifactId>plexus-javadoc</artifactId>
- <version>1.0</version>
- </tagletArtifact>
- </tagletArtifacts>
- </configuration>
- <reportSets>
- <reportSet>
- <reports>
- <report>aggregate</report>
- <report>test-aggregate</report>
- </reports>
- </reportSet>
- </reportSets>
- </plugin>
-
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>findbugs-maven-plugin</artifactId>
- <version>2.3.1</version>
- <configuration>
- <xrefLocation>${project.reporting.outputDirectory}/../xref</xrefLocation>
- <xrefTestLocation>${project.reporting.outputDirectory}/../xref-test</xrefTestLocation>
- <!-- required by dashboard plugin and hudson -->
- <xmlOutput>true</xmlOutput>
- <effort>Max</effort>
- <findbugsXmlOutput>true</findbugsXmlOutput>
- <findbugsXmlWithMessages>true</findbugsXmlWithMessages>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>cobertura-maven-plugin</artifactId>
- <version>2.4</version>
- <configuration>
- <instrumentation>
- <excludes>
- <exclude>org/apache/directory/shared/**/*Constants.class</exclude>
- </excludes>
- </instrumentation>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.6</version>
- <configuration>
- <configLocation>directory-checks.xml</configLocation>
- <suppressionsLocation>${basedir}/src/checkstyle/suppressions.xml</suppressionsLocation>
- <suppressionsFileExpression>checkstyle.suppressions.file</suppressionsFileExpression>
- <xrefLocation>${project.reporting.outputDirectory}/../xref</xrefLocation>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>versions-maven-plugin</artifactId>
- <version>1.2</version>
- <reportSets>
- <reportSet>
- <reports>
- <report>dependency-updates-report</report>
- <report>plugin-updates-report</report>
- <report>property-updates-report</report>
- </reports>
- </reportSet>
- </reportSets>
- </plugin>
-
- <plugin>
- <groupId>org.apache.rat</groupId>
- <artifactId>apache-rat-plugin</artifactId>
- <version>0.7</version>
- <configuration>
- <excludeSubProjects>false</excludeSubProjects>
- <excludes>
- <!-- MAVEN_DEFAULT_EXCLUDES -->
- <exclude>**/target/**/*</exclude>
- <exclude>**/cobertura.ser</exclude>
- <!-- ECLIPSE_DEFAULT_EXCLUDES -->
- <exclude>**/.classpath</exclude>
- <exclude>**/.project</exclude>
- <exclude>**/.settings/**/*</exclude>
- <!-- IDEA_DEFAULT_EXCLUDES -->
- <exclude>**/*.iml</exclude>
- <exclude>**/*.ipr</exclude>
- <exclude>**/*.iws</exclude>
- <!-- MANIFEST_MF_EXCLUDES -->
- <exclude>**/MANIFEST.MF</exclude>
- <!-- Files used for testing -->
- <exclude>src/test/resources/unit/basic-clean-test/.externalToolBuilders</exclude>
- <exclude>src/test/resources/unit/basic-clean-test/maven-eclipse.xml</exclude>
- <exclude>src/test/resources/org/apache/directory/studio/maven/plugins/test-copy-repo/repo-marker.txt</exclude>
- <exclude>src/test/resources/org/apache/directory/studio/maven/plugins/test-copy-repo/org/eclipse/**</exclude>
- </excludes>
- </configuration>
- </plugin>
- </plugins>
- </reporting>
</project>
Modified: directory/buildtools/studio-plugin/trunk/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/directory/buildtools/studio-plugin/trunk/src/site/apt/index.apt?rev=1214811&r1=1214810&r2=1214811&view=diff
==============================================================================
--- directory/buildtools/studio-plugin/trunk/src/site/apt/index.apt (original)
+++ directory/buildtools/studio-plugin/trunk/src/site/apt/index.apt Thu Dec 15 15:35:19 2011
@@ -33,40 +33,40 @@ Directory Studio Maven Plugin
The directory studio maven plugin has 6 goals:
- * {{{prepare-jar-package-mojo.html}studio:prepare-jar-package}} prepares for building jar - copy artifacts not scoped "provided"
- to ${project.build.outputDirectory}/libraryPath (default is target/classes/lib)
+ * {{{./prepare-jar-package-mojo.html}studio:prepare-jar-package}} prepares for building jar - copy artifacts not scoped "provided"
+ to $\{project.build.outputDirectory\}/libraryPath (default is target/classes/lib)
- * {{{unpack-with-artifactid-prefix-mojo.html}studio:unpack-with-artifactid-prefix}} unpack an artifact in a desired location and put
+ * {{{./unpack-with-artifactid-prefix-mojo.html}studio:unpack-with-artifactid-prefix}} unpack an artifact in a desired location and put
the artifact content into a directory named like the final artifacts name (This is mainly used
to unpack a *-feature.jar).
- * {{{clean-mojo.html}studio:clean}} fork eclipse:clean and clean stuff generated by {{{eclipse-mojo.html}studio:eclipse}}
+ * {{{./clean-mojo.html}studio:clean}} fork eclipse:clean and clean stuff generated by {{{./eclipse-mojo.html}studio:eclipse}}
- * {{{replace-file-in-eclipse-artifact-mojo.html}studio:replace-file-in-eclipse-artifact}} takes a list of artifacts defined in
+ * {{{./replace-file-in-eclipse-artifact-mojo.html}studio:replace-file-in-eclipse-artifact}} takes a list of artifacts defined in
the plugin configuration section and a configured directory where the artifacts
are located (not in the local maven repository, but after a being copied e.g. to target
directory) and replaced/adds a desired file to them.
- * {{{eclipse-mojo.html}studio:eclipse}} prepares for eclipse:\
- Copy artifacts not scoped "provided" to ${basedir}/lib.\
+ * {{{./eclipse-mojo.html}studio:eclipse}} prepares for eclipse:\
+ Copy artifacts not scoped "provided" to $\{basedir\}/lib.\
Fork eclipse:eclipse goal and adapt generated files where needed.\
Fork bundle:manifest goal if configured \<skip\>false\</skip\>.\
Adapt $\{basedir\}/.classpath for artifacts not scoped "provided".\
- * {{{copy-eclipse-artifact-mojo.html}studio:copy-eclipse-artifact}} copies a set of artifacts to a configured output directory
+ * {{{./copy-eclipse-artifact-mojo.html}studio:copy-eclipse-artifact}} copies a set of artifacts to a configured output directory
by replacing the separator between artifactId and version by an underscore instead of a dash.
[]
* Usage
- * Instructions on how to use the dependency plugin can be found {{{usage.html}here}}.
+ * Instructions on how to use the dependency plugin can be found {{{./usage.html}here}}.
[]
* Build the plugin
- * Do a {{{source-repository.html}checkout}}
+ * Do a {{{./source-repository.html}checkout}}
* cd maven-studio-plugin
Modified: directory/buildtools/studio-plugin/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/directory/buildtools/studio-plugin/trunk/src/site/fml/faq.fml?rev=1214811&r1=1214810&r2=1214811&view=diff
==============================================================================
--- directory/buildtools/studio-plugin/trunk/src/site/fml/faq.fml (original)
+++ directory/buildtools/studio-plugin/trunk/src/site/fml/faq.fml Thu Dec 15 15:35:19 2011
@@ -30,21 +30,20 @@
<answer>
<p>You need to have set the skip flag to false, that the studio:eclipse goal is executed on your module.</p>
<source>
-<build>
- <plugins>
- <plugin>
- <groupId>org.apache.directory.studio</groupId>
- <artifactId>studio-maven-plugin</artifactId>
- <configuration>
- <skip>false</skip>
- </configuration>
- </plugin>
- </plugins>
-</build>
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.directory.studio</groupId>
+ <artifactId>studio-maven-plugin</artifactId>
+ <configuration>
+ <skip>false</skip>
+ </configuration>
+ </plugin>
+ </plugins>
+</build>
</source>
</answer>
</faq>
-
</part>
<part id="install">
@@ -59,17 +58,17 @@
<a href="http://maven.apache.org/guides/introduction/introduction-to-plugin-prefix-mapping.html">Introduction to
Plugin Prefix Resolution</a> or do the prefixing within your projects root pom:
<source>
-<build>
- <plugins>
- <plugin>
- <groupId>org.apache.directory.studio</groupId>
- <artifactId>studio-maven-plugin</artifactId>
- <configuration>
- <goalPrefix>studio</goalPrefix>
- </configuration>
- </plugin>
- </plugins>
-</build>
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.directory.studio</groupId>
+ <artifactId>studio-maven-plugin</artifactId>
+ <configuration>
+ <goalPrefix>studio</goalPrefix>
+ </configuration>
+ </plugin>
+ </plugins>
+</build>
</source>
</p>
</answer>