Wrong information on default value for destinationDir on https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:destinationDir #1086

Open
oveits opened this Issue Jan 2, 2017 · 4 comments

Projects

None yet

3 participants

@oveits
oveits commented Jan 2, 2017

The Jar documentation on https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:destinationDir has wrong information on the default value of destinationDir, pointing to 'build/distributions' instead of 'build/libs'.

Expected Behavior

I think, https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:destinationDir should specify following default value for the File destinationDir:

File destinationDir

The directory where the archive is generated into.

Default with java plugin:

project.libsDir

where default of libsDir is 'build/libs' as can be seen here.

Current Behavior

In the moment, I think, https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:destinationDir is specifying following default value for the File destinationDir:

File destinationDir

The directory where the archive is generated into.

Default with java plugin:

project.distsDir

where default of distsDir is 'build/distributions' as can be seen here again.

Context

N/A

Steps to Reproduce (for bugs)

N/A

Your Environment

  • Build scan URL:
    N/A
@bmuschko
Member
bmuschko commented Jan 3, 2017

You are correct. The docs use the wrong value here. Would you be interested in contributing the fix?

@oveits
oveits commented Jan 3, 2017

Yes, I am willing to contribute, but I do not know, where to find the location of the error. I have scanned the source code for the pattern, but I could not find it. This is, why I was forced to create an issue instead of a pull request. Can you give me a hint?

@oveits
oveits commented Jan 9, 2017

Hi @wolfs: I can see the project.distsDir, but I never could have found it, since there is no string like "File destinationDir" there. I will patch it online and send a pull request.

@oveits oveits added a commit to oveits/gradle that referenced this issue Jan 9, 2017
@oveits oveits Closes #1086: corrected documentation error
https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:destinationDir  had contained wrong information on default for the "File destinationDir". This patch is replacing the wrong default 'project.distsDir' by the correct default 'project.libsDir'.
cd16b51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment