From b4b57f369b626730b875b14294141c1e4865eec7 Mon Sep 17 00:00:00 2001 From: evenisse Date: Tue, 22 Apr 2003 12:20:49 +0000 Subject: [PATCH] Update documentation git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113369 13f79535-47bb-0310-9956-ffa450edef68 --- jar/xdocs/goals.xml | 39 +-------- jar/xdocs/index.xml | 7 +- jar/xdocs/navigation.xml | 6 +- jar/xdocs/properties.xml | 175 +------------------------------------- java/xdocs/goals.xml | 61 +------------ java/xdocs/index.xml | 2 +- java/xdocs/navigation.xml | 2 +- java/xdocs/properties.xml | 134 ----------------------------- 8 files changed, 15 insertions(+), 411 deletions(-) diff --git a/jar/xdocs/goals.xml b/jar/xdocs/goals.xml index 1edb258d..4bd8f1ad 100644 --- a/jar/xdocs/goals.xml +++ b/jar/xdocs/goals.xml @@ -5,6 +5,7 @@ Maven Java Plug-in Goals dIon Gillard Kurt Schrader + Emmanuel Venisse @@ -12,43 +13,11 @@ - - + + - - - - - - - - - +
GoalDescription
java:prepare-filesystem - Creates the directories necessary for compilation - jar:jarLaunch jar:jar goal.
java:compile -

- Compiles the Java source code for the project -

-

- The source code directory is specified in the - build - element of your project.xml - file. -

-
java:jar-resources -

- Copies any resources that must be present in the deployed JAR - file, from the directory specified by - maven.jarResources.basedir to the - build directory, where class files are stored. -

-

- The maven.jar.resources.set - property is used to determine which files from the base directory - are included -

-
java:jarjar:jar Creates a jar file in the Maven build directory with the form ${project.id}-${project.currentVersion}.jar where diff --git a/jar/xdocs/index.xml b/jar/xdocs/index.xml index 8b416265..0cb4b985 100644 --- a/jar/xdocs/index.xml +++ b/jar/xdocs/index.xml @@ -2,14 +2,15 @@ - Maven Java Plug-in + Maven Jar Plug-in Jason van Zyl + Emmanuel Venisse -
+

- This plug-in provides your basic Javac and Jar facilities. + This plug-in provides your basic Jar facilities.

For more information on the functionality provided by this plugin, diff --git a/jar/xdocs/navigation.xml b/jar/xdocs/navigation.xml index 5127bd33..77a0e3ef 100644 --- a/jar/xdocs/navigation.xml +++ b/jar/xdocs/navigation.xml @@ -1,7 +1,7 @@ - + - Maven Java Plugin + Maven Jar Plugin @@ -10,7 +10,7 @@

- + diff --git a/jar/xdocs/properties.xml b/jar/xdocs/properties.xml index 5bcc5039..0633877b 100644 --- a/jar/xdocs/properties.xml +++ b/jar/xdocs/properties.xml @@ -8,179 +8,6 @@ -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyOptional?Description
maven.compile.aspectsYes - Specifies that Aspects are included during compilation. - Used by the "java:compile" goal. - The default value is false. Please - refer to the AspectJ - web site for more information on Aspect-Oriented - Programming. -
maven.compile.compilerargsYes -

- Provides arguments to a compiler when maven.compile.fork - is set to true -

-

- Corresponds to the nested compilerarg element for the ant - javac - task. -

-
maven.compile.debugYes - Specifies wether to include debugging information in the compiled - class files; the default value is on. - Used by the "java:compile" goal. -
maven.compile.deprecationYes - Specifies wether source should be compiled with deprecation - information; the default value is off. - Used by the "java:compile" goal. -
maven.compile.encodingYes -

- Sets the encoding of the .java files being compiled -

-

- Corresponds to the encoding attribute for the ant - javac - task. -

-
maven.compile.executableYes -

- Names the program to be invoked as the java compiler -

-

- Corresponds to the executable attribute for the ant - javac - task. -

-
maven.compile.forkYes -

- Runs the compiler in a separate process -

-

- Corresponds to the fork attribute for the ant - javac - task. -

-
maven.compile.optimizeYes - Specifies whether source should be compiled with optimization; the - default value is off. - Used by the "java:compile" goal. -
maven.compile.sourceYes -

- Provide source compatibility with a specific release -

-

- Corresponds to the source attribute for the ant - javac - task. -

-
maven.compile.src.setYes - The source directories maven uses to compile java code. -
maven.compile.targetYes -

- Generate class files for a specific JVM version -

-

- Corresponds to the target attribute for the ant - javac - task. -

-
maven.compile.verboseYes -

- Asks the compiler for verbose output -

-

- Corresponds to the verbose attribute for the ant - javac - task. -

-
pom.build.sourceModificationsYes - This property is the list of the - - - - - - - - - - -]]> - source modifications in your - - project descriptor. This property is used during compilation to exclude or - include classes from compilation depending on whether a named class is available -
-
@@ -316,7 +143,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - -
maven.build.dir Yes - Used by the java:jar goal for + Used by the jar:jar goal for
  • a temporary manifest file, if one is not specified
  • the assembled jar file
    • diff --git a/java/xdocs/goals.xml b/java/xdocs/goals.xml index 1edb258d..20e655a4 100644 --- a/java/xdocs/goals.xml +++ b/java/xdocs/goals.xml @@ -50,66 +50,7 @@
java:jar - Creates a jar file in the Maven build directory with the - form ${project.id}-${project.currentVersion}.jar where - the id and currentVersion are taken from the project.xml - of the project being built. -
jar:snapshot - Creates a jar file in the Maven build directory with the - form ${project.id}-YYYYMMDD.hhmmss.jar where -
    -
  • - id - taken from the project.xml - of the project being built -
    • -
  • YYYYMMDD - The current year in 8 digit format
    • -
  • hhmmss - the current time in 6 digit format
    • -
-
jar:deploy-snapshot - Deploy a snapshot jar to the remote repository -
jar:deploy - Deploy a jar to the remote repository. The jar is built using - the java:jar goal -
jar:install - Install a jar into the local repository. The jar is built using - the java:jar goal -
jar:install-snapshot - Install a jar into the local repository. The jar is built using - the jar:snapshot goal and copied into the local - repository as the -SNAPSHOT version. -
clean - This goal is a shortcut to the clean:clean goal -
clean:clean - Removes the maven.build.dir and - maven.test.reportsDirectory directories + Deprecated. You must use jar:jar goal.
diff --git a/java/xdocs/index.xml b/java/xdocs/index.xml index 8b416265..31dad7b5 100644 --- a/java/xdocs/index.xml +++ b/java/xdocs/index.xml @@ -9,7 +9,7 @@

- This plug-in provides your basic Javac and Jar facilities. + This plug-in provides your basic Javac facilities.

For more information on the functionality provided by this plugin, diff --git a/java/xdocs/navigation.xml b/java/xdocs/navigation.xml index 5127bd33..cbacac6e 100644 --- a/java/xdocs/navigation.xml +++ b/java/xdocs/navigation.xml @@ -10,7 +10,7 @@

- + diff --git a/java/xdocs/properties.xml b/java/xdocs/properties.xml index 45f9a35d..bc0177c6 100644 --- a/java/xdocs/properties.xml +++ b/java/xdocs/properties.xml @@ -181,113 +181,6 @@
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
maven.has.jar.resource.patternsYes - This is a calculated property based on the value of the - - - - -]]> - section of your - - project descriptor. If there are includes or excludes - elements, this property will be set to true -
maven.jar.excludesYes - Specifies a list of patterns to exclude from the jar process. - The default value is **/package.html, and is used - by the "java:jar" goal. -
maven.jar.manifestYes - Specifies the manifest to be used in the creation of a jar. - This file is 'merged' with the default manifest created by - Maven. Any values specified in the file referenced by this - property will override Maven's defaults. -
maven.jar.mainclassYes - Specifies the Main-Class attribute for your manifest. If not set, - no MainClass attribute will be added to the manifest. -
maven.jarResources.basedirYes - The base directory from which resources to be included in a jar can be found. - Defaults to the base directory of the project. -
maven.jar.resources.setYes - This is the Ant patternset of all the includes and - excludes from the - - - - -]]> - section of your - - project descriptor -
-
-
- - - - - - - - - - - - - - - - - - - - - - -
PropertyOptional?Description
maven.repo.centralYes - Central repository for maven artifacts -
maven.repo.central.directoryYes - Directory to deploy jars into on the remote repository -
maven.repo.localYes - The local repository to store maven artifacts, including jar file - dependencies -
maven.usernameYes - This is the user name used to log in to the remote repository -
-
@@ -296,17 +189,6 @@ - - - - - @@ -317,22 +199,6 @@ project descriptor - - - - - - - - - -
PropertyOptional?Description
Yes The directory for compiled classes
maven.build.dirYes - Used by the java:jar goal for -
    -
  • a temporary manifest file, if one is not specified
    • -
  • the assembled jar file
    • -
-
maven.dependency.classpath Yes
maven.final.nameYes - Usually this property is set to ${project.id}-${project.currentVersion} - but the snapshot goal overwrites it to be the snapshot signature -
user.nameYes - Used by the java:jar goal as the default value of the - Built-By attribute of the manifest if one is not specified. -