migrate comments

Author: jtjeferreira

src/main/scala/com/typesafe/sbt/packager/archetypes/JavaAppPackaging.scala

@@ -48,7 +48,7 @@ object JavaAppPackaging extends AutoPlugin {
       // Here we record the classpath as it's added to the mappings separately, so
       // we can use its order to generate the bash/bat scripts.
       scriptClasspathOrdering := Nil,
-      // Note: This is sometimes on the classpath via dependencyClasspath in Runtime.
+      // Note: This is sometimes on the classpath via Runtime / dependencyClasspath.
       // We need to figure out why sometimes the Attributed[File] is correctly configured
       // and sometimes not.
       scriptClasspathOrdering += {

src/main/scala/com/typesafe/sbt/packager/archetypes/JavaServerApplication.scala

@@ -209,7 +209,7 @@ object JavaServerAppPackaging extends AutoPlugin {
     * @param name
     *   of the etc-default config file
     * @param tmpDir
-    *   to store the resulting file in (e.g. target in Universal)
+    *   to store the resulting file in (e.g. Universal / target)
     * @param source
     *   of etc-default script
     * @param replacements

src/main/scala/com/typesafe/sbt/packager/archetypes/MaintainerScriptHelper.scala

@@ -16,7 +16,7 @@ trait MaintainerScriptHelper {
     * @example
     *   {{{
     * import DebianConstants._
-    * maintainerScripts in Debian := maintainerScriptsFromDirectory(
+    * Debian / maintainerScripts := maintainerScriptsFromDirectory(
     *   sourceDirectory.value / DebianSource / DebianMaintainerScripts, Seq(Preinst, Postinst, Prerm, Postrm)
     * )
     *   }}}
@@ -43,29 +43,29 @@ trait MaintainerScriptHelper {
     *   Adding content from a string
     *   {{{
     * import RpmConstants._
-    * maintainerScripts in Rpm := maintainerScriptsAppend((maintainerScripts in Rpm).value)(
+    * Rpm / maintainerScripts := maintainerScriptsAppend((Rpm / maintainerScripts).value)(
     *    Pretrans -> "echo 'hello, world'",
-    *    Post -> "echo 'installing " + (packageName in Rpm).value + "'"
+    *    Post -> "echo 'installing " + (Rpm / packageName).value + "'"
     * )
     *   }}}
     *
     * @example
     *   Adding content from a string and use script replacements
     *   {{{
     * import DebianConstants._
-    * maintainerScripts in Rpm := maintainerScriptsAppend(
-    *   (maintainerScripts in Debian).value,
-    *   (linuxScriptReplacements in Debian).value
+    * Rpm / maintainerScripts := maintainerScriptsAppend(
+    *   (Debian / maintainerScripts).value,
+    *   (Debian / linuxScriptReplacements).value
     * )(
     *    Preinst -> "echo 'hello, world'",
-    *    Postinst -> s"echo 'installing ${(packageName in Debian).value}'"
+    *    Postinst -> s"echo 'installing ${(Debian packageName).value}'"
     * )
     *   }}}
     *
     * @param current
     *   maintainer scripts
     * @param replacements
-    *   (e.g. (linuxScriptReplacements in Debian).value)
+    *   (e.g. (Debian / linuxScriptReplacements).value)
     * @param scripts
     *   scriptName -> scriptContent pairs
     * @return
@@ -90,7 +90,7 @@ trait MaintainerScriptHelper {
     *   Adding content from a string
     *   {{{
     * import RpmConstants._
-    * maintainerScripts in Rpm := maintainerScriptsAppendFromFile((maintainerScripts in Rpm).value)(
+    * Rpm / maintainerScripts := maintainerScriptsAppendFromFile((Rpm / maintainerScripts).value)(
     *    Pretrans -> (sourceDirectory.value / "rpm" / "pretrans"),
     *    Post -> (sourceDirectory.value / "rpm" / "posttrans")
     * )

src/main/scala/com/typesafe/sbt/packager/archetypes/scripts/ApplicationIniGenerator.scala

@@ -35,7 +35,7 @@ trait ApplicationIniGenerator {
               // TODO: merge JVM options into the existing application.ini?
               log.warn("--------!!! JVM Options are defined twice !!!-----------")
               log.warn(
-                "application.ini is already present in output package. Will be overridden by 'javaOptions in Universal'"
+                "application.ini is already present in output package. Will be overridden by 'Universal / javaOptions'"
               )
               false
 

src/main/scala/com/typesafe/sbt/packager/archetypes/scripts/StartScriptMainClassConfig.scala

@@ -40,9 +40,9 @@ object StartScriptMainClassConfig {
 
   /**
     * @param mainClass
-    *   optional main class, e.g. from (mainClass in Compile).value
+    *   optional main class, e.g. from (Compile / mainClass).value
     * @param discoveredMainClasses
-    *   all discovered main classes, e.g. from (discoveredMainClasses in Compile).value
+    *   all discovered main classes, e.g. from (Compile / discoveredMainClasses).value
     * @return
     *   A start script configuration
     */

src/main/scala/com/typesafe/sbt/packager/archetypes/systemloader/package.scala

@@ -67,7 +67,7 @@ package object systemloader {
   ): Seq[LinuxPackageMapping] = {
     val name = scriptName.getOrElse(
       sys.error(
-        """No linuxStartScriptName defined. Add `linuxStartScriptName in <PackageFormat> := Some("name.service")"""
+        """No linuxStartScriptName defined. Add `<PackageFormat> / linuxStartScriptName := Some("name.service")"""
       )
     )
     val path = location + "/" + name

src/main/scala/com/typesafe/sbt/packager/debian/JDebPackaging.scala

@@ -48,8 +48,8 @@ object JDebPackaging extends AutoPlugin with DebianPluginLike {
         val data = debianPackageMetadata.value
         val size = debianPackageInstallSize.value
         if (data.info.description == null || data.info.description.isEmpty)
-          sys.error("""packageDescription in Debian cannot be empty. Use
-                 packageDescription in Debian := "My package Description"""")
+          sys.error("""Debian / packageDescription cannot be empty. Use
+                 Debian / packageDescription := "My package Description"""")
         val cfile = target.value / Names.DebianMaintainerScripts / Names.Control
         IO.write(cfile, data.makeContent(size), java.nio.charset.Charset.defaultCharset)
         cfile

src/main/scala/com/typesafe/sbt/packager/docker/DockerPlugin.scala

@@ -625,7 +625,7 @@ object DockerPlugin extends AutoPlugin {
   }
 
   /**
-    * uses the `mappings in Universal` to generate the `Docker / mappings`.
+    * uses the `Universal / mappings` to generate the `Docker / mappings`.
     */
   def mapGenericFilesToDocker: Seq[Setting[_]] = {
     def renameDests(from: Seq[(File, String)], dest: String) =

src/main/scala/com/typesafe/sbt/packager/jdkpackager/JDKPackagerAntHelper.scala

@@ -184,9 +184,9 @@ object JDKPackagerAntHelper {
 
     if (antTaskLib.isEmpty)
       sys.error(
-        "Please set key `antPackagerTasks in JDKPackager` to `ant-javafx.jar` path, " +
+        "Please set key `JDKPackager / antPackagerTasks` to `ant-javafx.jar` path, " +
           "which should be found in the `lib` directory of the Oracle JDK 8 installation. For example (Windows):\n" +
-          """(antPackagerTasks in JDKPackager) := Some(file("C:\\Program Files\\Java\\jdk1.8.0_45\\lib\\ant-javafx.jar"))"""
+          """(JDKPackager / antPackagerTasks) := Some(file("C:\\Program Files\\Java\\jdk1.8.0_45\\lib\\ant-javafx.jar"))"""
       )
 
     val taskClassPath = antTaskLib.get +: antExtraClasspath

src/main/scala/com/typesafe/sbt/packager/rpm/RpmMetadata.scala

@@ -152,14 +152,14 @@ case class RpmSpec(
     // format: off
     val emptyValidators =
       Seq(
-        ensureOr(meta.name, "`name in Rpm` is empty.  Please provide one.", isNonEmpty),
-        ensureOr(meta.version, "`version in Rpm` is empty.  Please provide a valid version for the rpm SPEC.", isNonEmpty),
+        ensureOr(meta.name, "`Rpm / name` is empty.  Please provide one.", isNonEmpty),
+        ensureOr(meta.version, "`Rpm / version` is empty.  Please provide a valid version for the rpm SPEC.", isNonEmpty),
         ensureOr(meta.release, "`rpmRelease` is empty.  Please provide a valid release number for the rpm SPEC.", isNonEmpty),
-        ensureOr(meta.arch, "`packageArchitecture in Rpm` is empty.  Please provide a valid architecture for the rpm SPEC.", isNonEmpty),
+        ensureOr(meta.arch, "`Rpm / packageArchitecture` is empty.  Please provide a valid architecture for the rpm SPEC.", isNonEmpty),
         ensureOr(meta.vendor, "`rpmVendor` is empty.  Please provide a valid vendor for the rpm SPEC.", isNonEmpty),
         ensureOr(meta.os, "`rpmOs` is empty.  Please provide a valid os value for the rpm SPEC.", isNonEmpty),
-        ensureOr(meta.summary, "`packageSummary in Rpm` is empty.  Please provide a valid summary for the rpm SPEC.", isNonEmpty),
-        ensureOr(meta.description, "`packageDescription in Rpm` is empty.  Please provide a valid description for the rpm SPEC.", isNonEmpty)
+        ensureOr(meta.summary, "`Rpm / packageSummary` is empty.  Please provide a valid summary for the rpm SPEC.", isNonEmpty),
+        ensureOr(meta.description, "`Rpm / packageDescription` is empty.  Please provide a valid description for the rpm SPEC.", isNonEmpty)
       )
     // format: on
     // TODO - Continue validating after this point?