Clarify sbtLockHashIsUpToDate description re: transitive project deps.

tkawachi · Dec 12, 2018 · b9e53b1 · b9e53b1
1 parent a9f284f
commit b9e53b1
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/scala/com/github/tkawachi/sbtlock/SbtLockKeys.scala b/src/main/scala/com/github/tkawachi/sbtlock/SbtLockKeys.scala
@@ -8,6 +8,8 @@ object SbtLockKeys {
   val unlock = taskKey[Unit]("Delete a version locking file for sbt-lock")
   val collectLockModuleIDs = taskKey[Seq[ModuleID]]("Collect ModuleIDs to lock")
   val checkLockUpdate = taskKey[Unit]("Check whether a version locking file needs update")
-  val sbtLockHashIsUpToDate = settingKey[Boolean]("lock.sbt file is up to date with libraryDependencies.")
+  val sbtLockHashIsUpToDate = settingKey[Boolean]("lock.sbt file is up to date with libraryDependencies in the current project. " +
+    "(sbtLockHashIsUpToDate in ThisProject) does NOT consider the libraryDependencies of project dependencies! " +
+    "(sbtLockHashIsUpToDate in ThisBuild) considers the libraryDependencies across all projects.")
   val sbtLockIgnoreOverridesOnStaleHash = settingKey[Boolean]("When libraryDependencies are changed, ignores the lock.sbt file.")
 }