You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2009/07/14 19:09:33 UTC
svn commit: r793977 - in
/maven/plugins/trunk/maven-project-info-reports-plugin/src:
main/java/org/apache/maven/report/projectinfo/ site/ site/apt/
site/apt/examples/
Author: dennisl
Date: Tue Jul 14 17:09:32 2009
New Revision: 793977
URL: http://svn.apache.org/viewvc?rev=793977&view=rev
Log:
o Follow our plugin documentation guidelines.
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/scm-report.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java?rev=793977&r1=793976&r2=793977&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/main/java/org/apache/maven/report/projectinfo/ScmReport.java Tue Jul 14 17:09:32 2009
@@ -63,9 +63,9 @@
protected ScmManager scmManager;
/**
- * The directory name to checkout right after the SCM url.
+ * The directory name to checkout right after the SCM URL.
*
- * @parameter expression="${project.artifactId}"
+ * @parameter default-value="${project.artifactId}"
* @required
*/
private String checkoutDirectoryName;
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/scm-report.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/scm-report.apt?rev=793977&r1=793976&r2=793977&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/scm-report.apt (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/scm-report.apt Tue Jul 14 17:09:32 2009
@@ -1,9 +1,9 @@
------
- SCM Report
+ Customize the SCM Report
------
The Maven Team
------
- 2008-07-04
+ 2009-07-14
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,12 +26,12 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-SCM Report
+Customize the SCM Report
By default, the SCM Report uses the information configured (or inherited)
- in the <<<<scm>>>> element of <<<pom.xml>>>. To override these values,
- you can configure the webAccessUrl, anonymousConnection and
- developerConnection properties.
+ in the <<<\<scm\>>>> element of <<<pom.xml>>>. To override these values,
+ you can configure the <<<webAccessUrl>>>, <<<anonymousConnection>>> and
+ <<<developerConnection>>> properties.
This feature is useful when the project website is stored in
a separate module, and you want the SCM report to give instructions for
@@ -53,7 +53,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.1.1</version>
+ <version>2.1.2</version>
<configuration>
<webAccessUrl>http://svn.example.org/viewvc/project/trunk</webAccessUrl>
<anonymousConnection>scm:svn:http://svn.example.org/repo/project/trunk</anonymousConnection>
@@ -69,7 +69,7 @@
* {How to exclude SCM anonymous access info?}
- Just do not specify the \<connection/\> tag in the \<scm/\> tag. For instance, you could have:
+ Just do not specify the <<<\<connection/\>>>> tag in the <<<\<scm/\>>>> tag. For instance, you could have:
+-----------------+
<project>
@@ -84,4 +84,4 @@
+-----------------+
<<Note>>: Due to {{{http://plexus.codehaus.org}Plexus}} design, it is not possible to specify an empty value using
- the \<anonymousConnection/\> configuration element.
+ the <<<\<anonymousConnection/\>>>> configuration element.
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt?rev=793977&r1=793976&r2=793977&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt Tue Jul 14 17:09:32 2009
@@ -5,7 +5,7 @@
<jr...@exist.com>
Pete Marvin King
------
- 2008-07-24
+ 2009-07-14
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -41,7 +41,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.1.1</version>
+ <version>2.1.2</version>
<reportSets>
<reportSet>
<reports>
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt?rev=793977&r1=793976&r2=793977&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt Tue Jul 14 17:09:32 2009
@@ -4,7 +4,7 @@
Johnny R. Ruiz III
<jr...@exist.com>
------
- 2008-07-24
+ 2009-07-14
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -33,7 +33,7 @@
* Goals Overview
- The Project Info Reports Plugin has twelve goals:
+ The Project Info Reports Plugin has thirteen goals:
* {{{cim-mojo.html}project-info-reports:cim}} is used to generate the Project Continuous Integration
System report.
@@ -60,6 +60,8 @@
* {{{plugin-management-mojo.html}project-info-reports:plugin-management}} is used to generate the
Project PluginManagement report.
+ * {{{plugins-mojo.html}project-info-reports:plugins}} is used to generate the Project Plugins report.
+
* {{{project-team-mojo.html}project-info-reports:project-team}} is used to generate the Project Team report.
* {{{scm-mojo.html}project-info-reports:scm}} is used to generate the Project Source Code Management report.
@@ -92,11 +94,11 @@
To provide you with better understanding on some usages of the Maven Project Info Reports Plugin,
you can take a look into the following examples:
- * {{{examples/selective-project-info-reports.html}Running selective project info reports}}
+ * {{{examples/selective-project-info-reports.html}Run Selective Reports}}
- * {{{examples/individual-reports.html}Running Individual Reports}}
+ * {{{examples/individual-reports.html}Run Individual Reports}}
- * {{{examples/scm-report.html}Customizing the SCM Report}}
+ * {{{examples/scm-report.html}Customize the SCM Report}}
* {{{project-info.html}Overview of the reports generated for this plugin}}
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt?rev=793977&r1=793976&r2=793977&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt Tue Jul 14 17:09:32 2009
@@ -5,7 +5,7 @@
<jr...@exist.com>
Pete Marvin King
------
- 2008-07-24
+ 2009-07-14
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -30,7 +30,7 @@
Usage
- Maven has been configured to run the project info reports by default. There's
+ Maven has been configured to create the project info reports by default. There's
no need to configure anything in your <<<pom.xml>>> to generate the project
information reports.
@@ -41,5 +41,5 @@
+------------+
would generate the project information documentation. For more information on
- how to customize the project information plugin, check the examples on the
+ how to customize the Project Information Reports Plugin, check the examples on the
{{{index.html}Introduction}} page.
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml?rev=793977&r1=793976&r2=793977&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml Tue Jul 14 17:09:32 2009
@@ -31,7 +31,7 @@
<menu name="Examples">
<item name="Run Selective Reports" href="examples/selective-project-info-reports.html"/>
<item name="Run Individual Reports" href="examples/individual-reports.html"/>
- <item name="SCM Report" href="examples/scm-report.html"/>
+ <item name="Customize the SCM Report" href="examples/scm-report.html"/>
</menu>
</body>
</project>