From 08eaf5c94ff9b8300849f918f49521f3801a9027 Mon Sep 17 00:00:00 2001 From: Brett Leslie Porter Date: Sat, 9 Apr 2005 02:07:15 +0000 Subject: [PATCH] PR: MNG-222 Submitted by: Dennis Lundberg Reviewed by: Brett Porter correction of typos, spelling and grammar git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@163889 13f79535-47bb-0310-9956-ffa450edef68 --- maven-model/maven.mdo | 342 +++++++++--------- maven-site/src/site/xdoc/about.fml | 2 +- maven-site/src/site/xdoc/getting-started.xml | 2 +- .../src/site/xdoc/project-descriptor.xml | 26 +- 4 files changed, 186 insertions(+), 186 deletions(-) diff --git a/maven-model/maven.mdo b/maven-model/maven.mdo index 2fd65820a9..af446ad763 100644 --- a/maven-model/maven.mdo +++ b/maven-model/maven.mdo @@ -32,7 +32,7 @@ Model <project> element specifies various attributes + The <project> element specifies various attributes about a project. This is the root element of the project descriptor. The following table lists all of the possible child elements. Child elements with children are then documented further in subsequent @@ -44,13 +44,13 @@ extend 3.0.0+ 
<extend>${basedir}/../project.xml</extend>
- ]]> + ]]> String @@ -75,7 +75,7 @@ true String 3.0.0 true jars and - distribution files. + The short name of the project. This value is used when naming + jars and + distribution files. ]]> String @@ -98,9 +98,9 @@ 3.0.0+ true user guide. + user guide. ]]> String @@ -109,10 +109,10 @@ 3.0.0+ true groupId - when naming jars and - distribution files. + when naming jars and + distribution files. ]]> String @@ -137,8 +137,8 @@ 3.0.0+ true JavaDoc + The full name of the project. This value is used when + generating JavaDoc titles. ]]> String @@ -146,9 +146,9 @@ currentVersion jars and - distribution files. + The current version of the project. This value is used when + naming jars and + distribution files. ]]> 3.0.0 true @@ -159,7 +159,7 @@ 4.0.0 true String @@ -167,7 +167,7 @@ shortDescription 3.0.0 String @@ -176,9 +176,9 @@ description 3.0.0+ front page of the project's + Mailing Lists of the project's web site, and is shown when maven --usage is called on the project. While this element can be specified as CDATA to enable the use of HTML tags within the description, you are encouraged to @@ -191,15 +191,15 @@ url 3.0.0+ + The URL to the project's homepage. + ]]> String logo 3.0.0 /images/project-logo.png) or an absolute URL (e.g., http://my.corp/project-logo.png). This is used @@ -211,7 +211,7 @@ issueTrackingUrl 3.0.0 String @@ -236,9 +236,9 @@ 3.0.0+ true JavaDoc copyright notices. + JavaDoc copyright notices. ]]> String @@ -246,7 +246,7 @@ gumpRepositoryId 3.0.0 @@ -256,9 +256,9 @@ siteAddress 3.0.0 deployed. + deployed. ]]> String @@ -266,9 +266,9 @@ siteDirectory 3.0.0 deployed. + deployed. ]]> String @@ -276,10 +276,10 @@ distributionSite 3.0.0 deployed. + deployed.

If this isn't defined, the central repository is used instead as determined by maven.repo.central and @@ -293,10 +293,10 @@ distributionDirectory 3.0.0 deployed. + deployed. ]]> String This naming is inconsistent and distribution should occur from a repository structure. @@ -324,8 +324,8 @@ mailingLists 3.0.0+ front + Contains information about a project's mailing lists. This + is used to generate the front page of the site's web site. ]]> @@ -337,8 +337,8 @@ developers 3.0.0+ Project Team + Describes the committers to a project. This is used to + generate the Project Team page of the project's web site. ]]> @@ -350,8 +350,8 @@ contributors 3.0.0+ Project Team page of + Describes the contributors to a project. This is used to generate + the Project Team page of the project's web site. ]]> @@ -363,56 +363,56 @@ dependencies 3.0.0+ - This element describes all of the dependencies associated with a - project. Each dependency is described by a - dependency 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. -

+ This element describes all of the dependencies associated with a + project. Each dependency is described by a + dependency element, which is then described by + additional elements (described below). +

- Maven can automatically download these dependencies from a - remote repository. -

+ These dependencies are used to construct a classpath for your + project during the build process. +

- The filename that Maven downloads from the repository is - artifactId-version.jar where artifactId + Maven can automatically download these dependencies from a + remote repository. +

+

+ The filename that Maven downloads from the repository is + artifactId-version.jar where artifactId corresponds to the artifactId element and version corresponds to the version element. -

+

- 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: -

-
- 
${repo}/${groupId}/${type}s/${artifactId}-${version}.${type}
+ 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: +

+
+ 
${repo}/${groupId}/${type}s/${artifactId}-${version}.${type}
-

- Where -

+

+ Where +

-
repo
-
- is the remote repository URL specified by +
repo
+
+ is the remote repository URL specified by ${maven.repo.remote}
- +
groupId
-
is taken from the dependency element
- +
is taken from the dependency element
+
type
-
is taken from the dependency element
- +
is taken from the dependency element
+
artifactId
-
is taken from the dependency element
- +
is taken from the dependency element
+
version
-
is taken from the dependency element
-
+
is taken from the dependency element
+ ]]> Dependency @@ -424,9 +424,9 @@ licenses 3.0.0+ license element, which - is then describe by additional elements (described below). The + is then described by additional elements (described below). The auto-generated site documentation references this information. Projects should only list the license(s) that applies to the project and not the licenses that apply to dependencies. @@ -440,9 +440,9 @@ versions 3.0.0 maven:dist + maven:dist target. ]]> @@ -454,9 +454,9 @@ branches 3.0.0 maven:dist + maven:dist target. ]]> @@ -477,7 +477,7 @@ reports 3.0.0 String @@ -501,7 +501,7 @@ scm 4.0.0 - + Scm @@ -509,7 +509,7 @@ repository 3.0.0 - + Repository @@ -528,9 +528,9 @@ organization 3.0.0+ Organization @@ -551,8 +551,8 @@ 4.0.0 false 3.0.0 String JavaDoc. + The Java package name of the project. This value is used + when generating JavaDoc. ]]> @@ -640,7 +640,7 @@ maven:dist target. + maven:dist target. ]]> @@ -648,7 +648,7 @@ 3.0.0 true @@ -664,11 +664,11 @@ nagEmailAddress 3.0.0 gump plugin + gump plugin target. ]]> String @@ -679,7 +679,7 @@ 3.0.0+ true 3.0.0 true aspectSourceDirectory 3.0.0 - Aspectj goals document). - The path given is relative to the project descriptor. + Aspectj goals document). + The path given is relative to the project descriptor. ]]> String integrationUnitTestSourceDirectory 3.0.0 - String @@ -753,12 +753,12 @@ 3.0.0 true sourceModification element, which is then described by - additional elements (described below). These modifications are used - to exclude or include various source depending on the environment - the build is running in. + This element describes all of the sourceModifications associated + with a project. Each source modification is described by a + sourceModification element, which is then described by + additional elements (described below). These modifications are used + to exclude or include various source depending on the environment + the build is running in. ]]> SourceModification @@ -770,7 +770,7 @@ 3.0.0 true new UnitTest() @@ -781,7 +781,7 @@ resources 3.0.0+ below). These resources are used to complete @@ -811,7 +811,7 @@ directory 4.0.0 String @@ -845,7 +845,7 @@ plugins 4.0.0 Plugin @@ -859,7 +859,7 @@ 4.0.0 false url 4.0.0 - + String notifiers 4.0.0 @@ -904,7 +904,7 @@ Notifier - Configures one method for notifying users/developers when a build breaks. + Configures one method for notifying users/developers when a build breaks. 4.0.0 @@ -972,7 +972,7 @@ 3.0.0+ role element, the body of which is a + described by a role element, the body of which is a role name. ]]> @@ -999,7 +999,7 @@ 3.0.0 true The name of the dependency.

+

The name of the dependency.

Note: The use of the id element for a dependency is deprecated. Please use groupId and @@ -1034,7 +1034,7 @@ 3.2.1 + The version of the dependency, e.g. 3.2.1 ]]> String @@ -1052,7 +1052,7 @@ jar 3.0.0 String @@ -1075,9 +1075,9 @@ properties 3.0.0 mark dependencies with properties. For example the - war plugin looks for a + war plugin looks for a war.bundle property, and if found will include the dependency in WEB-INF/lib. For example syntax, check the war plugin docs. @@ -1228,7 +1228,7 @@ url 4.0.0 - + String @@ -1246,7 +1246,7 @@ repository 4.0.0 @@ -1256,7 +1256,7 @@ site 4.0.0 @@ -1268,8 +1268,8 @@ License License page of + Describes the licenses for this project. This is used to generate + the License page of the project's web site. Typically the licenses listed for the project are that of the project itself, and not of dependencies. ]]> @@ -1365,7 +1365,7 @@ archive 3.0.0+ String @@ -1373,7 +1373,7 @@ otherArchives 3.1.0+ String @@ -1409,7 +1409,7 @@ logo 3.0.0 /images/org-logo.png) or an absolute URL (e.g., http://my.corp/logo.png). This value is used @@ -1468,20 +1468,20 @@ public List getDefaultExcludes() { List defaultExcludes = new ArrayList(); - defaultExcludes.add( "**/*~" ); + defaultExcludes.add( "**/*~" ); defaultExcludes.add( "**/#*#" ); defaultExcludes.add( "**/.#*" ); defaultExcludes.add( "**/%*%" ); defaultExcludes.add( "**/._*" ); // CVS - defaultExcludes.add( "**/CVS" ); + defaultExcludes.add( "**/CVS" ); defaultExcludes.add( "**/CVS/**" ); - defaultExcludes.add( "**/.cvsignore" ); + defaultExcludes.add( "**/.cvsignore" ); // SCCS defaultExcludes.add( "**/SCCS" ); - defaultExcludes.add( "**/SCCS/**" ); + defaultExcludes.add( "**/SCCS/**" ); // Visual SourceSafe defaultExcludes.add( "**/vssver.scc" ); @@ -1518,7 +1518,7 @@ version 4.0.0 - on of the project to extend.]]> + String @@ -1531,31 +1531,31 @@ connection 3.0.0 - Optional. The source configuration management system URL - that describes the repository and how to connect to the - repository. This is used by Maven when building versions - from specific ID. +

+ Optional. The source configuration management system URL + that describes the repository and how to connect to the + repository. This is used by Maven when building versions + from specific ID.

- The format of this element is as follows: + The format of this element is as follows: 

scm:<provider>:<provider-parameters>

For cvs, the format for pserver repositories should be:

- 
scm:cvs:pserver:user@host:/cvs/root:module-name
+ 
scm:cvs:pserver:user@host:/cvs/root:module-name

For local networked repositories (eg. pserver to local machine) -

+

- 
scm:cvs:lserver:user@host:/cvs/root:module-name
+ 
scm:cvs:lserver:user@host:/cvs/root:module-name

For ssh access: -

+

- 
scm:cvs:ext:user@host:/cvs/root:module-name
+ 
scm:cvs:ext:user@host:/cvs/root:module-name
Remember that CVS will expect an environment variable called @@ -1565,9 +1565,9 @@

Some cvs clients support other protocols, such as ntserver and extssh. Here's an example using CVS NT and ntserver: -

+

- 
scm|cvs|ntserver|user@server|e:\cvs|Deployment
+ 
scm|cvs|ntserver|user@server|e:\cvs|Deployment
Note the use of the vertical bar as delimiter as the repository has a @@ -1575,16 +1575,16 @@

For local file system repositories -

+

- 
scm:cvs:local:ignored:/cvs/root:module-name
+ 
scm:cvs:local:ignored:/cvs/root:module-name

For StarTeam access: -

+

- 
scm:starteam:username:password@host:port/project/view/folder
+ 
scm:starteam:username:password@host:port/project/view/folder
All of this information can be had from either the StarTeam Universal @@ -1644,7 +1644,7 @@ that describes the repository and how to connect to the repository. This is used by Maven when building versions + href="/plugins/dist/index.html">building versions from specific ID. ]]> String @@ -1685,7 +1685,7 @@ Resource below). These resources are used to complete the @@ -1698,7 +1698,7 @@ targetPath 3.0.0+ org.apache.maven.messages), you must specify this element with this value : org/apache/maven/messages @@ -1717,7 +1717,7 @@ SourceModification sourceModification element, which is then described by additional elements (described below). These modifications are used @@ -1731,7 +1731,7 @@ className 3.0.0 not be + If the class with this name can not be loaded, then the includes and excludes specified below will be applied to the contents of the sourceDirectory @@ -1766,7 +1766,7 @@ Version 3.0.0 version element ]]> @@ -1798,7 +1798,7 @@ + maven:dist builds. ]]> @@ -1846,7 +1846,7 @@ url 4.0.0 String @@ -1863,7 +1863,7 @@ layout 4.0.0 - The type of layout this repository uses for locating and storing aritfacts - can be "legacy" or "default". + The type of layout this repository uses for locating and storing artifacts - can be "legacy" or "default". String default @@ -1918,7 +1918,7 @@ url 4.0.0 String diff --git a/maven-site/src/site/xdoc/about.fml b/maven-site/src/site/xdoc/about.fml index 1c2f0f97f3..6e1a87d47a 100644 --- a/maven-site/src/site/xdoc/about.fml +++ b/maven-site/src/site/xdoc/about.fml @@ -149,7 +149,7 @@ Channel box).

- Please remember that is is a preview release, so please be patient with features that are not yet implemented, + Please remember that it is a preview release, so please be patient with features that are not yet implemented, and be prepared to do some research and to help out yourself wherever possible.

diff --git a/maven-site/src/site/xdoc/getting-started.xml b/maven-site/src/site/xdoc/getting-started.xml index 4ce8043624..c3175f44b5 100644 --- a/maven-site/src/site/xdoc/getting-started.xml +++ b/maven-site/src/site/xdoc/getting-started.xml @@ -169,7 +169,7 @@ m2 archetype:create

What is the plugins section all about? Well, this is how plugins are configured in Maven 2.0. - It is analogours to the + It is analogous to the project.properties file in Maven 1.0. You may note that it looks more verbose - but you'll see over time that it should be required much less, and is capable of much more powerful configuration than it's Maven 1.0 counterpart. In addition, we hope the burden of editing the POM will be diff --git a/maven-site/src/site/xdoc/project-descriptor.xml b/maven-site/src/site/xdoc/project-descriptor.xml index 8de3654e95..ca35dc5340 100644 --- a/maven-site/src/site/xdoc/project-descriptor.xml +++ b/maven-site/src/site/xdoc/project-descriptor.xml @@ -312,8 +312,8 @@ Contains information about a project's mailing lists. This is used to generate the - front - page of the site's web site. + Mailing Lists + page of the project's web site. @@ -398,7 +398,7 @@ This element describes all of the licenses for this project. Each license is described by a license element, which - is then describe by additional elements (described below). The + is then described by additional elements (described below). The auto-generated site documentation references this information. Projects should only list the license(s) that applies to the project and not the licenses that apply to dependencies. @@ -417,7 +417,7 @@ scm - Specification for the SCM use by the project. + Specification for the SCM used by the project. build @@ -439,7 +439,7 @@ dependencyManagement Default dependency information for grouped projects inheriting from - this one. This dependency information here will not be checked. + this one. The dependency information here will not be checked. Instead, when a POM derived from this one declares a dependency described by a groupId and an artifactId (version not necessary), the entries in here will supply default values for that dependency. @@ -509,7 +509,7 @@ directory - The directory where all generated by the build is placed. + The directory where all files generated by the build is placed. @@ -564,7 +564,7 @@ url - Url for the continuous integration system use by the project. + Url for the continuous integration system used by the project. notifiers @@ -627,7 +627,7 @@ roles The roles the contributor plays in the project. Each role is - describe by a + described by a role element, the body of which is a role name. @@ -665,7 +665,7 @@ version - The version of the dependency., e.g. + The version of the dependency, e.g. 3.2.1 @@ -885,7 +885,7 @@ version - The versi>on of the project to extend. + The version of the project to extend.

@@ -981,7 +981,7 @@ url - The url of of the repository + The url of the repository @@ -993,7 +993,7 @@ layout - The type of layout this repository uses for locating and storing aritfacts - can be "legacy" or "default". + The type of layout this repository uses for locating and storing artifacts - can be "legacy" or "default".

@@ -1020,7 +1020,7 @@ url - The url of of the location where website is deployed + The url of the location where website is deployed