You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Maria Odea Ching <oc...@exist.com> on 2006/07/12 11:50:25 UTC

Please review maven source plugin documentation

Hi Everyone,

The documentation for the source plugin is now ready for review :)

Thanks,
Odea

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: Please review maven source plugin documentation

Posted by Maria Odea Ching <oc...@exist.com>.
Hi,

I've revised the documentation for the source plugin.
A staging site is now available at 
http://people.apache.org/~oching/maven-source-plugin 
<http://people.apache.org/%7Eoching/maven-source-plugin>.

Thanks,
Odea

Maria Odea Ching wrote:

> Ok, thanks for the comments :) Will post it on jira and revise the docs.
>
> Dennis Lundberg wrote:
>
>> Maria Odea Ching wrote:
>>
>>> Hi Everyone,
>>>
>>> The documentation for the source plugin is now ready for review :)
>>>
>>> Thanks,
>>> Odea
>>
>>
>>
>> My comments:
>>
>> faq.html
>> - "Use the source:test-jar to" -> "Use the source:test-jar goal to"
>>
>> examples/configureplugin.html
>> - "To customize the configuration of the plugin" ->
>>   "To customize the plugin"
>> - "The generated jar file will hold the value of the" ->
>>   "The generated jar file will be named by the value of the"
>> - "It would be generated" -> "It will be generated"
>> - "The attach parameter specifies that the produced jar file will be 
>> attached to the project artifact."
>> What does this mean?
>>
>> jar-mojo.html
>> - "This plugin bundles all the generated sources into a jar archive." ->
>>   "This plugin bundles all the sources into a jar archive."
>>
>> test-jar-mojo.html
>> - "This plugin bundles all the generated test sources into a jar 
>> archive." ->
>>   "This plugin bundles all the test sources into a jar archive."
>>
>> jar-mojo.html and test-jar-mojo.html
>> - executedProject, finalName and outputDirectory params: These must 
>> have some kind of implicit default values, because I can issue the 
>> command "mvn source:jar" and it works.
>>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: Please review maven source plugin documentation

Posted by Maria Odea Ching <oc...@exist.com>.
Ok, thanks for the comments :) Will post it on jira and revise the docs.

Dennis Lundberg wrote:

> Maria Odea Ching wrote:
>
>> Hi Everyone,
>>
>> The documentation for the source plugin is now ready for review :)
>>
>> Thanks,
>> Odea
>
>
> My comments:
>
> faq.html
> - "Use the source:test-jar to" -> "Use the source:test-jar goal to"
>
> examples/configureplugin.html
> - "To customize the configuration of the plugin" ->
>   "To customize the plugin"
> - "The generated jar file will hold the value of the" ->
>   "The generated jar file will be named by the value of the"
> - "It would be generated" -> "It will be generated"
> - "The attach parameter specifies that the produced jar file will be 
> attached to the project artifact."
> What does this mean?
>
> jar-mojo.html
> - "This plugin bundles all the generated sources into a jar archive." ->
>   "This plugin bundles all the sources into a jar archive."
>
> test-jar-mojo.html
> - "This plugin bundles all the generated test sources into a jar 
> archive." ->
>   "This plugin bundles all the test sources into a jar archive."
>
> jar-mojo.html and test-jar-mojo.html
> - executedProject, finalName and outputDirectory params: These must 
> have some kind of implicit default values, because I can issue the 
> command "mvn source:jar" and it works.
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: Please review maven source plugin documentation

Posted by Dennis Lundberg <de...@apache.org>.
Maria Odea Ching wrote:
> Hi Everyone,
> 
> The documentation for the source plugin is now ready for review :)
> 
> Thanks,
> Odea

My comments:

faq.html
- "Use the source:test-jar to" -> "Use the source:test-jar goal to"

examples/configureplugin.html
- "To customize the configuration of the plugin" ->
   "To customize the plugin"
- "The generated jar file will hold the value of the" ->
   "The generated jar file will be named by the value of the"
- "It would be generated" -> "It will be generated"
- "The attach parameter specifies that the produced jar file will be 
attached to the project artifact."
What does this mean?

jar-mojo.html
- "This plugin bundles all the generated sources into a jar archive." ->
   "This plugin bundles all the sources into a jar archive."

test-jar-mojo.html
- "This plugin bundles all the generated test sources into a jar 
archive." ->
   "This plugin bundles all the test sources into a jar archive."

jar-mojo.html and test-jar-mojo.html
- executedProject, finalName and outputDirectory params: These must have 
some kind of implicit default values, because I can issue the command 
"mvn source:jar" and it works.

-- 
Dennis Lundberg

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org