4da36d7ef7
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@425194 13f79535-47bb-0310-9956-ffa450edef68
72 lines
2.6 KiB
XML
72 lines
2.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2005 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.
|
|
*/
|
|
-->
|
|
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Maven Source Plug-in</title>
|
|
<author email="snicoll@apache.org">Stephane Nicoll</author>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Maven Source Plug-in">
|
|
<p>
|
|
This plug-in builds an archive of the source code. It is based
|
|
on the maven.compile.src.set property so every directory specified
|
|
in this property is used to generate the source archive.
|
|
</p>
|
|
<p>
|
|
The generated source archive will be deployed at
|
|
<code>${groupId}/java-sources/${artifactId}-{version}-sources.jar</code>.
|
|
</p>
|
|
<p>
|
|
For more information on the functionality provided by this plugin,
|
|
please see the <a href="goals.html">Goals</a> document.
|
|
</p>
|
|
<p>
|
|
For more information on how to customise the functionality provided
|
|
by this plugin, please see the <a href="properties.html">properties</a>
|
|
document.
|
|
</p>
|
|
</section>
|
|
<section name="Downloading a source archive">
|
|
<p>
|
|
Similarly to the plugin plugin, the source plugin is able to download
|
|
a source archive from the configured repository(ies). The following
|
|
parameters might be set at runtime:
|
|
</p>
|
|
<ul>
|
|
<li>groupId: the groupId of the source archive to download</li>
|
|
<li>artifactId: the artifactId of the source archive to download</li>
|
|
<li>version: the version of the source archive to download</li>
|
|
<li>ignoreErrors (optional - default to false): specificy if the build should fail if the source archive is not found</li>
|
|
<li>backwardCompatible (optional - default to false): specificy if the old source archive location should be checked as well</li>
|
|
</ul>
|
|
<p>
|
|
Example:
|
|
</p>
|
|
<source>maven source:download
|
|
-DartifactId=someArtifact
|
|
-DgroupId=theGroup
|
|
-Dversion=1.0.0-SNAPSHOT
|
|
-DbackwardCompatible=true</source>
|
|
</section>
|
|
</body>
|
|
</document>
|