You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Marcelo Romulo Fernandes (JIRA)" <ji...@codehaus.org> on 2008/07/17 16:41:26 UTC
[jira] Created: (ARCHETYPE-193) Description of requiredProperty
Description of requiredProperty
-------------------------------
Key: ARCHETYPE-193
URL: http://jira.codehaus.org/browse/ARCHETYPE-193
Project: Maven Archetype
Issue Type: New Feature
Components: Generator
Affects Versions: 2.0-alpha-3
Environment: windows xp sp2; java sun 1.6.0_07; maven 2.0.9
Reporter: Marcelo Romulo Fernandes
Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.
--
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
[jira] Commented: (ARCHETYPE-193) Description of requiredProperty
Posted by "ant elder (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/ARCHETYPE-193?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=182614#action_182614 ]
ant elder commented on ARCHETYPE-193:
-------------------------------------
+1, having a property description would be really useful
> Description of requiredProperty
> -------------------------------
>
> Key: ARCHETYPE-193
> URL: http://jira.codehaus.org/browse/ARCHETYPE-193
> Project: Maven Archetype
> Issue Type: New Feature
> Components: Generator
> Affects Versions: 2.0-alpha-3
> Environment: windows xp sp2; java sun 1.6.0_07; maven 2.0.9
> Reporter: Marcelo Romulo Fernandes
>
> Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
> I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.
--
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
[jira] Commented: (ARCHETYPE-193) Description of requiredProperty
Posted by "Herve Boutemy (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/ARCHETYPE-193?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=262290#action_262290 ]
Herve Boutemy commented on ARCHETYPE-193:
-----------------------------------------
any suggestion?
I didn't write the initial code, then I'm not sure I understand precisely the intent: any help appreciated
> Description of requiredProperty
> -------------------------------
>
> Key: ARCHETYPE-193
> URL: http://jira.codehaus.org/browse/ARCHETYPE-193
> Project: Maven Archetype
> Issue Type: New Feature
> Components: Generator
> Affects Versions: 2.0-alpha-3
> Environment: windows xp sp2; java sun 1.6.0_07; maven 2.0.9
> Reporter: Marcelo Romulo Fernandes
> Fix For: 2.1
>
>
> Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
> I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.
--
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
[jira] Updated: (ARCHETYPE-193) Description of requiredProperty
Posted by "Herve Boutemy (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/ARCHETYPE-193?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Herve Boutemy updated ARCHETYPE-193:
------------------------------------
Fix Version/s: 2.x
> Description of requiredProperty
> -------------------------------
>
> Key: ARCHETYPE-193
> URL: http://jira.codehaus.org/browse/ARCHETYPE-193
> Project: Maven Archetype
> Issue Type: New Feature
> Components: Generator
> Affects Versions: 2.0-alpha-3
> Environment: windows xp sp2; java sun 1.6.0_07; maven 2.0.9
> Reporter: Marcelo Romulo Fernandes
> Fix For: 2.x
>
>
> Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
> I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.
--
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
[jira] Updated: (ARCHETYPE-193) Description of requiredProperty
Posted by "Herve Boutemy (JIRA)" <ji...@codehaus.org>.
[ https://jira.codehaus.org/browse/ARCHETYPE-193?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Herve Boutemy updated ARCHETYPE-193:
------------------------------------
Fix Version/s: (was: 2.1)
2.x
> Description of requiredProperty
> -------------------------------
>
> Key: ARCHETYPE-193
> URL: https://jira.codehaus.org/browse/ARCHETYPE-193
> Project: Maven Archetype
> Issue Type: New Feature
> Components: Generator
> Affects Versions: 2.0-alpha-3
> Environment: windows xp sp2; java sun 1.6.0_07; maven 2.0.9
> Reporter: Marcelo Romulo Fernandes
> Fix For: 2.x
>
>
> Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
> I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (ARCHETYPE-193) Description of requiredProperty
Posted by "ant elder (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/ARCHETYPE-193?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=262309#action_262309 ]
ant elder commented on ARCHETYPE-193:
-------------------------------------
An example of a property is:
<requiredProperty key="includeTuscanyRuntime">
<defaultValue>Y</defaultValue>
</requiredProperty>
https://svn.apache.org/repos/asf/tuscany/sca-java-2.x/trunk/maven/archetypes/quickstart/src/main/resources/META-INF/maven/archetype-metadata.xml
You can run that architype with
mvn archetype:generate -DarchetypeCatalog=http://tuscany.apache.org
and choose archetype 3 and then it lets you set the values for the properties, one being includeTuscanyRuntime as defined above, but it just prompts as:
Define value for property 'includeTuscanyRuntime': Y:
Which isn't that descriptive and gives no help about what includeTuscanyRuntime means. The suggestion is to extend the requiredProperty definition to include a description saying what the property does, perhaps like this:
<requiredProperty key="includeTuscanyRuntime">
<defaultValue>Y</defaultValue>
<description>Should the Tuscany runtime dependencies be included in the generated pom.xml?</description>
</requiredProperty>
and then have that description displayed when prompting for the property value. Or else perhaps don't show the description by default but support entering a question mark ? at the prompt which then causes the description to be shown.
Thanks for looking anyway, fixing this JIRA and also http://jira.codehaus.org/browse/ARCHETYPE-308 would then have achetypes working in a much much more user friendly way.
> Description of requiredProperty
> -------------------------------
>
> Key: ARCHETYPE-193
> URL: http://jira.codehaus.org/browse/ARCHETYPE-193
> Project: Maven Archetype
> Issue Type: New Feature
> Components: Generator
> Affects Versions: 2.0-alpha-3
> Environment: windows xp sp2; java sun 1.6.0_07; maven 2.0.9
> Reporter: Marcelo Romulo Fernandes
> Fix For: 2.1
>
>
> Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
> I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.
--
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