o Improve the wording on site.
o Move configuration example of reportSets to a separate page.
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@468787 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/site/apt/examples/configuration-date-type.apt b/src/site/apt/examples/configuration-date-type.apt
index 2c5bf0c..0bc0290 100644
--- a/src/site/apt/examples/configuration-date-type.apt
+++ b/src/site/apt/examples/configuration-date-type.apt
@@ -24,8 +24,12 @@
Using Date Type
- To generate the changelog reports using the <<<type>>> "date" as the basis for generation, set the configuration in the
- project pom as follows:
+ To generate the changelog reports showing what has changed between two dates,
+ you should use the "date" <<<type>>>.
+
+ With the following configuration, the generated reports will cover SCM
+ activities between Aug 1, 2005 to Sept 1, 2005. Please note that the date
+ range is inclusive.
+-----+
<project>
@@ -49,6 +53,3 @@
...
</project>
+-----+
-
- The generated changelog reports will cover SCM activities between Aug 1, 2005 to Sept 1, 2005. Please note that the
- date range is inclusive.
diff --git a/src/site/apt/examples/configuration-range-type.apt b/src/site/apt/examples/configuration-range-type.apt
index 1ab7b5e..33bbae1 100644
--- a/src/site/apt/examples/configuration-range-type.apt
+++ b/src/site/apt/examples/configuration-range-type.apt
@@ -24,8 +24,11 @@
Using Range Type
- To generate the changelog reports using the <<<type>>> "range" as the basis for generation, set the configuration in the
- project pom as follows:
+ To generate the changelog reports showing what has changed in the last NN
+ days, you should use the "range" <<<type>>>.
+
+ The following configuration will generate reports that covers SCM activities
+ from the last 30 days. Please note that the range is inclusive.
+-----+
<project>
@@ -35,19 +38,10 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changelog-plugin</artifactId>
- <reportSets>
- <reportSet>
- <id>dual-report</id>
- <configuration>
- <type>range</type>
- <range>30</range>
- </configuration>
- <reports>
- <report>changelog</report>
- <report>file-activity</report>
- </reports>
- </reportSet>
- </reportSets>
+ <configuration>
+ <type>range</type>
+ <range>30</range>
+ </configuration>
</plugin>
</plugins>
</reporting>
@@ -55,5 +49,3 @@
</project>
+-----+
- The above configuration will generate the changelog and file-activity reports that covers SCM activities from the last
- 30 days. Please note that the range is inclusive.
diff --git a/src/site/apt/examples/configuration-tag-type.apt b/src/site/apt/examples/configuration-tag-type.apt
index 357a39b..cc7b2c0 100644
--- a/src/site/apt/examples/configuration-tag-type.apt
+++ b/src/site/apt/examples/configuration-tag-type.apt
@@ -24,8 +24,11 @@
Using Tag Type
- To generate the changelog reports using the <<<type>>> "tag" as the basis for generation, set the configuration in the
- project pom as follows:
+ To generate the changelog reports showing what has changed between two tags,
+ you should use the "tag" <<<type>>>.
+
+ With the following configuration, reports will be generated that covers SCM
+ activities between the <<<alpha-2>>> tag and the <<<alpha-3>>> tag.
+-----+
<project>
@@ -35,27 +38,16 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changelog-plugin</artifactId>
- <reportSets>
- <reportSet>
- <id>dev-only</id>
- <configuration>
- <type>tag</type>
- <tags>
- <tag implementation="java.lang.String">alpha-2</tag>
- <tag implementation="java.lang.String">alpha-3</tag>
- </tags>
- </configuration>
- <reports>
- <report>dev-activity</report>
- </reports>
- </reportSet>
- </reportSets>
+ <configuration>
+ <type>tag</type>
+ <tags>
+ <tag implementation="java.lang.String">alpha-2</tag>
+ <tag implementation="java.lang.String">alpha-3</tag>
+ </tags>
+ </configuration>
</plugin>
</plugins>
</reporting>
...
</project>
+-----+
-
- With the above configuration, a dev-activity report that covers SCM activities between alpha-2 tag to alpha-3 tag will
- be generated.
\ No newline at end of file
diff --git a/src/site/apt/examples/selecting-reports.apt b/src/site/apt/examples/selecting-reports.apt
new file mode 100644
index 0000000..a231999
--- /dev/null
+++ b/src/site/apt/examples/selecting-reports.apt
@@ -0,0 +1,62 @@
+ ------
+ Selecting Reports
+ ------
+ Dennis Lundberg
+ ------
+ October 2006
+ ------
+
+ ~~ Copyright 2006 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.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+
+Selecting Reports
+
+ The plugin normally generates 3 reports: changelog, dev-activity and
+ file-activity. It is possible to configure the plugin so that only a few of
+ these reports are generated. This is done using <<<\<reportSets\>>>>.
+
+ The following configuration will generate only the changelog and file-activity
+ reports.
+
++-----+
+<project>
+ ...
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-changelog-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <id>dual-report</id>
+ <configuration>
+ <type>range</type>
+ <range>30</range>
+ </configuration>
+ <reports>
+ <report>changelog</report>
+ <report>file-activity</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+ ...
+</project>
++-----+
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index a1d7397..6472009 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -34,13 +34,13 @@
The Changelog Plugin has three goals:
* {{{changelog-mojo.html}changelog:changelog}} generates the changelog report. The changelog report shows all the SCM activities
- including the dates, files, and author of the revisions that occurred during the specified change sets.
+ including the dates, files, and author of the revisions that occurred during the specified change set.
* {{{dev-activity-mojo.html}changelog:dev-activity}} generates the developer activity report. The dev-activity report shows a
summary of the total commits, and the number of files changed of each developer listed in the project descriptor.
* {{{file-activity-mojo.html}changelog:file-activity}} generates the file activity report. The file-activity report lists all
- files that we're revised during the specified change set. It is arranged in a way where the file with the most number of revisions is listed first.
+ files that were revised during the specified change set. It is arranged in a way where the file with the most number of revisions is listed first.
* Usage
@@ -50,6 +50,8 @@
The following examples show how to use the Changelog Plugin in more advanced use-cases:
+ * {{{examples/selecting-reports.html}Selecting Reports}}
+
* {{{examples/configuration-date-type.html}Using Date Type}}
* {{{examples/configuration-range-type.html}Using Range Type}}
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index fab4c52..fffd6dd 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -24,11 +24,15 @@
Usage
- The reports may use either range, date, or tag as basis in generating the reports. Only one can be set. The change sets then
- can be configured by setting the correct parameter depending on the type chosen. If <<<type>>> "date" is chosen, then the parameter
- <<<date>>> should contain the values of the set ranges. This goes for "range" and "tag" types as well.
+ The reports may use either <<<range>>>, <<<date>>>, or <<<tag>>> as the basis
+ for generating the reports. Only one can be set. The change sets can be
+ configured by setting the correct parameter for the chosen type. If <<<type>>>
+ "date" is chosen, then the parameter <<<dates>>> should contain the start and
+ stop dates for the date range. Similar configurations should be made for the
+ "range" and "tag" types.
- To generate the changelog reports, just add the following in your project's pom:
+ To generate the changelog reports, just add the following in your project's
+ <<<pom.xml>>>:
+-----+
<project>
@@ -45,9 +49,10 @@
</project>
+-----+
- Aside from the required plugin configuration parameters needed to generate the reports, all reports will refer to the scm
- elements inside the project descriptor for other details regarding the connection to the project's scm. An example of the
- scm element inside the pom.xml is as follows:
+ Aside from the required plugin configuration parameters needed to generate the
+ reports, all reports will refer to the <<<scm>>> elements inside the project
+ descriptor for other details regarding the connection to the project's SCM.
+ Here is an example of the scm element inside the <<<pom.xml>>>:
-------------------
<project>
@@ -61,11 +66,12 @@
</project>
-------------------
- Please refer to the Maven project descriptor for the description of the scm elements. It can be found
+ Please refer to the Maven project descriptor for the description of the
+ <<<scm>>> elements. It can be found
{{{http://maven.apache.org/ref/current/maven-model/maven.html#class_scm}here}}.
- When you execute <<<mvn site>>>, you will see that the changelog, dev-activity and file-activity reports are included in
- the generated site.
+ When you execute <<<mvn site>>>, you will see that the changelog, dev-activity
+ and file-activity reports are included in the generated site.
Sample Changelog report:
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index 4549f51..f280c96 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -33,10 +33,10 @@
<question>What is Software Configuration Management or SCM?</question>
<answer>
<p>
- According to Roger Pressman (in his book) Software Engineering: A Practitioner's Approach, SCM is a "set of activities
+ According to Roger Pressman (in his book) Software Engineering: A Practitioner's Approach, SCM is a <em>"set of activities
designed to control change by identifying the work products that are likely to change, establishing relationships among
them, defining mechanisms for managing different versions of these work products, controlling the changes imposed, and
- auditing and reporting on the changes made."
+ auditing and reporting on the changes made."</em>
</p>
</answer>
</faq>
diff --git a/src/site/site.xml b/src/site/site.xml
index 62bfd36..0d5edbb 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,6 +19,7 @@
<project>
<body>
<menu name="Examples">
+ <item name="Selecting Reports" href="/examples/selecting-reports.html"/>
<item name="Using Date Type" href="/examples/configuration-date-type.html"/>
<item name="Using Range Type" href="/examples/configuration-range-type.html"/>
<item name="Using Tag Type" href="/examples/configuration-tag-type.html"/>
