diff --git a/main/src/main/scala/sbt/Plugins.scala b/main/src/main/scala/sbt/Plugins.scala index a7ada9b6e..926defd11 100644 --- a/main/src/main/scala/sbt/Plugins.scala +++ b/main/src/main/scala/sbt/Plugins.scala @@ -85,7 +85,7 @@ abstract class AutoPlugin extends Plugins.Basic } } /** - * A root AutoPlugin is a plugin which must be explicitly enabled by users in their `setPlugins` method + * A root AutoPlugin is a plugin which must be explicitly enabled by users in their `addPlugins` method * on a project. However, RootAutoPlugins represent the "root" of a tree of dependent auto-plugins. */ abstract class RootAutoPlugin extends AutoPlugin { diff --git a/main/src/main/scala/sbt/PluginsDebug.scala b/main/src/main/scala/sbt/PluginsDebug.scala index e130b2c8b..a24546c23 100644 --- a/main/src/main/scala/sbt/PluginsDebug.scala +++ b/main/src/main/scala/sbt/PluginsDebug.scala @@ -165,9 +165,9 @@ private[sbt] object PluginsDebug final case class PluginImpossible(plugin: AutoPlugin, context: Context, contradictions: Set[AutoPlugin]) extends EnableDeactivated /** Describes the requirements for activating [[plugin]] in [[context]]. - * @param context The base plguins, exclusions, and ultimately activated plugins + * @param context The base plugins, exclusions, and ultimately activated plugins * @param blockingExcludes Existing exclusions that prevent [[plugin]] from being activated and must be dropped - * @param enablingPlguins [[AutoPlugin]]s that are not currently enabled, but need to be enabled for [[plugin]] to activate + * @param enablingPlugins [[AutoPlugin]]s that are not currently enabled, but need to be enabled for [[plugin]] to activate * @param extraEnabledPlugins Plugins that will be enabled as a result of [[plugin]] activating, but are not required for [[plugin]] to activate * @param willRemove Plugins that will be deactivated as a result of [[plugin]] activating * @param deactivate Describes plugins that must be deactivated for [[plugin]] to activate. These require an explicit exclusion or dropping a transitive [[AutoPlugin]].*/ diff --git a/main/src/main/scala/sbt/Project.scala b/main/src/main/scala/sbt/Project.scala index 7604c9d27..afcc29826 100755 --- a/main/src/main/scala/sbt/Project.scala +++ b/main/src/main/scala/sbt/Project.scala @@ -51,7 +51,7 @@ sealed trait ProjectDefinition[PR <: ProjectReference] def auto: AddSettings /** The defined [[Plugins]] associated with this project. - A [[AutoPlguin]] is a common label that is used by plugins to determine what settings, if any, to add to a project. */ + A [[AutoPlugin]] is a common label that is used by plugins to determine what settings, if any, to add to a project. */ def plugins: Plugins /** The [[AutoPlugin]]s enabled for this project. This value is only available on a loaded Project. */ diff --git a/main/src/main/scala/sbt/plugins/IvyModule.scala b/main/src/main/scala/sbt/plugins/IvyModule.scala index 6ce0d9a9d..a0e361503 100644 --- a/main/src/main/scala/sbt/plugins/IvyModule.scala +++ b/main/src/main/scala/sbt/plugins/IvyModule.scala @@ -14,7 +14,8 @@ import Def.Setting * - `publishedArtifacts` */ object IvyModule extends AutoPlugin { - // We must be explicitly enabled + // We are automatically included on everything that has the global module, + // which is automatically included on everything. def select = GlobalModule override lazy val projectSettings: Seq[Setting[_]] = diff --git a/main/src/main/scala/sbt/plugins/JvmModule.scala b/main/src/main/scala/sbt/plugins/JvmModule.scala index 6dd95d9c0..0a7219c26 100644 --- a/main/src/main/scala/sbt/plugins/JvmModule.scala +++ b/main/src/main/scala/sbt/plugins/JvmModule.scala @@ -15,7 +15,8 @@ import Def.Setting * - `Compile` */ object JvmModule extends AutoPlugin { - // We must be explicitly enabled + // We are automatically enabled for any IvyModule project. We also require its settings + // for ours to work. def select = IvyModule override lazy val projectSettings: Seq[Setting[_]] =