You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/01/21 10:27:55 UTC
svn commit: r125910 - in maven/maven-1/core/trunk/xdocs: reference start start/samples
Author: brett
Date: Fri Jan 21 01:27:52 2005
New Revision: 125910
URL: http://svn.apache.org/viewcvs?view=rev&rev=125910
Log:
more documentation
Added:
maven/maven-1/core/trunk/xdocs/start/samples/
maven/maven-1/core/trunk/xdocs/start/samples/sample-echo.zip (contents, props changed)
Modified:
maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml
maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml
maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml
Modified: maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml?view=diff&rev=125910&p1=maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml&r1=125909&p2=maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml&r2=125910
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml Fri Jan 21 01:27:52 2005
@@ -25,6 +25,7 @@
</properties>
<body>
+ <!-- TODO: should this be part of repositories in using, or at least linked to it? -->
<section name="Internal Repositories">
<p>
When using Maven, particularly in a corporate environment, connecting to the internet to download dependencies
@@ -68,8 +69,41 @@
including click through licenses on downloading, and verification of signatures.
</p>
</subsection>
-<!-- TODO: next sections: using your internal repository (maven.repo.remote), and uploading to your internal
-repository (artifact settings - reference that, and intertwine with releases doco) -->
+ <subsection name="Using the Internal Repository">
+ <p>
+ Using the internal repository is quite simple. Simply set the <code>maven.repo.remote</code> property in
+ your project's properties:
+ </p>
+ <source>maven.repo.remote=http://repository.company.com/
+<i>or</i>
+maven.repo.remote=file:///shared/repository</source>
+ </subsection>
+ <subsection name="Deploying to the Internal Repository">
+ <p>
+ One of the most important reasons to have one or more internal repositories is to be able to publish
+ your own private releases to share.
+ </p>
+ <p>
+ To publish to the repository, you will need to have access via one of SCP, SFTP, FTP, or the filesystem.
+ For example, to set up an SCP transfer, you define the following properties:
+ </p>
+ <source>
+maven.repo.list=myrepo
+maven.repo.myrepo=scp://repository.mycompany.com/
+maven.repo.myrepo.directory=/www/repository.mycompany.com/
+maven.repo.myrepo.username=${user.name}
+maven.repo.myrepo.privatekey=${user.home}/.ssh/id_dsa
+ </source>
+ <p>
+ With this configured, the <code>*:deploy</code> goals will now send the published artifacts to the "remote"
+ repository for sharing. This includes <code>jar:deploy</code>, <code>dist:deploy</code>,
+ <code>war:deploy</code> and so on.
+ </p>
+ <p>
+ For more information, please refer to the <a href="plugins/artifact/">Artifact Plugin Reference</a>
+ and the section on <a href="../using/releasing.html">Making Releases</a>.
+ </p>
+ </subsection>
</section>
</body>
</document>
Modified: maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml?view=diff&rev=125910&p1=maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml&r1=125909&p2=maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml&r2=125910
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/standard-sun-jar-names.xml Fri Jan 21 01:27:52 2005
@@ -26,8 +26,46 @@
<body>
<section name="Standard Sun JAR Names">
- <!-- TODO: list, and document reason, refer to sun-lic-journ -->
- <p>...</p>
+ <p>
+ A common problem when trying to use Maven to build a project is if that project depends
+ on a particular JAR from Sun that cannot be distributed via Ibiblio due to its license.
+ (refer to <a href="../project/sun-licensing-journey.html">this document</a> for a history)
+ </p>
+ <p>
+ This particularly affects J2EE technologies, but includes some other reference implementations.
+ Projects are now starting to develop clean room implementations of some of these specifications
+ under open source licenses, however in many cases they are not complete, or projects are not
+ using them.
+ </p>
+ <p>
+ The only alternative is to download the JARs yourself (accepting Sun's license), and to place them
+ into your local or internal repository.
+ </p>
+ <p>
+ Should you need to use them, this document aims to list a standard location for the JARs so that
+ all projects can reference them consistently, and so will only need to be downloaded and put in
+ place once. It may not be complete, so if you have use for a Sun JAR that is not listed here, please
+ contact the <a href="../mail-lists.html">Developer's Mailing List</a> so that it can be added.
+ </p>
+ <p>
+ The current list of JARs have been built up by convention - it's not a matter of what is right or wrong,
+ but what is most common in this instance.
+ </p>
+ <table>
+ <tr>
+ <th>Product artifact</th><th>Group ID</th><th>Artifact ID</th>
+ </tr>
+ <tr>
+ <td>JavaMail - mail.jar</td><td>javamail</td><td>javamail</td>
+ </tr>
+ <tr>
+ <td>Java Activation Framework (required for Javamail) - activation.jar</td><td>jaf</td><td>activation</td>
+ </tr>
+ <tr>
+ <td>Java Transaction API (JTA)</td><td>jta</td><td>jta</td>
+ </tr>
+ </table>
</section>
</body>
</document>
+
Added: maven/maven-1/core/trunk/xdocs/start/samples/sample-echo.zip
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/start/samples/sample-echo.zip?view=auto&rev=125910
==============================================================================
Binary file. No diff available.
Modified: maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml?view=diff&rev=125910&p1=maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml&r1=125909&p2=maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml&r2=125910
==============================================================================
--- maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml (original)
+++ maven/maven-1/core/trunk/xdocs/start/ten-minute-test.xml Fri Jan 21 01:27:52 2005
@@ -156,14 +156,61 @@
In the near future, tools will be available to graphically edit the project descriptor.
</p>
<p>
- The following is the most basic project descriptor ... <!-- TODO: finish ten minute test -->
+ The following is a basic project descriptor:
</p>
+ <source><![CDATA[<project>
+ <groupId>sample</groupId>
+ <artifactId>sample-echo</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <dependencies>
+ <dependency>
+ <groupId>log4j</groupId>
+ <artifactId>log4j</artifactId>
+ <version>1.2.8</version>
+ </dependency>
+ </dependencies>
+ <build>
+ <sourceDirectory>src/main/java</sourceDirectory>
+ <unitTestSourceDirectory>src/test/java</unitTestSourceDirectory>
+ <resources>
+ <resource>
+ <directory>src/main/resources</directory>
+ </resource>
+ </resources>
+ <unitTest>
+ <includes>
+ <include>**/*Test.java</include>
+ </includes>
+ </unitTest>
+ </build>
+</project>]]></source>
<p>
- More to come...
- </p>
+ There are many more elements to be introduced as you develop, especially if you want to make releases
+ or publish a site. A <a href="../reference/project-descriptor.html">full description of the project
+ descriptor</a> is available. Often, common elements will be shared in a parent descriptor to keep
+ each as small as possible.
+ </p>
+ <p>
+ The above descriptor is all you need to build a JAR and run any tests associated with it.
+ Try it for yourself: add some Java code to the <code>src/main/java</code> directory (include
+ subdirectories for any package name), and a JUnit test under <code>src/test/java</code>.
+ The following goals will perform some standard behaviours:
+ </p>
+ <ul>
+ <li><code>maven java:compile</code> - this will compile the code and check for errors - nothing more</li>
+ <li><code>maven test</code> - this will compile the code and tests, then run all of the unit tests</li>
+ <li><code>maven jar</code> - this will build a JAR from your code, after running the tests as above</li>
+ <li><code>maven site</code> - even now, you can generate a site in <code>target/docs</code> and see what
+ it will look like</li>
+ </ul>
+ <p>
+ Note that you can <a href="samples/sample-echo.zip">download</a> some sample code instead of creating the
+ project above.
+ </p>
</subsection>
-things you'd try next:
+<!--
+TODO: things you'd try next:
- add to CVS, see additional reports
...
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org