[GRADLE-329] User manual chapter 14 on "Dependency Managment" is ambiguously titled and needs to be related to task concepts better Created: 20/Dec/08  Updated: 10/Feb/17  Resolved: 10/Feb/17

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

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


 Description   

First, instead of calling this chapter "Dependency Management"
I think it should be called something like "Artifact/CLASSPATH Dependency Management".

There are a few very different kinds of "dependency management" going on in Gradle:

o Inter-project dependencies
o task dependsOn dependencies
o Artifact/CLASSPATH configuration dependencies (using Ivy and/or Maven)

When reading this manual the first time, it's easy to get these concepts a bit jumbled up.
Many readers might have heard about Ivy and/or Maven but never used either one.
Having specific terms for each sense of the word 'dependency' would go a long way
to making this material easier to approach for a newbie.

Another thing that was fairly confusing at first was that there is a 'compile' task and
a related 'compile' configuration. The fact that they have the same name is sensible
once you get the idea, but when you're first learning all this stuff having the distinction
pointed out a bit more forcefully would be a real benefit. Section 14.2.1 and 14.3 do that,
but it comes a bit too late, and it's kind of vague.

One thing 14.3 might say is:

Examples:
The 'compile' configuration is linked to the 'compile' task.
The 'testRuntime' configuration is linked to the 'test' task.

You might also want to show how this linking is accomplished by hand.
I think this is how you'd do that (but haven't actually tried it):

dependencies

{ linkConfWithTask( "myConfigurationName", "myTaskName" ) }

 Comments   
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:23 CDT 2021 using Jira 8.4.2#804003-sha1:d21414fc212e3af190e92c2d2ac41299b89402cf.