luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve doc on ModuleDetailReport per @jsuereth

This commit is contained in:
Eugene Yokota 2014-07-28 13:25:54 -04:00
parent cdf3c6e857
commit d6dbbaaf2e
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ivy/src/main/scala/sbt/UpdateReport.scala
View File

@ -47,6 +47,7 @@ final class ConfigurationReport(
val configuration: String,
val modules: Seq[ModuleReport],
val details: Seq[ModuleDetailReport],
@deprecated("Use details instead to get better eviction info.", "0.13.6")
val evicted: Seq[ModuleID]) {
def this(configuration: String, modules: Seq[ModuleReport], evicted: Seq[ModuleID]) =
this(configuration, modules, Nil, evicted)
@ -67,9 +68,15 @@ final class ConfigurationReport(
}
/**
* ModuleDetailReport represents an organization+name entry in Ivy resolution report.
* In sbt's terminology, "module" consists of organization, name, and version.
* In Ivy's, "module" means just organization and name, and the one including version numbers
* are called revisions.
*
* A sequence of ModuleDetailReport called details is newly added to ConfigurationReport, replacing evicted.
* (Note old evicted was just a seq of ModuleIDs).
* ModuleDetailReport groups the ModuleReport of both winners and evicted reports by their organization and name,
* which can be used to calculate detailed evction warning etc.
*/
final class ModuleDetailReport(
val organization: String,