From fe4a78733e702fe0bb6a9d20116fcbd6bf7d230f Mon Sep 17 00:00:00 2001 From: ltheussl Date: Sat, 1 Oct 2005 07:06:46 +0000 Subject: [PATCH] Make all plugin xdocs validate git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@292933 13f79535-47bb-0310-9956-ffa450edef68 --- abbot/xdocs/using.xml | 12 ++++----- artifact/xdocs/examples.xml | 3 +-- artifact/xdocs/security.xml | 5 ++-- artifact/xdocs/tags.xml | 34 +++++++++++++++++-------- castor/xdocs/examples.xml | 6 ++--- clean/xdocs/properties.xml | 2 +- clover/xdocs/properties.xml | 2 +- console/xdocs/tasks.xml | 2 -- dashboard/xdocs/index.xml | 5 ++-- dashboard/xdocs/technical.xml | 18 ++++++------- developer-activity/xdocs/properties.xml | 4 +-- ear/xdocs/properties.xml | 4 +-- eclipse/xdocs/goals.xml | 7 +++-- eclipse/xdocs/index.xml | 2 +- ejb/xdocs/index.xml | 2 +- faq/xdocs/goals.xml | 3 +-- file-activity/xdocs/properties.xml | 4 +-- genapp/xdocs/customization_guide.xml | 4 ++- gump/xdocs/goals.xml | 12 +++------ hibernate/xdocs/goals.xml | 15 +++++------ html2xdoc/xdocs/goals.xml | 3 +-- j2ee/xdocs/appserver.xml | 2 +- j2ee/xdocs/dirlayout.xml | 2 +- j2ee/xdocs/futures.xml | 2 +- j2ee/xdocs/goals.xml | 11 ++++---- j2ee/xdocs/properties.xml | 2 +- jcoverage/xdocs/navigation.xml | 6 ++--- jdepend/xdocs/index.xml | 2 +- jellydoc/xdocs/goals.xml | 3 +-- linkcheck/xdocs/index.xml | 2 -- multiproject/xdocs/reports.xml | 2 +- nsis/xdocs/customizing.xml | 4 ++- nsis/xdocs/process.xml | 2 +- simian/xdocs/goals.xml | 3 +-- tasklist/xdocs/goals.xml | 6 ++--- uberjar/xdocs/goals.xml | 4 +-- uberjar/xdocs/tasks.xml | 2 +- war/xdocs/properties.xml | 5 ++-- 38 files changed, 101 insertions(+), 108 deletions(-) diff --git a/abbot/xdocs/using.xml b/abbot/xdocs/using.xml index cc20fe84..6208c59d 100644 --- a/abbot/xdocs/using.xml +++ b/abbot/xdocs/using.xml @@ -29,15 +29,15 @@
-
+

There are no pre-requisites.

-
+
-
+

The following environmental dependencies need to be present before executing the Abbot plugin: @@ -49,8 +49,8 @@ page for the details. -

-
+ +

The following limitations are known for the abbot:test-webstart goal: @@ -63,7 +63,7 @@ to do so (granted if the jar are signed). -

+
diff --git a/artifact/xdocs/examples.xml b/artifact/xdocs/examples.xml index 30476010..bd4d56fd 100644 --- a/artifact/xdocs/examples.xml +++ b/artifact/xdocs/examples.xml @@ -29,7 +29,7 @@

The following example demonstrates how to depoyment of artifact to remote repositories can be configured. - +

-

diff --git a/artifact/xdocs/security.xml b/artifact/xdocs/security.xml index 39c73814..ad5287dc 100644 --- a/artifact/xdocs/security.xml +++ b/artifact/xdocs/security.xml @@ -26,8 +26,7 @@
-

- + > For the moment I have tested my API with username, user password @@ -57,7 +56,7 @@ It should be used only from command files. incze ]]> -

+
diff --git a/artifact/xdocs/tags.xml b/artifact/xdocs/tags.xml index a35f3f8b..7789fd42 100644 --- a/artifact/xdocs/tags.xml +++ b/artifact/xdocs/tags.xml @@ -58,13 +58,14 @@

Deploy an artifact to the set of remote repositories. -
+

+

Following files will be deployed to remote repository: +

  1. Artifact file
  2. MD5 checksum file of this artifact
-

@@ -106,8 +107,10 @@

Deploy a snapshot version of the artifact to a set of remote repositories. -
+

+

During deloyment following files are put to remote repository: +

  • Timestamped Artifact file
  • MD5 checksum file of timestamped artifact file
    • @@ -115,8 +118,10 @@
  • MD5 checksum file of this file
  • ${artifactId}-snapshot-version
+

For example for artifact with artifactId = foo the following files will be transferred to the remote repository: +

  • foo-20030620.124616.jar
  • foo-20030620.124616.jar.md5
    • @@ -124,14 +129,15 @@
  • foo-SNAPSHOT.jar.md5
  • foo-snapshot-version
- +

File foo-snapshot-version contains the version number (20030620.124616) that the snapshot is linked to, so that 'convert-snapshots' can correctly update dependencies in projects that will use this artifact. -
+

+

artifact:deploy-snapshot tag uses the same set of attributes as artifact:deploy tag

@@ -139,19 +145,22 @@

Install an artifact in the local repository -
+

+

Following files will be copied to the local repository: +

  1. Artifact file
  2. MD5 checksum file of this artifact
-

Why should I use artifact:install when it is so easy to copy a file inside my plugin? -
+

+

There are few good reason for that: +

  • Although simple now, it will not necessarily remain that way @@ -168,7 +177,6 @@ usage of Ant.
-

Attribute NameDescriptionOptional?
@@ -204,19 +212,23 @@

Install a snapshot version of the artifact in the local repository -
+

+

Following files are copied to the local repository: +

  • Timestamped Artifact file
  • Artifact file with version marked as SNAPSHOT
+

For exaple for artifact with artifactId foo following files will be transfered to local repository: +

  • foo-20030620.124616.jar
  • foo-SNAPSHOT.jar
-
+

artifact:install-snapshot tag uses the same set of attributes as artifact:install tag

diff --git a/castor/xdocs/examples.xml b/castor/xdocs/examples.xml index bc1a4a7b..32f54c09 100644 --- a/castor/xdocs/examples.xml +++ b/castor/xdocs/examples.xml @@ -30,7 +30,7 @@ The following generates java sources for the foo.xsd' schema, in the 'com.foo.bar' package. The sources will use Java 2 collection types. - +

@@ -41,12 +41,11 @@ ]]> -

The following generates java sources for the 'bar.xsd' schema. The sources will not included marshalling support (marshal, unmarshal, validate). - +

@@ -56,7 +55,6 @@ ]]> -

diff --git a/clean/xdocs/properties.xml b/clean/xdocs/properties.xml index 94daf643..6ec40b92 100644 --- a/clean/xdocs/properties.xml +++ b/clean/xdocs/properties.xml @@ -26,7 +26,7 @@
- No properties. +

No properties.

diff --git a/clover/xdocs/properties.xml b/clover/xdocs/properties.xml index 96d83d24..e52432d6 100644 --- a/clover/xdocs/properties.xml +++ b/clover/xdocs/properties.xml @@ -21,8 +21,8 @@ - Vincent Massol Maven Clover plugin properties + Vincent Massol diff --git a/console/xdocs/tasks.xml b/console/xdocs/tasks.xml index 26799212..bb4a4bb6 100644 --- a/console/xdocs/tasks.xml +++ b/console/xdocs/tasks.xml @@ -26,14 +26,12 @@
-

  • Find a way to switch projects easily, so that we load all the plugins once for all projects.
-

diff --git a/dashboard/xdocs/index.xml b/dashboard/xdocs/index.xml index 28214e14..7ea4dfe5 100644 --- a/dashboard/xdocs/index.xml +++ b/dashboard/xdocs/index.xml @@ -55,8 +55,9 @@ running reports several times. -

Example:

- +

Example:
+ dashboard.jpg +

diff --git a/dashboard/xdocs/technical.xml b/dashboard/xdocs/technical.xml index 6b449372..6f6500ec 100644 --- a/dashboard/xdocs/technical.xml +++ b/dashboard/xdocs/technical.xml @@ -24,19 +24,19 @@ Siegfried Goeschl -

+

The Dashboard plugin aggregates report data from multiple Maven reports over multiple projects using the reactor. To understand the work of the plugin better we have to look at the following topics +

  • How to create the report data aggregate for a single project?
  • How are the report data aggregate for the master project?
-

-
+

The aggregation runs over the existing Maven reports but how to get them?! Either the Dashboard plugin is told to collect data @@ -46,10 +46,10 @@

This behaviour is controlled by +

maven.dashboard.rungoals = [true|false] -

If this property is set to "true" the Dashboard plugin looks at the value of 'maven.dashboard.aggregators' to determine which @@ -58,20 +58,21 @@ e.g. for the Clover plugin the XML report generation is enabled.

-
+

The aggregation for the master project is a two-step process triggered by the reactor +

  • Aggregate the report data for a single project
  • Aggregate the aggregated data over all projects
-

The result of the aggregation is a file 'dashboard-single.xml' which could look like the following example collecting data of JUnit, Clover, PMD, CVS and Checkstyle reports +

@@ -84,7 +85,6 @@ 27 ]]> -

@@ -92,6 +92,7 @@ subprojects which results into a 'dashboard-data.xml'. This file is then transformed to the Dashoard HTML report. +

@@ -115,8 +116,7 @@ ]]> -

- \ No newline at end of file + diff --git a/developer-activity/xdocs/properties.xml b/developer-activity/xdocs/properties.xml index 0a326838..91b65b9f 100644 --- a/developer-activity/xdocs/properties.xml +++ b/developer-activity/xdocs/properties.xml @@ -24,7 +24,7 @@
- See Changelog plugin properties +

See Changelog plugin properties

- \ No newline at end of file + diff --git a/ear/xdocs/properties.xml b/ear/xdocs/properties.xml index 6d14d28a..3f9b8300 100644 --- a/ear/xdocs/properties.xml +++ b/ear/xdocs/properties.xml @@ -137,14 +137,14 @@
Attribute NameDescriptionOptional?maven.build.dir where the component will be assembled - maven.build.dir + maven.build.dir
maven.final.name The assembled component will be ${maven.build.dir}/${maven.final.name}.ear - maven.final.name + maven.final.name
diff --git a/eclipse/xdocs/goals.xml b/eclipse/xdocs/goals.xml index e3e2afe3..5342324e 100644 --- a/eclipse/xdocs/goals.xml +++ b/eclipse/xdocs/goals.xml @@ -85,10 +85,10 @@ If the ${maven.eclipse.workspace} is not set, the file is created in the current directory, and should be manually copied to +

${eclipse workspace}/.metadata/.plugins/org.eclipse.ui.externaltools/externaltools.xml -

@@ -107,16 +107,15 @@ ${eclipse workspace}/.metadata/.plugins/org.eclipse.ui.externaltools/externaltoo

If the ${maven.eclipse.workspace} is not set, the files should be manually copied to +

${your eclipse workspace}/.metadata/.plugins/org.eclipse.debug.core/.launches/ -

- - eclipse:add-maven-repo + eclipse:add-maven-repo Ensures that the classpath variable MAVEN_REPO exists in the Eclipse environment. diff --git a/eclipse/xdocs/index.xml b/eclipse/xdocs/index.xml index df4e4927..303906ce 100644 --- a/eclipse/xdocs/index.xml +++ b/eclipse/xdocs/index.xml @@ -122,11 +122,11 @@ would be placed in /target/generated-sources/schema/.
Settings in project.properties: +

maven.xdoclet.hibernatedoclet.destDir=${maven.build.dir}/generated-sources/xdoclet maven.hibernate.output.dir=${maven.build.dir}/generated-sources/schema -

diff --git a/ejb/xdocs/index.xml b/ejb/xdocs/index.xml index 4acd3e22..c1bca434 100644 --- a/ejb/xdocs/index.xml +++ b/ejb/xdocs/index.xml @@ -62,7 +62,6 @@
  • In order to reference an EJB client JAR from another project you'll need to specify an ejb-client type. Here's an example: -
    • groupId @@ -71,6 +70,7 @@ ejb-client ]]> +
  • The following goals have been deprecated: ejb:ejb-client, ejb:install-client and diff --git a/faq/xdocs/goals.xml b/faq/xdocs/goals.xml index a62c959f..46396f8c 100644 --- a/faq/xdocs/goals.xml +++ b/faq/xdocs/goals.xml @@ -29,9 +29,8 @@ - - + - - + - - + - - + - - +
    GoalDescription
    faqfaq The default goal. This goal generates an xdoc document from an XML FAQ document. diff --git a/file-activity/xdocs/properties.xml b/file-activity/xdocs/properties.xml index ba63c47f..1b265cdb 100644 --- a/file-activity/xdocs/properties.xml +++ b/file-activity/xdocs/properties.xml @@ -24,7 +24,7 @@
    - See Changelog plugin properties +

    See Changelog plugin properties

    - \ No newline at end of file + diff --git a/genapp/xdocs/customization_guide.xml b/genapp/xdocs/customization_guide.xml index f7fdf84c..6c80e56d 100644 --- a/genapp/xdocs/customization_guide.xml +++ b/genapp/xdocs/customization_guide.xml @@ -67,8 +67,8 @@ copying one of there to a different directory. This new copy will be the one that we'll be working on. For this example, we will consider the new template directory to be on - /opt/templates/foo

    + /opt/templates/foo

    @@ -89,7 +89,9 @@

    Create a directory for your application and type +

    maven genapp -Dmaven.genapp.template.dir=/opt/templates/foo +

    This should generate the application template you defined.

    diff --git a/gump/xdocs/goals.xml b/gump/xdocs/goals.xml index ac60aae3..4fa12ee5 100644 --- a/gump/xdocs/goals.xml +++ b/gump/xdocs/goals.xml @@ -32,9 +32,8 @@

    		Description
    gump:gumpgump:gump Generates a gump.xml file for Apache Gump @@ -42,9 +41,8 @@
    gump:multiprojectgump:multiproject Generates a gump.xml file for Apache Gump @@ -53,18 +51,16 @@
    gumpgump The default goal. This is an alias for gump:gump.
    gump:generate-descriptorgump:generate-descriptor This is an alias for gump:gump. diff --git a/hibernate/xdocs/goals.xml b/hibernate/xdocs/goals.xml index 4fd0a01e..f5b4b749 100644 --- a/hibernate/xdocs/goals.xml +++ b/hibernate/xdocs/goals.xml @@ -29,30 +29,29 @@ - - + - + - + - + - + - + - + diff --git a/html2xdoc/xdocs/goals.xml b/html2xdoc/xdocs/goals.xml index 410c792e..07b6e1ec 100644 --- a/html2xdoc/xdocs/goals.xml +++ b/html2xdoc/xdocs/goals.xml @@ -29,9 +29,8 @@
    GoalDescription
    hibernate:schema-exporthibernate:schema-export Creates SQL DDL file and generates the database schema from set of *.hbm.xml files
    hibernate:schema-updatehibernate:schema-update Updates the database schema based on the set of *.hbm.xml files
    hibernate:aggregate-mappingshibernate:aggregate-mappings Aggregates multiple hibernate mappings into one
    hibernate:code-generationhibernate:code-generation Generates Java classes from set of *.hbm.xml files
    - - +
    GoalDescription
    html2xdochtml2xdoc The default goal. This goal generates xdoc documents from some basic HTML documentation which can then be styled by the xdoc goal to use diff --git a/j2ee/xdocs/appserver.xml b/j2ee/xdocs/appserver.xml index 780deace..5cf951c1 100644 --- a/j2ee/xdocs/appserver.xml +++ b/j2ee/xdocs/appserver.xml @@ -20,8 +20,8 @@ - Peter Lynch Maven J2EE Plug-in: Appserver Notes + Peter Lynch diff --git a/j2ee/xdocs/dirlayout.xml b/j2ee/xdocs/dirlayout.xml index 12ec7662..2dfd5d0c 100644 --- a/j2ee/xdocs/dirlayout.xml +++ b/j2ee/xdocs/dirlayout.xml @@ -20,8 +20,8 @@ - dIon Gillard Maven J2EE Plug-in Directory Layout + dIon Gillard diff --git a/j2ee/xdocs/futures.xml b/j2ee/xdocs/futures.xml index 314e412c..f2f91542 100644 --- a/j2ee/xdocs/futures.xml +++ b/j2ee/xdocs/futures.xml @@ -20,9 +20,9 @@ + Futures for the J2EE Plug-in dIon Gillard Peter Lynch - Futures for the J2EE Plug-in diff --git a/j2ee/xdocs/goals.xml b/j2ee/xdocs/goals.xml index bd37992b..8669ff52 100644 --- a/j2ee/xdocs/goals.xml +++ b/j2ee/xdocs/goals.xml @@ -20,10 +20,10 @@ + Maven J2EE Plug-in Goals dIon Gillard Kevin O'Neill Peter Lynch - Maven J2EE Plug-in Goals @@ -72,6 +72,7 @@

    The validator checks the folowing: +

    1. The war file exists
    2. It is readable
      3. @@ -89,7 +90,6 @@
    3. Login and error pages specified in the <form-login-config > element must exist in the war file
    -

    @@ -101,13 +101,12 @@ ${maven.j2ee.ejb.name} property.

    -

    The files generated are: +

    The files generated are:

    • ${maven.j2ee.ejb.name}.jar
      • -
    • ${maven.j2ee.ejb.name}-remote.jar (optional)
      • -
    • ${maven.j2ee.ejb.name}-local.jar (optional)
      • +
    • ${maven.j2ee.ejb.name}-remote.jar (optional)
      • +
    • ${maven.j2ee.ejb.name}-local.jar (optional)
    -

    Maven also includes the license file, LICENSE.txt, if it exists, in the META-INF directory. diff --git a/j2ee/xdocs/properties.xml b/j2ee/xdocs/properties.xml index c8b6e5ce..4ccd1fc7 100644 --- a/j2ee/xdocs/properties.xml +++ b/j2ee/xdocs/properties.xml @@ -20,10 +20,10 @@ + Maven J2EE Plug-in Properties Documentation dIon Gillard Kevin O'Neill Peter Lynch - Maven J2EE Plug-in Properties Documentation diff --git a/jcoverage/xdocs/navigation.xml b/jcoverage/xdocs/navigation.xml index 58a8129e..b5dc1330 100644 --- a/jcoverage/xdocs/navigation.xml +++ b/jcoverage/xdocs/navigation.xml @@ -19,10 +19,8 @@ - - Dominik Dahlem + JCoverage Plugin - @@ -39,4 +37,4 @@ - \ No newline at end of file + diff --git a/jdepend/xdocs/index.xml b/jdepend/xdocs/index.xml index db61c0df..2a099aa2 100644 --- a/jdepend/xdocs/index.xml +++ b/jdepend/xdocs/index.xml @@ -38,6 +38,7 @@

    Metrics for each Java package include: +

    • Number of Classes and Interfaces

      @@ -107,7 +108,6 @@

    -

    diff --git a/jellydoc/xdocs/goals.xml b/jellydoc/xdocs/goals.xml index d75cd6e1..09dfd660 100644 --- a/jellydoc/xdocs/goals.xml +++ b/jellydoc/xdocs/goals.xml @@ -29,9 +29,8 @@ - - +
    GoalDescription
    jellydocjellydoc The default goal. This goal generates the JellyDoc documentation of all Jelly tags defined within your code base which can then be styled diff --git a/linkcheck/xdocs/index.xml b/linkcheck/xdocs/index.xml index 1ff9fe81..ce8b728c 100644 --- a/linkcheck/xdocs/index.xml +++ b/linkcheck/xdocs/index.xml @@ -37,12 +37,10 @@ to have implemented. (In decreasing order of importance)

    -

    1. The ability to include exclude parts of the tree
    2. Persists remote url checks across runs
    -

    diff --git a/multiproject/xdocs/reports.xml b/multiproject/xdocs/reports.xml index b06d6285..7d8ce1fd 100644 --- a/multiproject/xdocs/reports.xml +++ b/multiproject/xdocs/reports.xml @@ -32,11 +32,11 @@

    To register this report, include the following in your top-level project.xml: +

    maven-multiproject-plugin ]]> -

    diff --git a/nsis/xdocs/customizing.xml b/nsis/xdocs/customizing.xml index 562e4279..5b91973a 100644 --- a/nsis/xdocs/customizing.xml +++ b/nsis/xdocs/customizing.xml @@ -59,6 +59,7 @@

    The plugin provides two templates by default: +

    1. project.jelly to get access to information in @@ -69,7 +70,6 @@ compilation.
    -

    This template produces a file (${maven.build.dir}/project.nsi) @@ -114,11 +114,13 @@

    The setup.nsh file that is generated uses following list of directories to search for files to include: +

    1. ${maven.nsis.src} if it exists,
    2. ${maven.build.dir}
    3. ${plugin.resources}
    +

    So anything in your NSIS source will override the defaults.

    diff --git a/nsis/xdocs/process.xml b/nsis/xdocs/process.xml index 146aab4e..e951967f 100644 --- a/nsis/xdocs/process.xml +++ b/nsis/xdocs/process.xml @@ -29,6 +29,7 @@

    The process of creating an installer from your ${maven.nsis.build.dir} using the plugin is as follows: +

    1. You, the user invoke the nsis, or nsis:installer @@ -57,7 +58,6 @@ setup.nsi file.
    -

    diff --git a/simian/xdocs/goals.xml b/simian/xdocs/goals.xml index 3832bb30..a9707e17 100644 --- a/simian/xdocs/goals.xml +++ b/simian/xdocs/goals.xml @@ -28,9 +28,8 @@
    - - +
    GoalDescription
    maven-simian-pluginmaven-simian-plugin The default goal. This goal generates an xdoc document containing a Simian report. diff --git a/tasklist/xdocs/goals.xml b/tasklist/xdocs/goals.xml index ec82cbaf..a83fab4f 100644 --- a/tasklist/xdocs/goals.xml +++ b/tasklist/xdocs/goals.xml @@ -28,18 +28,16 @@
    - - + - - + - - +
    GoalDescription
    tasklisttasklist The default goal. This goal simply executes the tasklist:generate goal
    tasklist:generatetasklist:generate Generates a list of tasks from the javadoc @todo tag
    diff --git a/uberjar/xdocs/goals.xml b/uberjar/xdocs/goals.xml index 87532575..59c6d6ca 100644 --- a/uberjar/xdocs/goals.xml +++ b/uberjar/xdocs/goals.xml @@ -35,7 +35,7 @@ - + diff --git a/uberjar/xdocs/tasks.xml b/uberjar/xdocs/tasks.xml index f3301d0a..2f96bed3 100644 --- a/uberjar/xdocs/tasks.xml +++ b/uberjar/xdocs/tasks.xml @@ -26,7 +26,7 @@
    -
      +
    diff --git a/war/xdocs/properties.xml b/war/xdocs/properties.xml index 15dd9c87..a9a6d06b 100644 --- a/war/xdocs/properties.xml +++ b/war/xdocs/properties.xml @@ -130,8 +130,7 @@
    maven.war.tld.dirmaven.war.tld.dir Yes Subdirectory of web application context root directory @@ -181,11 +180,11 @@

    This process is type senstive. Currently following types are supported: +

    1. jar (bundled into WEB-INF/lib)
    2. tld (bundled into WEB-INF/tld, see: maven.war.tld.dir)
    -