[ http://jira.codehaus.org/browse/MNG-142?page=comments#action_47102 ]
Arik Kfir commented on MNG-142: ------------------------------- I'm not sure that a usage section is needed, but what would be nice is have maven generate a human-readable (well, more readable than XML ;-) text describing the project. Something along the lines of: Project LA LA LA li LA This project is composed of three modules: - Rich client module - Common module - EJB module The LALA application is a CRM application designed to bla bla bla. It bla bla bla.... To install, run: "m2 install" To deploy, run: "m2 deploy" To create the site locally, run: "m2 site" etc etc. Or in short: describe the POM in words. What do you think? > project usage instructions in POM > --------------------------------- > > Key: MNG-142 > URL: http://jira.codehaus.org/browse/MNG-142 > Project: Maven 2 > Type: New Feature > Components: maven-model > Reporter: Brett Porter > Priority: Minor > > > I was wondering if we could wing in a new feature to m2, which is a short set > of build instructions for projects to show the user with maven -u. In m1, > this is done by showing pom.description + any maven.xml goals, which is very > crude. > What I was thinking for m2 was the following: > - maven -u shows maven.xml goals plus goals relevant to artifact type (jar:* > for jar, war:* for war - a new piece of metadata to indicate that attribute > should be show in the usage would be useful) > - a new element <usage/> to the POM. This should reference an apt filename (a > default of src/site/apt/usage.apt can be used), which is just displayed > verbatim before the goal references. > This means even someone new to Maven can pick up someone else's project, run > maven -u and get all the standard information, plus anything the project > author wants to add (prerequesites, custom defined goals, etc.) > Another addition might be to add extra goal descriptions to the output so > they can recommend some to the user on some occasions, but not on others. > This would override the default goals that are shown, so a more complete > element might be: > <usage> > <!-- Plain text description to show instead of loading from a file - only > one should be used --> > <description> > To build the jar for this project, simply run > "maven jar". > </description> > <!-- External APT description to show verbatim --> > <file>docs/apt/usage.apt</file> > <!-- Optional - defaults to those relevant to the artifact type --> > <recommended-goals>jar, install, deploy, site</recommended-goals> > </usage> -- 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: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]