Author: pierre
Date: Mon Dec 15 07:13:32 2014
New Revision: 15207
Log:
Fix errors in javadoc for Junit and FOP+reformat
Modified:
trunk/BOOK/general.ent
trunk/BOOK/general/prog/junit.xml
trunk/BOOK/introduction/welcome/changelog.xml
trunk/BOOK/pst/ps/fop.xml
Modified: trunk/BOOK/general.ent
==============================================================================
--- trunk/BOOK/general.ent Mon Dec 15 02:01:40 2014 (r15206)
+++ trunk/BOOK/general.ent Mon Dec 15 07:13:32 2014 (r15207)
@@ -1,12 +1,12 @@
<!-- $LastChangedBy$ $Date$ -->
-<!ENTITY day "14"> <!-- Always 2 digits -->
+<!ENTITY day "15"> <!-- Always 2 digits -->
<!ENTITY month "12"> <!-- Always 2 digits -->
<!ENTITY year "2014">
<!ENTITY copyrightdate "2001-&year;">
<!ENTITY copyholder "The BLFS Development Team">
<!ENTITY version "&year;-&month;-&day;">
-<!ENTITY releasedate "December 14th, &year;">
+<!ENTITY releasedate "December 15th, &year;">
<!ENTITY pubdate "&year;-&month;-&day;"> <!-- metadata req. by TLDP -->
<!ENTITY blfs-version "svn"> <!-- svn|[release #] -->
<!ENTITY lfs-version "development"> <!-- x.y|development] -->
Modified: trunk/BOOK/general/prog/junit.xml
==============================================================================
--- trunk/BOOK/general/prog/junit.xml Mon Dec 15 02:01:40 2014 (r15206)
+++ trunk/BOOK/general/prog/junit.xml Mon Dec 15 07:13:32 2014 (r15207)
@@ -29,11 +29,13 @@
<sect2 role="package">
<title>Introduction to JUnit</title>
- <para>The <application>JUnit</application> package contains a simple, open
- source framework to write and run repeatable tests. It is an instance of
- the xUnit architecture for unit testing frameworks. JUnit features include
- assertions for testing expected results, test fixtures for sharing common
- test data, and test runners for running tests.</para>
+ <para>
+ The <application>JUnit</application> package contains a simple, open
+ source framework to write and run repeatable tests. It is an instance of
+ the xUnit architecture for unit testing frameworks. JUnit features
include
+ assertions for testing expected results, test fixtures for sharing common
+ test data, and test runners for running tests.
+ </para>
&lfs76_checked;
@@ -86,33 +88,34 @@
<sect2 role="installation">
<title>Installation of JUnit</title>
-<!-- <para>To do a full build of JUnit from source, <xref
linkend='apache-ant'/>
- is required. However JUnit is useful in building Apache Ant. Copy the
- JUnit-&junit-version; jar file to get started. Then come back to build
- from source, if desired.</para>
-
- <para>Install the <application>JUnit</application> jar file by running the
following
- commands as the <systemitem class="username">root</systemitem> user:</para>
-
-<screen role="root"><userinput>install -v -m755 -d /usr/share/java &&
-cp -v junit-&junit-version;.jar /usr/share/java</userinput></screen>
-
- <para>At this point, make sure Apache-Ant is installed and then continue
- with the source build and installation. From the directory created when
- extracting the JUnit sources, place the required hamcrest jar files where
- needed and build the package:</para>
--->
- <para>Place the required hamcrest jar files where needed and build the
- package:</para>
+ <para>
+ The <command>javadoc</command> command coming with OpenJDK 8 has become
+ much stricter than before regarding the conformance of the Javadoc
+ comments in source code to HTML. The <application>Junit</application>
+ documentation does not meet those standard, so the conformance checks
+ have to be disabled. This can be done with the following command:
+ </para>
+
+<screen><userinput>sed -i '\@/docs/@a<arg value="Xdoclint:none"/>'
build.xml</userinput></screen>
+
+ <para>
+ Now place the required hamcrest jar files where needed and build the
+ package:
+ </para>
<screen><userinput>tar -xf ../hamcrest-&hamcrest-version;.tgz
&&
cp -v
hamcrest-&hamcrest-version;/hamcrest-core-&hamcrest-version;{,-sources}.jar
lib/ &&
-ant dist</userinput></screen>
+ant populate-dist</userinput></screen>
- <para>Testing is automatically done as a part of the build step.</para>
+ <para>
+ Test the package by issuing <command>ant dist</command>. One test fails
+ for unknown reason.
+ </para>
- <para>Install the files in the final location as the
- <systemitem class="username">root</systemitem> user:</para>
+ <para>
+ Install the files in the final location as the
+ <systemitem class="username">root</systemitem> user:
+ </para>
<screen role="root"><userinput>install -v -m755 -d
/usr/share/{doc,java}/junit-&junit-version; &&
chown -R root:root . &&
@@ -121,7 +124,9 @@
cp -v junit*/junit*.jar /usr/share/java/junit-&junit-version;
&&
cp -v hamcrest-&hamcrest-version;/hamcrest-core*.jar
/usr/share/java/junit-&junit-version;</userinput></screen>
- <para>Finally, update the <envar>CLASSPATH</envar> variable:</para>
+ <para>
+ Finally, update the <envar>CLASSPATH</envar> variable:
+ </para>
<screen><userinput>export
CLASSPATH=$CLASSPATH:/usr/share/java/junit-&junit-version;</userinput></screen>
</sect2>
@@ -131,7 +136,7 @@
<segmentedlist>
<segtitle>Installed Programs</segtitle>
- <segtitle>Installed Libraies</segtitle>
+ <segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
Modified: trunk/BOOK/introduction/welcome/changelog.xml
==============================================================================
--- trunk/BOOK/introduction/welcome/changelog.xml Mon Dec 15 02:01:40
2014 (r15206)
+++ trunk/BOOK/introduction/welcome/changelog.xml Mon Dec 15 07:13:32
2014 (r15207)
@@ -45,6 +45,17 @@
-->
<listitem>
+ <para>December 15th, 2014</para>
+ <itemizedlist>
+ <listitem>
+ <para>[pierre] - Fix javadoc errors in Junit and FOP, coming from
+ OpenJDK 8 stricter checks. Fixes
+ <ulink url="&blfs-ticket-root;5930">#5930</ulink>.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
<para>December 13th, 2014</para>
<itemizedlist>
<listitem>
Modified: trunk/BOOK/pst/ps/fop.xml
==============================================================================
--- trunk/BOOK/pst/ps/fop.xml Mon Dec 15 02:01:40 2014 (r15206)
+++ trunk/BOOK/pst/ps/fop.xml Mon Dec 15 07:13:32 2014 (r15207)
@@ -43,13 +43,15 @@
<sect2 role="package">
<title>Introduction to fop</title>
- <para>The <application>FOP</application> (Formatting Objects Processor)
- package contains a print formatter driven by XSL formatting objects
- (XSL-FO). It is a <application>Java</application> application that reads
- a formatting object tree and renders the resulting pages to a specified
- output. Output formats currently supported include PDF, PCL, PostScript,
- SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The
- primary output target is PDF.</para>
+ <para>
+ The <application>FOP</application> (Formatting Objects Processor)
+ package contains a print formatter driven by XSL formatting objects
+ (XSL-FO). It is a <application>Java</application> application that reads
+ a formatting object tree and renders the resulting pages to a specified
+ output. Output formats currently supported include PDF, PCL, PostScript,
+ SVG, XML (area tree representation), print, AWT, MIF and ASCII text. The
+ primary output target is PDF.
+ </para>
&lfs76_checked;
@@ -136,20 +138,24 @@
<sect2 role="installation">
<title>Installation of fop</title>
- <para>Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning
- the build. To build the <application>JIMI SDK</application> and/or
- <application>XMLUnit</application> extension classes, ensure the
- corresponding <filename class='extension'>.jar</filename> files can be
- found via the <envar>CLASSPATH</envar> environment variable.</para>
+ <para>
+ Ensure <envar>$JAVA_HOME</envar> is set correctly before beginning
+ the build. To build the <application>JIMI SDK</application> and/or
+ <application>XMLUnit</application> extension classes, ensure the
+ corresponding <filename class='extension'>.jar</filename> files can be
+ found via the <envar>CLASSPATH</envar> environment variable.
+ </para>
<!--
<sect3>
<title>Installing OFFO Hyphenation Patterns</title>
- <para>First, unpack the <application>fop</application> source tarball and
- the hyphenation zipfile from the same directory, then change directories
- into the root of the <application>fop</application> source tree. Copy the
- XML hyphenation patterns into the <application>fop</application> source
- tree by running the following commands:</para>
+ <para>
+ First, unpack the <application>fop</application> source tarball and
+ the hyphenation zipfile from the same directory, then change
directories
+ into the root of the <application>fop</application> source tree. Copy
+ the XML hyphenation patterns into the <application>fop</application>
+ source tree by running the following commands:
+ </para>
<screen><userinput>cp ../offo-hyphenation/hyph/* hyph &&
rm -rf ../offo-hyphenation</userinput></screen>
@@ -159,8 +165,10 @@
<sect3>
<title>Installing Java Advanced Imaging (JAI) API components</title>
- <para>Next install the JAI API components. As the <systemitem
- class="username">root</systemitem> user:</para>
+ <para>
+ Install the JAI API components. As the <systemitem
+ class="username">root</systemitem> user:
+ </para>
<screen role="root"><userinput>case `uname -m` in
i?86)
@@ -180,27 +188,44 @@
<sect3>
<title>Installing fop Components</title>
- <para>Compile <application>fop</application> by running the
- following commands:</para>
+ <para>
+ The <command>javadoc</command> command coming with OpenJDK 8 has
+ become much stricter than before regarding the conformance of the
+ Javadoc comments in source code to HTML. The FOP documentation does
+ not meet those standard, so the conformance checks have to be
+ disabled. This can be done with the following command:
+ </para>
+
+<screen><userinput>sed -i '\@</javad@i<arg value="-Xdoclint:none"/>'
build.xml</userinput></screen>
+
+ <para>
+ Then, compile <application>fop</application> by running the
+ following commands:
+ </para>
<screen><userinput>ant compile &&
ant jar-main &&
ant javadocs &&
mv build/javadocs .</userinput></screen>
- <para>If <application>Forrest</application> is installed,
- build the full set of documentation:</para>
+ <para>
+ If <application>Forrest</application> is installed,
+ build the full set of documentation:
+ </para>
<screen><userinput>ant docs</userinput></screen>
- <para>To test the application, run <command>ant junit-all</command>. The
- hyphenation tests will fail. To see a list of other test targets, use
- <command>ant -p</command>. You must run the tests from an X-window using
- a GL-aware <application>Xorg</application> server or some of the
- <application>JUnit</application> tests will hang.</para>
+ <para>
+ To test the application, run <command>ant junit-all</command>. The
+ hyphenation tests will fail. To see a list of other test targets, use
+ <command>ant -p</command>. You must run the tests from an X-window
using
+ a GL-aware <application>Xorg</application> server or some of the
+ <application>JUnit</application> tests will hang.
+ </para>
- <para>Now, as the <systemitem class="username">root</systemitem>
- user:</para>
+ <para>
+ Now, as the <systemitem class="username">root</systemitem> user:
+ </para>
<screen role="root"><userinput>install -v -d -m755
/opt/fop-&fop-version; &&
cp -v KEYS LICENSE NOTICE README /opt/fop-&fop-version;
&&
@@ -215,12 +240,17 @@
<sect2 role="commands">
<title>Command Explanations</title>
- <para><command>ant <option>target</option></command>: This reads the file
- <filename>build.xml</filename> and builds the target files.</para>
+ <para>
+ <command>ant <option>target</option></command>: This reads the file
+ <filename>build.xml</filename> and builds the target files.
+ </para>
- <para><command>ln -v -sf fop-&fop-version; /opt/fop</command>: This is
- optional and creates a convenience symlink so that <envar>$FOP_HOME</envar>
- doesn't have to be changed each time there's a package version
change.</para>
+ <para>
+ <command>ln -v -sf fop-&fop-version; /opt/fop</command>: This is
+ optional and creates a convenience symlink so that
+ <envar>$FOP_HOME</envar> doesn't have to be changed each time there's a
+ package version change.
+ </para>
</sect2>
@@ -230,7 +260,9 @@
<sect3 id="fop-config">
<title>Config Files</title>
- <para><filename>~/.foprc</filename></para>
+ <para>
+ <filename>~/.foprc</filename>
+ </para>
<indexterm zone="fop fop-config">
<primary sortas="e-AA.foprc">~/.foprc</primary>
@@ -241,57 +273,74 @@
<sect3>
<title>Configuration Information</title>
- <para>Using <application>fop</application> to process some large FO's
- (including the FO derived from the BLFS XML sources), can lead to memory
- errors. Unless you add a parameter to the <command>java</command> command
- used in the <command>fop</command> script you may receive messages
- similar to the one shown below:</para>
-
- <para><computeroutput>Exception in thread "main"
java.lang.OutOfMemoryError:
- Java heap space</computeroutput></para>
-
- <para>To avoid errors like this, you need to pass an extra parameter to
- the <command>java</command> command used in the <command>fop</command>
- script. This can be accomplished by creating a
- <filename>~/.foprc</filename> (which is sourced by the
- <command>fop</command> script) and adding the parameter to the
- <envar>FOP_OPTS</envar> environment variable.</para>
-
- <para>The <command>fop</command> script looks for a
- <envar>FOP_HOME</envar> environment variable to locate the
- <application>fop</application> class libraries. You can create this
- variable using the <filename>~/.foprc</filename> file as well. Create
- a <filename>~/.foprc</filename> file using the following commands:</para>
+ <para>
+ Using <application>fop</application> to process some large FO's
+ (including the FO derived from the BLFS XML sources), can lead to
+ memory errors. Unless you add a parameter to the
+ <command>java</command> command used in the <command>fop</command>
+ script you may receive messages similar to the one shown below:
+ </para>
+
+ <para>
+ <computeroutput>
+ Exception in thread "main" java.lang.OutOfMemoryError: Java heap
+ space
+ </computeroutput>
+ </para>
+
+ <para>
+ To avoid errors like this, you need to pass an extra parameter to
+ the <command>java</command> command used in the <command>fop</command>
+ script. This can be accomplished by creating a
+ <filename>~/.foprc</filename> (which is sourced by the
+ <command>fop</command> script) and adding the parameter to the
+ <envar>FOP_OPTS</envar> environment variable.
+ </para>
+
+ <para>
+ The <command>fop</command> script looks for a
+ <envar>FOP_HOME</envar> environment variable to locate the
+ <application>fop</application> class libraries. You can create this
+ variable using the <filename>~/.foprc</filename> file as well. Create
+ a <filename>~/.foprc</filename> file using the following commands:
+ </para>
<screen><userinput>cat > ~/.foprc << "EOF"
<literal>FOP_OPTS="-Xmx<replaceable><RAM_Installed></replaceable>m"
FOP_HOME="/opt/fop"</literal>
EOF</userinput></screen>
- <para>Replace <replaceable><RAM_Installed></replaceable> with a
- number representing the amount of RAM installed in your computer (in
- megabytes). An example would be
- <userinput>FOP_OPTS="-Xmx768m"</userinput>.
- <!-- the URL is broken
- For more information about
- memory issues running <application>fop</application>, see
- <ulink url="http://xml.apache.org/fop/running.html#memory"/>.
- -->
+ <para>
+ Replace <replaceable><RAM_Installed></replaceable> with a
+ number representing the amount of RAM installed in your computer (in
+ megabytes). An example would be
+ <userinput>FOP_OPTS="-Xmx768m"</userinput>.
+ <!-- the URL is broken
+ For more information about
+ memory issues running <application>fop</application>, see
+ <ulink url="http://xml.apache.org/fop/running.html#memory"/>.
+ -->
</para>
- <para>To include the <command>fop</command> script in your path,
- update your personal or system-wide profile with the following:</para>
+ <para>
+ To include the <command>fop</command> script in your path,
+ update your personal or system-wide profile with the following:
+ </para>
<screen><literal>PATH=$PATH:/opt/fop</literal></screen>
- <note><para>Running <command>fop</command> can be somewhat verbose.
- The default logging level can be changed from INFO to any of
- FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF.
- To do this, edit
- <filename>$JAVA_HOME/jre/lib/logging.properties</filename> and change
- the entries for <option>.leval</option> and
- <option>java.util.logging.ConsoleHandler.level</option> to
- the desired value.</para></note>
+ <note>
+ <para>
+ Running <command>fop</command> can be somewhat verbose.
+ The default logging level can be changed from INFO to any of
+ FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ALL, or OFF.
+ To do this, edit
+ <filename>$JAVA_HOME/jre/lib/logging.properties</filename> and change
+ the entries for <option>.leval</option> and
+ <option>java.util.logging.ConsoleHandler.level</option> to
+ the desired value.
+ </para>
+ </note>
</sect3>
--
http://lists.linuxfromscratch.org/listinfo/blfs-book
FAQ: http://www.linuxfromscratch.org/blfs/faq.html
Unsubscribe: See the above information page
