Request for review: Bug 7067811

Nils Loodin nils.loodin at oracle.com
Wed Aug 24 06:04:43 PDT 2011


webrev here: http://cr.openjdk.java.net/~nloodin/7067811/webrev.03/

Bug states that we need a block of comments in each demo source file as 
well as top level read-me:s in the demo and samples dir stating that the 
code is unfit for production. From description:

-------------
The documentation should include the following disclaimer:

The source code provided with samples and demos for the JDK is meant to 
illustrate the usage of a given feature or technique and has been 
deliberately simplified. Additional steps required for a 
production-quality application, such as security checks, input 
validation, and proper error handling, might not be present in the 
sample code.

Usage of sample code in production environments is strongly discouraged.


On the actual source code a variation of the message should be included 
as a comment in the header:

This source code is provided to illustrate the usage of a given feature 
or technique and has been deliberately simplified. Additional steps 
required for a production-quality application, such as security checks, 
input validation, and proper error handling, might not be present in 
this sample code.

Finally on the documentation of applications, such as the lightweight 
HTTP server, that are shipped for testing/debugging, the following 
disclaimer should be added:

Applications such as the lightweight HTTP server are shipped with the 
JDK to help developers deploy and test their code easily.   They have 
not been developed in accordance to software development standards for 
production-quality applications. Usage of such test and/or support 
applications in production environments is strongly discouraged.
--------------

Mostly comment changes, but also changes in samples and demos makefiles 
to copy the README.


Regards
Nisse





More information about the jdk7u-dev mailing list