[GRADLE-1551] typos in http://www.gradle.org/build_lifecycle.html Created: 16/May/11  Updated: 01/May/13  Resolved: 01/May/13

Status: Resolved
Project: Gradle
Affects Version/s: 1.0-milestone-3
Fix Version/s: 1.7-rc-1

Type: Improvement
Reporter: Brett L Schuchert Assignee: Unassigned
Resolution: Fixed Votes: 0


 Description   

http://www.gradle.org/build_lifecycle.html

Unnecessary comma
Later in this chapter we explain, how Gradle looks for a settings file.

Confusing/Inconsistent message
You only need to specify the leafs of the tree. Each parent path of the leaf project is assumed to be another subproject which obeys to the physical path assumption described above.

However, the example above is:
include 'project1', 'project2', 'project2:child1'

In this example, project2 is not a leaf node in your hierarchy.

You might consider replacing project2:child with project3:child.

Confusing Text
Example 237. Flat layout
settings.gradle
includeFlat 'project3', 'project4'
The includeFlat method takes directory names as an argument. Those directories need to exist at the same level as the root project directory. The location of those directories are considered as child projects of the root project in the virtual multi-project tree.
If those directories exist at the same level, does that mean they are sibling directories? that is, in this example...
~/src
root
project3
project4

Or do you mean
~/src
root
project3
project4

The second example seems to be the "include" example. However, with a little experimentation, it appears as if include and includeFlat both work for the example:
~/src
jjj
projectA

But then it turns out that this also works:
~/src
jjj
projectA

So maybe consider using the word "sibling". In any case, I was surprised that includeFlat found directories UNDER the root directory as well as siblings to it. I think this could be considered a minor defect as it muddies the issue a bit - on the other hand, it is convenient. But I worry about convenient stuff getting out of hand.


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