dion 2003/08/15 02:37:55
Modified: xdocs/reference Tag: MAVEN_RC1_STABLE user-guide.xml
project-descriptor.xml
Log:
MAVEN-637
Revision Changes Path
No revision
No revision
1.56.2.2 +1 -1 maven/xdocs/reference/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/user-guide.xml,v
retrieving revision 1.56.2.1
retrieving revision 1.56.2.2
diff -u -r1.56.2.1 -r1.56.2.2
--- user-guide.xml 7 Aug 2003 16:52:38 -0000 1.56.2.1
+++ user-guide.xml 15 Aug 2003 09:37:55 -0000 1.56.2.2
@@ -1533,7 +1533,7 @@
<source><![CDATA[
repository
|
- |-- org.apache.tools.ant
+ |-- ant
| |-- distribution
| `-- jars
| |-- ant-1.4.1.jar
1.18.4.2 +69 -13 maven/xdocs/reference/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/project-descriptor.xml,v
retrieving revision 1.18.4.1
retrieving revision 1.18.4.2
diff -u -r1.18.4.1 -r1.18.4.2
--- project-descriptor.xml 7 Aug 2003 16:52:38 -0000 1.18.4.1
+++ project-descriptor.xml 15 Aug 2003 09:37:55 -0000 1.18.4.2
@@ -585,45 +585,101 @@
This element describes all of the dependencies associated with a
project. Each dependency is described by a
<code>dependency</code> element, which is then described by
- additional elements (described below). These dependencies are
- used to construct a classpath for your project during the build
- process. In addition, Maven can automatically download these
- dependencies from a central repository. The filename that Maven
- downloads from the repository is <code>id-version.jar</code>
- where <code>id</code> corresponds to the <code>id</code>
+ additional elements (described below).
+ </p>
+ <p>
+ These dependencies are used to construct a classpath for your project
+ during the build process.
+ </p>
+ <p>
+ Maven can automatically download these
+ dependencies from a <a href="user-guide.html#Remote Repository
Layout">remote repository</a>.
+ </p>
+ <p>
+ The filename that Maven downloads from the repository is
+ <code>artifactId-version.jar</code> where <code>artifactId</code>
corresponds to the <code>artifactId</code>
element and <code>version</code> corresponds to the
<code>version</code> element.
</p>
+ <p>
+ When Maven goes looking for a dependency in the remote repository, it uses
+ the dependency element to construct the URL to download from. This URL is
+ defined as:
+ </p>
+ <source>
+${repo}/${groupId}/${type}s/${artifactId}-${version}.${type}
+ </source>
+ <p>
+ Where
+ <dl>
+ <dt>repo</dt>
+ <dd>is the remote repository URL specified by
<code>${maven.repo.remote}</code></dd>
+ <dt>groupId</dt>
+ <dd>is taken from the dependency element</dd>
+ <dt>type</dt>
+ <dd>is taken from the dependency element</dd>
+ <dt>artifactId</dt>
+ <dd>is taken from the dependency element</dd>
+ <dt>version</dt>
+ <dd>is taken from the dependency element</dd>
+ </dl>
+ </p>
<subsection name="dependency">
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
<td>id</td>
- <td>The name of the dependency.</td>
+ <td>
+ <p>The name of the dependency.</p>
+ <p>
+ <strong>Note:</strong> The use of the id element for
+ a dependency is deprecated. Please use <code>groupId</code> and
+ <code>artifactId</code> together instead.
+ </p>
+ </td>
</tr>
<tr>
<td>groupId</td>
- <td></td>
+ <td>
+ The project group that produced the dependency, e.g.
<code>jboss</code>.
+ </td>
</tr>
<tr>
<td>artifactId</td>
- <td></td>
+ <td>
+ The unique id for an artifact produced by the project group, e.g.
+ <code>jboss-boot</code>
+ </td>
</tr>
<tr>
<td>version</td>
- <td>The version of the dependency.</td>
+ <td>The version of the dependency., e.g. <code>3.2.1</code></td>
</tr>
<tr>
<td>jar</td>
- <td>The name of jar file if it doesn't respect
<code><id>.<version>.jar pattern.</code></td>
+ <td>
+ The name of jar file if it doesn't respect
+ <code><artifactId>.<version>.jar pattern.</code></td>
</tr>
<tr>
<td>type</td>
- <td></td>
+ <td>
+ The type of dependency. This defaults to <code>jar</code>.
+ <p>
+ Other known and recognised dependency types are:
+ <code>ejb</code> and <code>plugin</code>.
+ </p>
+ </td>
</tr>
<tr>
<td>url</td>
- <td>The url of the dependency's homepage.</td>
+ <td>
+ The url of the dependency's homepage.
+ <p>
+ This url will be provided to the user if the jar file cannot be
downloaded
+ from the central repository.
+ </p>
+ </td>
</tr>
</table>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
