[GRADLE-321] Parameters to dists/libs task methods like jar() and zip() are under-documented (pp. 26, 29, 64) Created: 11/Dec/08  Updated: 10/Feb/17  Resolved: 10/Feb/17

Status: Resolved
Project: Gradle
Affects Version/s: 0.5
Fix Version/s: None

Type: Bug
Reporter: Jon Cox Assignee: Unassigned
Resolution: Won't Fix Votes: 0


 Description   

On page 26, 29 and 64 of the user's manual, there are code specimens that
show usage of the jar() and zip() task methods like:

zip()

{... }


zip( appendix: '...', classifier: '...' )

{ ...}

libs.jar( 'api-spi' )

{ ... }

However, the set of valid parameters one can pass to these methods
(and their meaning), does not seem to be defined anywhere else
in the document.

This is confusing. Sometimes zip() has an appendix, sometimes it
is removed (ok bad joke, but still !). The manual should say what it is.

Also, can jar() take a single string argument, or is this a typo?



 Comments   
Comment by Hans Dockter [ 12/Dec/08 ]

However, the set of valid parameters one can pass to these methods
(and their meaning), does not seem to be defined anywhere else
in the document.

This is confusing. Sometimes zip() has an appendix, sometimes it
is removed (ok bad joke, but still !). The manual should say what it is.

Agreed. And if you have a better term then appendix I think we are very happy to change this. At the time I created it I could not come up with something better although I was never that happy with the term.

.bq Also, can jar() take a single string argument, or is this a typo?

We have forgotten to update this. In earlier versions this was possible, not any longer.

Comment by Benjamin Muschko [ 15/Nov/16 ]

As announced on the Gradle blog we are planning to completely migrate issues from JIRA to GitHub.

We intend to prioritize issues that are actionable and impactful while working more closely with the community. Many of our JIRA issues are inactionable or irrelevant. We would like to request your help to ensure we can appropriately prioritize JIRA issues you’ve contributed to.

Please confirm that you still advocate for your JIRA issue before December 10th, 2016 by:

  • Checking that your issues contain requisite context, impact, behaviors, and examples as described in our published guidelines.
  • Leave a comment on the JIRA issue or open a new GitHub issue confirming that the above is complete.

We look forward to collaborating with you more closely on GitHub. Thank you for your contribution to Gradle!

Comment by Benjamin Muschko [ 10/Feb/17 ]

Thanks again for reporting this issue. We haven't heard back from you after our inquiry from November 15th. We are closing this issue now. Please create an issue on GitHub if you still feel passionate about getting it resolved.

Generated at Wed Jun 30 11:27:11 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.