You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Olivier Lamy (JIRA)" <ji...@codehaus.org> on 2007/12/19 09:29:58 UTC

[jira] Created: (MJAR-93) Improve the documentation concerning the archiver configuration

Improve the documentation concerning the archiver configuration
---------------------------------------------------------------

                 Key: MJAR-93
                 URL: http://jira.codehaus.org/browse/MJAR-93
             Project: Maven 2.x Jar Plugin
          Issue Type: Improvement
    Affects Versions: 2.1
            Reporter: Olivier Lamy
            Assignee: Olivier Lamy
             Fix For: 2.2


Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
We have to improve this with a sample configuration containing all options.


-- 
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: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_117325 ] 

Dennis Lundberg commented on MNG-3329:
--------------------------------------

I have some time off coming up soon, so I can help write some documentation.

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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] Closed: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Olivier Lamy (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Olivier Lamy closed MNG-3329.
-----------------------------

      Assignee: Olivier Lamy
    Resolution: Fixed

fix in rev 607477.

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Olivier Lamy (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_117326 ] 

Olivier Lamy commented on MNG-3329:
-----------------------------------

Cool.
My idea was to add an index page in archiver with a full plugin configuration sample containing fields explanation.
Something like http://maven.apache.org/plugins/maven-jar-plugin/examples/manifest-customization.html but with all fields.
WDYT ?
 

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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] Moved: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Olivier Lamy (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Olivier Lamy moved MJAR-93 to MNG-3329:
---------------------------------------

    Affects Version/s:     (was: 2.1)
                       Shared Components
        Fix Version/s:     (was: 2.2)
                       Reviewed Pending Version Assignment
                  Key: MNG-3329  (was: MJAR-93)
              Project: Maven 2  (was: Maven 2.x Jar Plugin)

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Olivier Lamy (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Olivier Lamy updated MNG-3329:
------------------------------

    Component/s: maven-archiver

Agree sounds a better place.

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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] Moved: (MSHARED-44) Improve the documentation concerning the archiver configuration

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MSHARED-44?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Brett Porter moved MNG-3329 to MSHARED-44:
------------------------------------------

    Fix Version/s:     (was: Reviewed Pending Version Assignment)
      Component/s:     (was: maven-archiver)
                   maven-archiver
              Key: MSHARED-44  (was: MNG-3329)
          Project: Maven Shared Components  (was: Maven 2)

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MSHARED-44
>                 URL: http://jira.codehaus.org/browse/MSHARED-44
>             Project: Maven Shared Components
>          Issue Type: Improvement
>          Components: maven-archiver
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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: (MJAR-93) Improve the documentation concerning the archiver configuration

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MJAR-93?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_117318 ] 

Dennis Lundberg commented on MJAR-93:
-------------------------------------

I think that we should create documentation for maven-archiver in maven-archiver. Since it is used by  several plugins it would be good to have these sample configurations in only one place.

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MJAR-93
>                 URL: http://jira.codehaus.org/browse/MJAR-93
>             Project: Maven 2.x Jar Plugin
>          Issue Type: Improvement
>    Affects Versions: 2.1
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: 2.2
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_118329 ] 

Dennis Lundberg commented on MNG-3329:
--------------------------------------

Copied docs from maven-jar-plugin, rewrote them and integrated them with the rest of the docs in r607846.

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Olivier Lamy (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Olivier Lamy updated MNG-3329:
------------------------------

    Assignee:     (was: Olivier Lamy)

some work started with rev 607354.

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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: (MNG-3329) Improve the documentation concerning the archiver configuration

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MNG-3329?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_117660 ] 

Dennis Lundberg commented on MNG-3329:
--------------------------------------

Examples are good, but I feel that they should explain concepts rather than details. Like the second example on the page you linked to. More of a "how do I" documentation than "what does this parameter do" documentation.

I think that the details of the fields belong in a reference section, like we have for mojos http://maven.apache.org/plugins/maven-jar-plugin/jar-mojo.html or for the pom http://maven.apache.org/ref/current/maven-model/maven.html

> Improve the documentation concerning the archiver configuration
> ---------------------------------------------------------------
>
>                 Key: MNG-3329
>                 URL: http://jira.codehaus.org/browse/MNG-3329
>             Project: Maven 2
>          Issue Type: Improvement
>          Components: maven-archiver
>    Affects Versions: Shared Components
>            Reporter: Olivier Lamy
>            Assignee: Olivier Lamy
>             Fix For: Reviewed Pending Version Assignment
>
>
> Currently the documentation concerning the mavenArchiver configuration is just a link to the javadoc.
> We have to improve this with a sample configuration containing all options.

-- 
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