Skip to content

Commit

Permalink
gradle: merge indexOBR and indexR5 tasks into index task
Browse files Browse the repository at this point in the history
Signed-off-by: Ferry Huberts <[email protected]>
  • Loading branch information
fhuberts committed Apr 25, 2014
1 parent 5bb87c1 commit d5b520b
Show file tree
Hide file tree
Showing 7 changed files with 216 additions and 329 deletions.
39 changes: 11 additions & 28 deletions cnf/gradle/doc/BUILDING-GRADLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,9 +494,15 @@ This is in addition to the ```clean``` task that is defined by the Java plugin.

## All Projects

### Index Tasks
### index

This task can create one or more of the following:
* an uncompressed OBR index
* an uncompressed R5 index
* a compressed OBR index
* a compressed R5 index

#### Index Tasks Configuration
These indexes are generated from/for one or more configured directories.

Which directories are indexed is controlled by
the ```gradleBuild_indexDirectories``` property. Its **syntax** is:
Expand Down Expand Up @@ -524,10 +530,9 @@ above):
syntax,syntax,...
```

#### indexOBR

This task creates an uncompressed OBR index and/or a compressed OBR index of
one or more configured directories.
This task is automatically disabled when no index directories have been defined
or when no OBR indexes **and** no R5 indexes are configured to be created
(either uncompressed or compressed).

OBR index generation is controlled by the properties

Expand All @@ -537,16 +542,6 @@ OBR index generation is controlled by the properties
* &nbsp;```gradleBuild_indexOBRCompressed``` if set to ```true``` then a
compressed OBR index is generated.

This task is automatically disabled when no index directories have been defined
or when no OBR indexes are configured to be created (either uncompressed or
compressed).

#### indexR5

This task creates an uncompressed R5 index and/or a compressed R5 index of
one or more configured directories, and is completely equivalent to
the ```indexOBR``` task.

R5 index generation is controlled by the properties

* &nbsp;```gradleBuild_indexR5Uncompressed```: if set to ```true``` then an
Expand All @@ -555,18 +550,6 @@ R5 index generation is controlled by the properties
* &nbsp;```gradleBuild_indexR5Compressed``` if set to ```true``` then a
compressed R5 index is generated.

This task is automatically disabled when no index directories have been defined
or when no R5 indexes are configured to be created (either uncompressed or
compressed).

### index

This task simply runs the ```indexOBR``` and ```indexR5``` tasks.

This task is automatically disabled when no index directories have been defined
or when no OBR indexes **and** no R5 indexes are configured to be created
(either uncompressed or compressed).

### cleanNeeded

This task will invoke the ```clean``` task on all projects on which the
Expand Down
12 changes: 1 addition & 11 deletions cnf/gradle/doc/bnd.dot
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,6 @@ digraph GradleSetup {
subgraph cluster21 {
label="";
style=invis;
indexOBR [shape=box, style=filled, fillcolor=cyan , label="indexOBR" ]
indexR5 [shape=box, style=filled, fillcolor=cyan , label="indexR5" ]
index [shape=box, style=filled, fillcolor=cyan , label="index" ]
}

Expand All @@ -179,9 +177,6 @@ digraph GradleSetup {
distcleanNeeded [shape=box, style=filled, fillcolor=cyan , label="distcleanNeeded" ]
}

indexOBR -> index
indexR5 -> index

clean -> cleanNeeded [color=blue ]
cleanNeeded -> cleanNeeded [color=red ]
clean -> distclean [color=blue ]
Expand All @@ -197,15 +192,10 @@ digraph GradleSetup {
fillcolor=lightgrey;
color=black;

distIndexOBR [shape=box, style=filled, fillcolor=cyan, label="indexOBR"]
distIndexR5 [shape=box, style=filled, fillcolor=cyan, label="indexR5"]
distIndex [shape=box, style=filled, fillcolor=cyan, label="index"]
distDist [shape=box, style=filled, fillcolor=cyan, label="dist"]

release -> distIndexOBR [color=red ]
release -> distIndexR5 [color=red ]
distIndexOBR -> distIndex
distIndexR5 -> distIndex
release -> distIndex [color=red ]
distIndex -> distDist
}
}
Loading

0 comments on commit d5b520b

Please sign in to comment.