update docs, make minor improvements

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@125826 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
brett 2005-01-20 22:32:27 +00:00
parent 90fc4b14e2
commit 137328661e
5 changed files with 27 additions and 25 deletions

View File

@ -32,7 +32,11 @@
<log:info/> <log:info/>
<i:ask question="${pom.artifactId} ${pom.currentVersion} >" answer="goal" default="${lastGoal}"/> <i:ask question="${pom.artifactId} ${pom.currentVersion} >" answer="goal" default="${lastGoal}"/>
<j:choose> <j:choose>
<j:when test="${goal.indexOf('=') != '-1'}"> <j:when test="${goal.indexOf('=') == '0'}">
<j:set var="prop" value="${goal.substring(1)}" />
<log:info>${prop} = ${context.getVariable(prop)}</log:info>
</j:when>
<j:when test="${goal.indexOf('=') gt 0}">
<util:tokenize var="propertyPieces" delim="=">${goal}</util:tokenize> <util:tokenize var="propertyPieces" delim="=">${goal}</util:tokenize>
<log:info>Setting property ${propertyPieces[0]} to ${propertyPieces[1]}</log:info> <log:info>Setting property ${propertyPieces[0]} to ${propertyPieces[1]}</log:info>
<j:set var="${propertyPieces[0]}" value="${propertyPieces[1]}" scope="parent" /> <j:set var="${propertyPieces[0]}" value="${propertyPieces[1]}" scope="parent" />
@ -40,9 +44,6 @@
<j:when test="${goal=='help'}"> <j:when test="${goal=='help'}">
<attainGoal name="console:help"/> <attainGoal name="console:help"/>
</j:when> </j:when>
<j:when test="${goal=='list'}">
<attainGoal name="console:listGoals"/>
</j:when>
<j:when test="${goal=='quit'}"> <j:when test="${goal=='quit'}">
<j:set var="followOn" value="false"/> <j:set var="followOn" value="false"/>
</j:when> </j:when>
@ -66,20 +67,14 @@
</j:while> </j:while>
</goal> </goal>
<goal name="console:listGoals" description="List all available goals">
<j:set var="proj" value="${org.apache.commons.jelly.werkz.Project}"/>
<j:forEach var="listGoal" items="${proj.goals}" trim="false">
<log:info>${listGoal.name}</log:info>
</j:forEach>
</goal>
<goal name="console:help" description="Print the help message."> <goal name="console:help" description="Print the help message.">
<log:info> <log:info>
The following commands are available: The following commands are available:
list - list all available goals
help - this message help - this message
&lt;goalname&gt; - attain a goal &lt;goalname&gt; - attain a goal
&lt;property&gt;=&lt;value&gt; - set a property value
=&lt;property&gt; - display a property value
quit - quits the console quit - quits the console
</log:info> </log:info>

View File

@ -23,7 +23,7 @@
<pomVersion>3</pomVersion> <pomVersion>3</pomVersion>
<id>maven-console-plugin</id> <id>maven-console-plugin</id>
<name>Maven Console Plugin</name> <name>Maven Console Plugin</name>
<currentVersion>1.1</currentVersion> <currentVersion>1.2-SNAPSHOT</currentVersion>
<shortDescription>Console for Maven</shortDescription> <shortDescription>Console for Maven</shortDescription>
<url>http://maven.apache.org/reference/plugins/console/</url> <url>http://maven.apache.org/reference/plugins/console/</url>
<issueTrackingUrl>http://jira.codehaus.org/browse/MPCONSOLE</issueTrackingUrl> <issueTrackingUrl>http://jira.codehaus.org/browse/MPCONSOLE</issueTrackingUrl>

View File

@ -24,6 +24,11 @@
<author email="dion@multitask.com.au">dIon Gillard</author> <author email="dion@multitask.com.au">dIon Gillard</author>
</properties> </properties>
<body> <body>
<release version="1.2-SNAPSHOT" date="in SVN">
<action dev="brett" type="remove">Removed the <code>list</code> command as it hasn't worked as expected since the early betas (goals are lazy loaded into the werkz project)</action>
<action dev="brett" type="add">Add way to display a property value</action>
<action dev="brett" type="update">Improve help</action>
</release>
<release version="1.1" date="2004-05-15"> <release version="1.1" date="2004-05-15">
<action dev="brett" type="add" issue="MPCONSOLE-2">Add some whitespace before goal</action> <action dev="brett" type="add" issue="MPCONSOLE-2">Add some whitespace before goal</action>
<action dev="brett" type="fix">Set properties in parent scope so it takes effect for plugin properties</action> <action dev="brett" type="fix">Set properties in parent scope so it takes effect for plugin properties</action>

View File

@ -35,12 +35,6 @@
awaiting input. awaiting input.
</td> </td>
</tr> </tr>
<tr>
<td>console:listGoals</td>
<td>
Lists the goals available for the currently loaded project
</td>
</tr>
<tr> <tr>
<td>console:help</td> <td>console:help</td>
<td>Displays a help message along with a list of valid commands</td> <td>Displays a help message along with a list of valid commands</td>

View File

@ -34,13 +34,21 @@
</p> </p>
<p> <p>
The console simply loads the current project.xml and waits for The console simply loads the current project.xml and waits for
the user to supply a goal (or other command) to execute. The the user to supply a goal (or set of comma-separated goals) to execute.
following commands are currently implemented:
<ul>
<li>help - displays the valid commands for the console</li>
<li>list - lists valid goals for the loaded project</li>
</ul>
</p> </p>
<source>clean,jar:jar</source>
<p>
You can press enter to re-run the last successful goal which is
displayed in the prompt.
</p>
<p>
To change a property on the fly, assign it like so:
</p>
<source>maven.test.skip=true</source>
<p>
To check the current value of a property, start the command with <code>=</code>:
</p>
<source>=maven.compile.source</source>
<p> <p>
For more information on the functionality provided by this plugin, For more information on the functionality provided by this plugin,
please see the <a href="goals.html">Goals</a> document. please see the <a href="goals.html">Goals</a> document.