Mailing-List: contact notifications-help@freemarker.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@freemarker.incubator.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: ddekany@apache.org
To: notifications@freemarker.incubator.apache.org
Message-Id: <ae5c7637a75549ffaa67363ef9598a63@git.apache.org>
Subject: incubator-freemarker git commit: Build: Some cleanup around the
 project title and description
Date: Tue, 16 May 2017 16:47:11 +0000 (UTC)
archived-at: Tue, 16 May 2017 16:47:17 -0000

Repository: incubator-freemarker
Updated Branches:
  refs/heads/3 4b75ea930 -> 86a28b2fb


Build: Some cleanup around the project title and description


Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/86a28b2f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/86a28b2f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/86a28b2f

Branch: refs/heads/3
Commit: 86a28b2fb5c5bd79aa4dc3c3fd8beee426489376
Parents: 4b75ea9
Author: ddekany <ddekany@apache.org>
Authored: Tue May 16 18:47:02 2017 +0200
Committer: ddekany <ddekany@apache.org>
Committed: Tue May 16 18:47:02 2017 +0200

----------------------------------------------------------------------
 build.gradle                       |  4 ++++
 freemarker-core/build.gradle       | 17 +++++++++--------
 freemarker-servlet/build.gradle    | 17 ++++++++++-------
 freemarker-test-utils/build.gradle | 14 ++++++++------
 4 files changed, 31 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/86a28b2f/build.gradle
----------------------------------------------------------------------
diff --git a/build.gradle b/build.gradle
index 33fe1bf..602af44 100644
--- a/build.gradle
+++ b/build.gradle
@@ -26,8 +26,12 @@ ext.versionForMf = "2.97.0"
 allprojects {
     group = "org.apache.freemarker"
     version = "${versionCanonical}"
+    ext.title = null; // Title shown in JavaDoc and other documentation
 }
 
+title = "Apache FreeMarker"
+description = "Apache FreeMarker template engine, root project"
+
 // Libraries that are referred from multiple places:
 ext.libraries = [
     findbugs: "com.google.code.findbugs:annotations:3.0.0"

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/86a28b2f/freemarker-core/build.gradle
----------------------------------------------------------------------
diff --git a/freemarker-core/build.gradle b/freemarker-core/build.gradle
index 39af628..9de09c4 100644
--- a/freemarker-core/build.gradle
+++ b/freemarker-core/build.gradle
@@ -21,7 +21,10 @@ plugins {
     id "ca.coglinc.javacc" version "2.4.0"
 }
 
-String moduleNiceName = "Apache FreeMarker Core"
+title = "Apache FreeMarker Core"
+description = """\
+FreeMarker template engine, core module. This module covers all basic functionality, and is all that's needed for \
+many applications."""
 
 dependencies {
     // Note that commond dependencies are added in the root project.
@@ -108,15 +111,15 @@ jar {
         instructionReplace 'Require-Capability', 'osgi.ee;filter:="(&(osgi.ee=JavaSE)(version>=1.7))"'
 
         attributes(
-            "Extension-name": moduleNiceName,
-            "Specification-Title": moduleNiceName,
-            "Implementation-Title": moduleNiceName
+            "Extension-name": "${project.group}:${project.name}",
+            "Specification-Title": project.title,
+            "Implementation-Title": project.title
         )
     }
 }
 
 javadoc {
-    title "${moduleNiceName} ${versionCanonical} API"
+    title "${project.title} ${versionCanonical} API"
 }
 
 // The identical parts of Maven "deployer" and "installer" configuration:
@@ -124,9 +127,7 @@ def mavenCommons = { callerDelegate ->
     delegate = callerDelegate
     
     pom.project {
-        description(
-                "FreeMarker template engine, core module. This module covers all basic functionality, "
-                + "and is all that's needed for many applications.")
+        description project.description
     }
 }
 

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/86a28b2f/freemarker-servlet/build.gradle
----------------------------------------------------------------------
diff --git a/freemarker-servlet/build.gradle b/freemarker-servlet/build.gradle
index c54896b..41a8302 100644
--- a/freemarker-servlet/build.gradle
+++ b/freemarker-servlet/build.gradle
@@ -1,4 +1,8 @@
-String moduleNiceName = "Apache FreeMarker Core Servlet"
+title = "Apache FreeMarker Servlet and JSP support"
+description = """\
+FreeMarker template engine, Servlet and JSP support. \
+This is an optional module, mostly useful in frameworks based on JSP Model-2 architecture, or when custom JSP tags \
+need to be called from templates."""
 
 dependencies {
     compile project(":freemarker-core")
@@ -42,15 +46,15 @@ jar {
         // TODO Gradle adds a "Require-Capability"... is it a problem? If not, do we need the above?
 
         attributes(
-                "Extension-name": moduleNiceName,
-                "Specification-Title": moduleNiceName,
-                "Implementation-Title": moduleNiceName
+                "Extension-name": "${project.group}:${project.name}",
+                "Specification-Title": project.title,
+                "Implementation-Title": project.title
         )
     }
 }
 
 javadoc {
-    title "${moduleNiceName} ${versionCanonical} API"
+    title "${project.title} ${versionCanonical} API"
 }
 
 // The identical parts of Maven "deployer" and "installer" configurations:
@@ -58,8 +62,7 @@ def mavenCommons = { callerDelegate ->
     delegate = callerDelegate
 
     pom.project {
-        description "FreeMarker template engine, Servlet and JSP support. " +
-                "This is an optional module, mostly useful in frameworks based on JSP Model-2 architecture, or when custom JSP tags need to be called from templates."
+        description project.description
     }
 }
 

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/86a28b2f/freemarker-test-utils/build.gradle
----------------------------------------------------------------------
diff --git a/freemarker-test-utils/build.gradle b/freemarker-test-utils/build.gradle
index 4f23339..03d0087 100644
--- a/freemarker-test-utils/build.gradle
+++ b/freemarker-test-utils/build.gradle
@@ -1,4 +1,6 @@
-String moduleNiceName = "Apache FreeMarker Test Utiltities"
+title = "Apache FreeMarker Test Utiltities"
+description = """\
+FreeMarker template engine, testing utilities for internal use; this is not a published module."""
 
 dependencies {
     compile project(":freemarker-core")
@@ -22,15 +24,15 @@ jar {
         // This is needed for "a.class.from.another.Bundle"?new() to work.
         instructionReplace 'DynamicImport-Package', '*'
         attributes(
-                "Extension-name": moduleNiceName,
-                "Specification-Title": moduleNiceName,
-                "Implementation-Title": moduleNiceName
+                "Extension-name": "${project.group}:${project.name}",
+                "Specification-Title": project.title,
+                "Implementation-Title": project.title
         )
     }
 }
 
 javadoc {
-    title "${moduleNiceName} ${versionCanonical} API"
+    title "${project.title} ${versionCanonical} API"
 }
 
 // The identical parts of Maven "deployer" and "installer" configurations:
@@ -38,7 +40,7 @@ def mavenCommons = { callerDelegate ->
     delegate = callerDelegate
 
     pom.project {
-        description "FreeMarker template engine, testing utilities for internal use; this is not a published module. "
+        description project.description
     }
 }