You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Anuerin Diaz (JIRA)" <ji...@codehaus.org> on 2005/11/10 19:14:06 UTC
[jira] Commented: (MNG-1479) Improve pom annotations to create a great reference
[ http://jira.codehaus.org/browse/MNG-1479?page=comments#action_50577 ]
Anuerin Diaz commented on MNG-1479:
-----------------------------------
taken from http://jira.codehaus.org/browse/MNG-1492 (duplicate entry)
=================
Currently the documentation[1] on the Project descriptor file is sparse. Although most of the basic elements are understandable[2], some of the features remain under utilized (e.g. difference between dependencies and dependencyManagement, plugins and pluginsManagement, etc.).
A more in-depth explanation or discussion on what are the advantages of each element may be in order. Hopefully the user community can also contribute so that it would be easier to write the guide.
[1] http://maven.apache.org/maven-model/maven.html
[2] http://maven.apache.org/guides/introduction/introduction-to-the-pom.html
=================
> Improve pom annotations to create a great reference
> ---------------------------------------------------
>
> Key: MNG-1479
> URL: http://jira.codehaus.org/browse/MNG-1479
> Project: Maven 2
> Type: Improvement
> Components: documentation - general
> Versions: 2.0
> Environment: n/a
> Reporter: Jeff Jensen
>
>
> Besides the multi-module doc, my experience wishes for the POM entry descriptions - some are too vague. More detail (what is it for/why would you use it, how to use it), examples, valid values, etc. would help a lot.
> I think the project descriptor has big potential as a solid reference vehicle, with the added info. I would value that more than many of the "guides".
> For a simple example, the <packaging> element doesn't describe valid values, so a search begins to learn them. Viewing the schema doesn't help, as the packaging type is "string". Additionally, I think the phrase "type of artifact" is not intuitive to newbies, so listing the valid values would bring contextual explanation, as well as their definition.
> (from http://mail-archives.apache.org/mod_mbox/maven-users/200511.mbox/%3c1131545979.18047.488.camel@localhost.localdomain%3e)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org