changeset 1362:0c693476e03c

More documentation fixes; our Bugzilla URL is used (as we do for HotSpot crashes) and the same licensing header is used for all docs. 2009-02-03 Andrew John Hughes <ahughes@redhat.com> * Makefile.am: Move doc headers patch above NIO2 patch, as this needs to alter the same file. * patches/icedtea-doc-headers.patch: Add IcedTea bugzilla URL and common licensing to all documentation.
author Andrew John Hughes <ahughes@redhat.com>
date Tue, 03 Feb 2009 16:20:10 +0000
parents c38d90386c71
children 6b1b34af152d
files ChangeLog Makefile.am patches/icedtea-doc-headers.patch
diffstat 3 files changed, 148 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Tue Feb 03 15:41:58 2009 +0000
+++ b/ChangeLog	Tue Feb 03 16:20:10 2009 +0000
@@ -1,3 +1,12 @@
+2009-02-03  Andrew John Hughes  <ahughes@redhat.com>
+
+	* Makefile.am:
+	Move doc headers patch above NIO2 patch,
+	as this needs to alter the same file.
+	* patches/icedtea-doc-headers.patch:
+	Add IcedTea bugzilla URL and common licensing
+	to all documentation.
+
 2009-02-03  Andrew John Hughes  <ahughes@redhat.com>
 
 	* Makefile.am:
--- a/Makefile.am	Tue Feb 03 15:41:58 2009 +0000
+++ b/Makefile.am	Tue Feb 03 16:20:10 2009 +0000
@@ -562,7 +562,8 @@
 	patches/icedtea-6728542-epoll.patch \
 	patches/icedtea-io_util-overflow.patch \
 	patches/icedtea-cc-interp-jvmti.patch \
-	patches/icedtea-pr261.patch
+	patches/icedtea-pr261.patch \
+	patches/icedtea-doc-headers.patch
 
 if WITH_ALT_HSBUILD
 ICEDTEA_PATCHES += \
@@ -615,8 +616,7 @@
 	$(DISTRIBUTION_PATCHES) \
 	patches/icedtea-demo-swingapplet.patch \
 	patches/icedtea-awt-window-size.patch \
-	patches/icedtea-java2d-dasher.patch \
-	patches/icedtea-doc-headers.patch
+	patches/icedtea-java2d-dasher.patch
 
 stamps/extract.stamp: stamps/download.stamp
 if OPENJDK_SRC_DIR_FOUND
--- a/patches/icedtea-doc-headers.patch	Tue Feb 03 15:41:58 2009 +0000
+++ b/patches/icedtea-doc-headers.patch	Tue Feb 03 16:20:10 2009 +0000
@@ -1,6 +1,6 @@
 diff -Nru openjdk.orig/jdk/make/docs/Makefile openjdk/jdk/make/docs/Makefile
 --- openjdk.orig/jdk/make/docs/Makefile	2009-02-03 13:34:38.000000000 +0000
-+++ openjdk/jdk/make/docs/Makefile	2009-02-03 13:37:17.000000000 +0000
++++ openjdk/jdk/make/docs/Makefile	2009-02-03 16:11:08.000000000 +0000
 @@ -99,36 +99,20 @@
  
  TAGS = $(IGNORED_TAGS:%=-tag %:X) $(TAG_JLS3)
@@ -31,7 +31,7 @@
  JAVADOCWINDOWTITLE  = 'Java Platform SE $(JDK_MINOR_VERSION)'
  JAVADOCHEADER = '<b>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(JDK_MINOR_VERSION)</b>'
 -JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="{@docroot}/../../webnotes/devdocs-vs-specs.html">Java SE Developer Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples. <p>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All rights reserved. Use is subject to <a href="{@docroot}/../legal/license.html">license terms</a>. Also see the <a href="http://java.sun.com/docs/redist.html">documentation redistribution policy</a>.</font>'
-+JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a> <p>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All rights reserved. Use is subject to the terms of the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a>.</font>'
++JAVADOCBOTTOM = '<font size="-1"><a href="http://icedtea.classpath.org/bugzilla/">Submit a bug or feature</a> <p>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All rights reserved. Use is subject to the terms of the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a>.</font>'
  JAVADOCOVERVIEW = $(SHARE_SRC)/classes/overview-core.html
  
  #
@@ -45,3 +45,137 @@
  # Variables used by domapidocs target
  #
  
+@@ -138,12 +122,11 @@
+                     -doctitle $(DOMAPI_JAVADOCTITLE)          \
+                     -windowtitle $(DOMAPI_JAVADOCWINDOWTITLE) \
+                     -header $(DOMAPI_JAVADOCHEADER)           \
+-                    -bottom $(DOMAPI_JAVADOCBOTTOM)           \
++                    -bottom $(JAVADOCBOTTOM)           \
+                     -group $(DOMAPI_GROUPNAME) $(DOMAPI_REGEXP)
+ DOMAPI_JAVADOCTITLE  = 'Common DOM API'
+ DOMAPI_JAVADOCWINDOWTITLE  = 'Common DOM API'
+ DOMAPI_JAVADOCHEADER = '<b>Common DOM API</b>'
+-DOMAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright $(THIS_YEAR) Sun Microsystems, Inc. 4150 Network Circle<br>Santa Clara, California, 95054, U.S.A.  All Rights Reserved.</font>'
+ DOMAPI_GROUPNAME = "Packages"
+ DOMAPI_REGEXP = "com.sun.java.browser.dom:org.w3c.dom*"
+ # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
+@@ -157,13 +140,12 @@
+                     -doctitle $(MIRROR_JAVADOCTITLE)            \
+                     -windowtitle $(MIRROR_JAVADOCWINDOWTITLE)   \
+                     -header $(MIRROR_JAVADOCHEADER)             \
+-                    -bottom $(MIRROR_JAVADOCBOTTOM)             \
++                    -bottom $(JAVADOCBOTTOM)             	\
+                     -group $(MIRROR_GROUPNAME) $(MIRROR_REGEXP) \
+                     -overview $(MIRROR_OVERVIEW)
+ MIRROR_JAVADOCTITLE = 'Mirror API'
+ MIRROR_JAVADOCWINDOWTITLE = 'Mirror API'
+ MIRROR_JAVADOCHEADER = '<b>Mirror API</b>'
+-MIRROR_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Report a bug or request a feature.</a><br>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.</font>'
+ MIRROR_GROUPNAME = "Packages"
+ MIRROR_OVERVIEW = $(IMPORTSRCDIR)/com/sun/mirror/overview.html
+ MIRROR_REGEXP = "com.sun.mirror.*"
+@@ -181,12 +163,11 @@
+                     -doctitle $(DOCLETAPI_JAVADOCTITLE)          \
+                     -windowtitle $(DOCLETAPI_JAVADOCWINDOWTITLE) \
+                     -header $(DOCLETAPI_JAVADOCHEADER)           \
+-                    -bottom $(DOCLETAPI_JAVADOCBOTTOM)           \
++                    -bottom $(JAVADOCBOTTOM)           		 \
+                     -group $(DOCLETAPI_GROUPNAME) $(DOCLETAPI_REGEXP)
+ DOCLETAPI_JAVADOCTITLE  = 'Doclet API'
+ DOCLETAPI_JAVADOCWINDOWTITLE  = 'Doclet API'
+ DOCLETAPI_JAVADOCHEADER = '<b>Doclet API</b>'
+-DOCLETAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-$(THIS_YEAR) Sun Microsystems, Inc. 4150 Network Circle<br>Santa Clara, California, 95054, U.S.A.  All Rights Reserved.</font>'
+ DOCLETAPI_GROUPNAME = "Packages"
+ DOCLETAPI_REGEXP = "com.sun.javadoc"
+ DOCLETAPI_LINKOPT = -linkoffline ../../../../api $(DOCSDIR)/api/
+@@ -200,8 +181,7 @@
+ 		    -encoding ascii			        \
+                     -nonavbar                                   \
+                     -noindex                                    \
+-                    -bottom $(TAGLETAPI_JAVADOCBOTTOM)
+-TAGLETAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Submit a bug or feature</a><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-$(THIS_YEAR) Sun Microsystems, Inc. 4150 Network Circle<br>Santa Clara, California, 95054, U.S.A.  All Rights Reserved.</font>'
++                    -bottom $(JAVADOCBOTTOM)
+ # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
+ 
+ #
+@@ -218,6 +198,7 @@
+                    -windowtitle $(JDI_WINDOWTITLE)               \
+                    -doctitle $(JDI_DOCTITLE)                     \
+                    -header $(JDI_HEADER)                         \
++                   -bottom $(JAVADOCBOTTOM)             	\
+                    -linkoffline ../../../../api $(DOCSDIR)/api/     \
+                    -overview $(JPDA_SOURCEPATH)/jdi-overview.html
+ JDI_WINDOWTITLE = "Java Debug Interface"
+@@ -242,6 +223,7 @@
+                    -windowtitle $(JAAS_WINDOWTITLE)              \
+                    -doctitle $(JAAS_DOCTITLE)                    \
+                    -header $(JAAS_JAVADOCHEADER)                 \
++                   -bottom $(JAVADOCBOTTOM)             	\
+                    -linkoffline ../../../../../api $(DOCSDIR)/api/	 \
+                    -overview $(TOPDIR)/src/share/classes/com/sun/security/auth/jaas-overview.html
+ JAAS_WINDOWTITLE = "Java Authentication and Authorization Service "
+@@ -264,6 +246,7 @@
+                    -windowtitle $(JGSS_WINDOWTITLE)             \
+                    -doctitle $(JGSS_DOCTITLE)                   \
+                    -header $(JGSS_JAVADOCHEADER)                \
++                   -bottom $(JAVADOCBOTTOM)             	\
+                    -linkoffline ../../../../../api $(DOCSDIR)/api/ \
+                    -overview $(JGSS_SOURCEPATH)/com/sun/security/jgss/jgss-overview.html
+ 
+@@ -287,6 +270,7 @@
+                    -windowtitle $(SMARTCARDIO_WINDOWTITLE)             \
+                    -doctitle $(SMARTCARDIO_DOCTITLE)                   \
+                    -header $(SMARTCARDIO_JAVADOCHEADER)                \
++                   -bottom $(JAVADOCBOTTOM)             	\
+                    -linkoffline ../../../../../api $(DOCSDIR)/api/
+ 
+ SMARTCARDIO_WINDOWTITLE = "Java Smart Card I/O"
+@@ -309,6 +293,7 @@
+                    -windowtitle $(HTTPSERVER_WINDOWTITLE)             \
+                    -doctitle $(HTTPSERVER_DOCTITLE)                   \
+                    -header $(HTTPSERVER_JAVADOCHEADER)                \
++                   -bottom $(JAVADOCBOTTOM)             	\
+                    -linkoffline ../../../../../api $(DOCSDIR)/api/
+ 
+ HTTPSERVER_WINDOWTITLE = "Java HTTP Server"
+@@ -344,6 +329,7 @@
+                      -windowtitle $(MGMT_WINDOWTITLE)              \
+                      -doctitle $(MGMT_DOCTITLE)                    \
+                      -header $(MGMT_HEADER)                        \
++                     -bottom $(JAVADOCBOTTOM)             	\
+ 		     -linkoffline ../../../../api $(DOCSDIR)/api/  \
+                      -overview $(MGMT_SOURCEPATH)/com/sun/management/mgmt-overview.html
+ MGMT_WINDOWTITLE = "Monitoring and Management Interface for the Java Platform"
+@@ -365,6 +351,7 @@
+                    -windowtitle $(ATTACH_WINDOWTITLE)               	\
+                    -doctitle $(ATTACH_DOCTITLE)                     	\
+                    -header $(ATTACH_HEADER)                         	\
++                   -bottom $(JAVADOCBOTTOM)             	\
+ 		   -linkoffline ../../../../api $(DOCSDIR)/api/
+ ATTACH_WINDOWTITLE = "Attach API"
+ ATTACH_DOCTITLE    = "Attach API"
+@@ -385,6 +372,7 @@
+                    -windowtitle $(JCONSOLE_WINDOWTITLE)               	\
+                    -doctitle $(JCONSOLE_DOCTITLE)                     	\
+                    -header $(JCONSOLE_HEADER)                         	\
++                   -bottom $(JAVADOCBOTTOM)             	\
+ 		   -linkoffline ../../../../api $(DOCSDIR)/api/
+ JCONSOLE_WINDOWTITLE = "JConsole API"
+ JCONSOLE_DOCTITLE    = "JConsole API"
+@@ -400,7 +388,7 @@
+                     -doctitle $(TREEAPI_JAVADOCTITLE)            \
+                     -windowtitle $(TREEAPI_JAVADOCWINDOWTITLE)   \
+                     -header $(TREEAPI_JAVADOCHEADER)             \
+-                    -bottom $(TREEAPI_JAVADOCBOTTOM)             \
++                    -bottom $(JAVADOCBOTTOM)                     \
+                     -group $(TREEAPI_GROUPNAME) $(TREEAPI_REGEXP) 
+ #
+ #	            -overview $(TREEAPI_OVERVIEW)
+@@ -408,7 +396,6 @@
+ TREEAPI_JAVADOCTITLE = 'Compiler Tree API'
+ TREEAPI_JAVADOCWINDOWTITLE = 'Compiler Tree API'
+ TREEAPI_JAVADOCHEADER = '<b>Compiler Tree API</b>'
+-TREEAPI_JAVADOCBOTTOM = '<font size="-1"><a href="http://bugs.sun.com/services/bugreport/index.jsp">Report a bug or request a feature.</a><br>Copyright $(THIS_YEAR) Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.</font>'
+ TREEAPI_GROUPNAME = "Packages"
+ TREEAPI_OVERVIEW = $(SHARE_SRC)/classes/com/sun/source/overview.html
+ TREEAPI_REGEXP = "com.sun.source.*"