On 6/27/07, Tjeerd Verhagen <[EMAIL PROTECTED]> wrote:
Updating the documents ========== A lot of documents need to be updated, to reflect the current package naming. I think the 'since #.#' is still useful and should stay in. But the package names need to be corrected! Is there already some Jira task created for the document updated related to the version 2.0.0?
No, no such jira task, but creating one is a good idea. for example: Using standalone (standalone.html)
Before version 2.0.0: java fr.jayasoft.ivy.Main -conf path/to/myivysettings.xml -ivy path/to/myivy.xml As of version 2.0.0: java org.apache.ivy.Main -settings <setting file> -ivy <ivy file> java org.apache.ivy.Main -settings path/to/myivysettings.xml -ivy path/to/myivy.xml
Indeed. Since our documentation is file based, it's easy to submit patches. And if you browse the documentation offline from the checked out version, it's very easy to edit it (in firefox just press ctrl+E). With a jira task opened, attaching patches would really be welcome :-) Adding javadoc
========== As I'm reading and strugeling throught all the code, I'm missing quite some javadoc :( and also the package desciptions (package.html) .... maybe I can start helping here... but not shore if I understand all the Ivy code correct, definitly would need some reviewing. (How should it be added to the source repo? Or just sending patches?)
Attaching patches to a jira issue is the best way to go. We will review them anyway, so submitting something is a good way to start a discussion and make sure some doc will end up in the sources. This kind of help is VERY appreciated. Improving the implementatoin
========== Several things come her in my mind, like declaration of public methods inside interfaces. Not really needed. (See http://checkstyle.sourceforge.net/config_modifier.html#RedundantModifier)
Improvements patches are welcome, including code cleaning. We have setup checkstyle quite recently, and are still working on code cleaning (to adhere to our new standard, that is standard java coding convention, including the removal of _ prefix in private attributes which takes time). Discussing improvements on this list before starting is a good idea. In the particular case of redundant modifiers, I think this has been discussed before and Gilles prefers to use public modifier in interface. I don't mind, so I think for the moment we'll stick with them, unless a heavy push toward this convention is made. Xavier -- Xavier Hanin - Independent Java Consultant Manage your dependencies with Ivy! http://incubator.apache.org/ivy/
