Review of OpenJDk 8u20 Java tools nroff documentation
Mandy Chung
mandy.chung at oracle.com
Thu May 29 00:46:56 UTC 2014
Raymond,
javap and jdeps man page looks fine to me.
thanks
Mandy
On 5/27/2014 6:13 AM, raymond gallardo wrote:
>
> Hello Reviewers,
>
> As part of the OpenJDK review processes, and the next Java SE 8u20
> release, the OpenJDK 8 nroff files for Java tools are up for review,
> which is attached as a zip file.
>
> Please provide your feedback by *Thursday, May 29, 2014*.
>
> The following sections describe what kinds of review comments we're
> looking for and what has changed for Java SE 8u20. Please contact us
> if you have any questions.
>
> * Scope of Review
> <imap://raymond%2Egallardo%40oracle%2Ecom@stbeehive.oracle.com:993/fetch%3EUID%3E/Sent%3E4900?part=1.1.2.2&filename=External_review_november_11.html>
> * Provide Feedback
> <imap://raymond%2Egallardo%40oracle%2Ecom@stbeehive.oracle.com:993/fetch%3EUID%3E/Sent%3E4900?part=1.1.2.3&filename=External_review_november_11.html>
> * How to View a Man Page
> <imap://raymond%2Egallardo%40oracle%2Ecom@stbeehive.oracle.com:993/fetch%3EUID%3E/Sent%3E4900?part=1.1.2.4&filename=External_review_november_11.html>
> * What's Changed
> <imap://raymond%2Egallardo%40oracle%2Ecom@stbeehive.oracle.com:993/fetch%3EUID%3E/Sent%3E4900?part=1.1.2.5&filename=External_review_november_11.html>
> * Summary of Changes
> <imap://raymond%2Egallardo%40oracle%2Ecom@stbeehive.oracle.com:993/fetch%3EUID%3E/Sent%3E4900?part=1.1.2.6&filename=External_review_november_11.html>
>
>
> Scope of Review
>
> Please provide a sanity check of content as opposed to reviewing the
> nroff markup itself.
>
> A line-by-line comparison between the html and nroff versions is not
> needed.
>
>
> Provide Feedback
>
> Please indicate your approval and provide feedback by e-mail by
> *Thursday, May 29, 2014***.
>
> All feedback will be triaged. Severe technical inaccuracies and other
> small bugs will be fixed. Due to Java SE 8u20 release plan deadlines,
> bugs will be filed for large scale changes and will most likely be
> handled in a future update release.
>
>
> How To View A Man Page
>
> 1.
>
> Download the |openjdk_nroff_may_2014.zip| file to a directory of
> your choice. (The exact zip file name will vary depending upon the
> exact man page bundle and creation date.)
>
> 2.
>
> Open a terminal window. Change to the directory that contains the
> zip file.
>
> 3.
>
> Extract the contents of the zip file as follows:
>
> $ unzip openjdk_nroff_may_2014.zip
>
> This creates a sub-directory named openjdk_nroff_may_2014 in the
> current directory.
>
> 4.
>
> Change directory to |openjdk_nroff_may_2014| as follows:
>
> $ cd openjdk_nroff_may_2014
> 5.
>
> View a man page with a command of the following form:
>
> $ man -M man <page name>
>
> For example, to view the javap man page, run the following command:
>
> $ man -M man javap
>
>
> Notes
>
> *
>
> (Linux and Mac only.) The -t option to the man command will
> generate typeset output in PostScript format and send it to stdout:
>
> $ man -M man -t javap > javap.ps
>
> PostScript can be displayed using Preview (on Mac) and by the
> Gnome Document Viewer (Linux/Gnome). (On Solaris, the man -t
> option will send the output to a printer, which might not be what
> you want.)
>
> *
>
> If bullets render as a funny character, set the remote character
> set to UTF-8. For example, if you are using PuTTY, an SSH and
> telnet client, you can specify the remote character set by
> selecting from the context menu *Change Settings... > Window >
> Translation > Remote character set > UTF-8*.
>
>
> What's Changed
>
> * Technical content changes related to JDK 8 features have been
> made. These changes have already been reviewed by the engineer
> responsible for each feature.
> * HTML documentation for Java tools has also been generated, which
> has the same content as the nroff files up for review, and which
> will be available on download.java.net.
>
>
> Summary of Changes
>
> The following lists significant changes made to the Java tool nroff
> pages for this release as well as the engineer who reviewed the content.
>
> javac
> JDK-8042840 (opened by Omair Majid): Duplicated code in javac man page
> JDK-8038427 (Erik Costlow): JDK 8's javac does not list -source 8 ...
> also made changes to the -target option
>
> javafxpackager
> JDK-8042342 Renamed to javapackager (Danno Ferrin)
> JDK-8033610, Update info on packager for 8u20 (and other deployment
> information)
>
> javapackager
> New page (as a result of javafxpackager being renamed)
>
> java
> JDK-8033606: Experimental options related to Restricted Transactional
> Memory, (Vladimir Kozlov)
> JDK-8033604: String deduplication, (Per Lidén)
> Additional information for UseAES hardware supportability.
> JDK-8033103 (David Holmes), JDK-8042149 (Vladimir Kozlov): Various
> fixes. emoved the option UseBoundThreads, Better categorized options,
> in particular, HotSpot Server VM, Advanced JIT Compiler Options, and
> Advanced Runtime Options.
> JDK-8039398 (opened by Staffan Friberg; verified by Filipp Zhinkin)
> Spelling errors in GC print flags
> JDK-8032663 Retire some rarely-used GC combinations: Moved all
> CMSIncremental options to the Deprecated section
> Changes to Java Man pages for AES flags.
> Additional information for AESIntrinsics
> Additional information for bug JDK-8034904
>
> javap
> Added a link to jdeps (Mandy Chung)
>
> jmc
> JDK-8037401: Minor changes
>
> Thank you,
>
> The Java SE 8 Documentation Team
More information about the jdk8-dev
mailing list