You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zookeeper.apache.org by ph...@apache.org on 2008/10/15 18:15:58 UTC
svn commit: r704948 - in /hadoop/zookeeper/trunk: ./ docs/
src/docs/src/documentation/content/xdocs/
Author: phunt
Date: Wed Oct 15 09:15:54 2008
New Revision: 704948
URL: http://svn.apache.org/viewvc?rev=704948&view=rev
Log:
ZOOKEEPER-186. add new releasenotes.xml to forrest documentation
Added:
hadoop/zookeeper/trunk/docs/releasenotes.html (with props)
hadoop/zookeeper/trunk/docs/releasenotes.pdf (with props)
hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/releasenotes.xml (with props)
Modified:
hadoop/zookeeper/trunk/CHANGES.txt
hadoop/zookeeper/trunk/docs/index.html
hadoop/zookeeper/trunk/docs/index.pdf
hadoop/zookeeper/trunk/docs/javaExample.html
hadoop/zookeeper/trunk/docs/linkmap.html
hadoop/zookeeper/trunk/docs/linkmap.pdf
hadoop/zookeeper/trunk/docs/recipes.html
hadoop/zookeeper/trunk/docs/zookeeperAdmin.html
hadoop/zookeeper/trunk/docs/zookeeperInternals.html
hadoop/zookeeper/trunk/docs/zookeeperOtherInfo.html
hadoop/zookeeper/trunk/docs/zookeeperOver.html
hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html
hadoop/zookeeper/trunk/docs/zookeeperStarted.html
hadoop/zookeeper/trunk/docs/zookeeperTutorial.html
hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml
hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml
Modified: hadoop/zookeeper/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/CHANGES.txt?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/CHANGES.txt (original)
+++ hadoop/zookeeper/trunk/CHANGES.txt Wed Oct 15 09:15:54 2008
@@ -35,6 +35,9 @@
BUGFIXES:
+ ZOOKEEPER-186. add new "releasenotes.xml" to forrest documentation
+ (phunt)
+
ZOOKEEPER-190. Reorg links to docs and navs to docs into related sections
(robbie via phunt)
Modified: hadoop/zookeeper/trunk/docs/index.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/index.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/index.html (original)
+++ hadoop/zookeeper/trunk/docs/index.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
@@ -210,6 +213,9 @@
<li>
<a href="zookeeperStarted.html">Getting Started</a> - a tutorial-style guide for developers to install, run, and program to ZooKeeper</li>
+<li>
+<a href="releasenotes.html">Release Notes</a> - new developer and user facing features, improvements, and incompatibilities</li>
+
</ul>
</li>
Modified: hadoop/zookeeper/trunk/docs/index.pdf
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/index.pdf?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
Binary files - no diff available.
Modified: hadoop/zookeeper/trunk/docs/javaExample.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/javaExample.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/javaExample.html (original)
+++ hadoop/zookeeper/trunk/docs/javaExample.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.2', 'skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Developer</div>
<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
Modified: hadoop/zookeeper/trunk/docs/linkmap.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/linkmap.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/linkmap.html (original)
+++ hadoop/zookeeper/trunk/docs/linkmap.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
@@ -212,6 +215,12 @@
<a href="zookeeperStarted.html">Getting Started</a> ___________________ <em>started</em>
</li>
</ul>
+
+<ul>
+<li>
+<a href="releasenotes.html">Release Notes</a> ___________________ <em>relnotes</em>
+</li>
+</ul>
</ul>
</ul>
Modified: hadoop/zookeeper/trunk/docs/linkmap.pdf
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/linkmap.pdf?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
Binary files - no diff available.
Modified: hadoop/zookeeper/trunk/docs/recipes.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/recipes.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/recipes.html (original)
+++ hadoop/zookeeper/trunk/docs/recipes.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.2', 'skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Developer</div>
<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
Added: hadoop/zookeeper/trunk/docs/releasenotes.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/releasenotes.html?rev=704948&view=auto
==============================================================================
--- hadoop/zookeeper/trunk/docs/releasenotes.html (added)
+++ hadoop/zookeeper/trunk/docs/releasenotes.html Wed Oct 15 09:15:54 2008
@@ -0,0 +1,409 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>ZooKeeper 3.0.0 Release Notes</title>
+<link type="text/css" href="skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
+<link type="text/css" href="skin/profile.css" rel="stylesheet">
+<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="images/favicon.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">Apache</a> > <a href="http://hadoop.apache.org/">Hadoop</a> > <a href="http://hadoop.apache.org/zookeeper/">ZooKeeper</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogo">
+<a href="http://hadoop.apache.org/zookeeper/"><img class="logoImage" alt="ZooKeeper" src="images/zookeeper_small.gif" title="The Hadoop database"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<form action="http://www.google.com/search" method="get" class="roundtopsmall">
+<input value="hadoop.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="http://hadoop.apache.org/zookeeper/">Project</a>
+</li>
+<li>
+<a class="unselected" href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
+</li>
+<li class="current">
+<a class="selected" href="index.html">ZooKeeper Documentation</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Overview</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="index.html">Welcome</a>
+</div>
+<div class="menuitem">
+<a href="zookeeperOver.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="zookeeperStarted.html">Getting Started</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Release Notes</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="api/index.html">API Docs</a>
+</div>
+<div class="menuitem">
+<a href="zookeeperProgrammers.html">Programmer's Guide</a>
+</div>
+<div class="menuitem">
+<a href="javaExample.html">Java Example</a>
+</div>
+<div class="menuitem">
+<a href="zookeeperTutorial.html">Barrier and Queue Tutorial</a>
+</div>
+<div class="menuitem">
+<a href="recipes.html">Recipes</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Admin & Ops</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="zookeeperAdmin.html">Administrator's Guide</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title" class="menutitle">Contributor</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="zookeeperInternals.html">ZooKeeper Internals</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Informal Documentation</div>
+<div id="menu_1.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
+</div>
+<div class="menuitem">
+<a href="http://wiki.apache.org/hadoop/ZooKeeper/FAQ">FAQ</a>
+</div>
+<div class="menuitem">
+<a href="http://hadoop.apache.org/zookeeper/mailing_lists.html">Mailing Lists</a>
+</div>
+<div class="menuitem">
+<a href="zookeeperOtherInfo.html">Other Info</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="releasenotes.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
+ PDF</a>
+</div>
+<h1>ZooKeeper 3.0.0 Release Notes</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#migration">Migration Instructions when Upgrading to 3.0.0</a>
+<ul class="minitoc">
+<li>
+<a href="#migration_code">Migrating Client Code</a>
+<ul class="minitoc">
+<li>
+<a href="#Java+API">Java API</a>
+</li>
+<li>
+<a href="#C+API">C API</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#migration_data">Migrating Server Data</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#changes">Changes Since ZooKeeper 2.2.1</a>
+</li>
+</ul>
+</div>
+
+
+
+
+
+<p>
+These release notes include new developer and user facing incompatibilities, features, and major improvements.
+</p>
+
+
+<ul>
+
+<li>
+<p>
+<a href="#migration">Migration Instructions</a>
+</p>
+</li>
+
+<li>
+<p>
+<a href="#changes">Changes</a>
+</p>
+</li>
+
+</ul>
+
+
+<a name="N1001B"></a><a name="migration"></a>
+<h2 class="h3">Migration Instructions when Upgrading to 3.0.0</h2>
+<div class="section">
+<p>
+
+<em>You should only have to read this section if you are upgrading from a previous version of ZooKeeper to version 3.0.0, otw skip down to <a href="#changes">changes</a></em>
+
+</p>
+<p>
+A small number of changes in this release have resulted in non-backward compatible Zookeeper client user code and server instance data. The following instructions provide details on how to migrate code and date from version 2.2.1 to version 3.0.0.
+</p>
+<p>
+Note: ZooKeeper increments the major version number (major.minor.fix) when backward incompatible changes are made to the source base. As part of the migration from SourceForge we changed the package structure (com.yahoo.zookeeper.* to org.apache.zookeeper.*) and felt it was a good time to incorporate some changes that we had been withholding. As a result the following will be required when migrating from 2.2.1 to 3.0.0 version of ZooKeeper.
+</p>
+<ul>
+
+<li>
+<p>
+<a href="#migration_code">Migrating Client Code</a>
+</p>
+</li>
+
+<li>
+<p>
+<a href="#migration_data">Migrating Server Data</a>
+</p>
+</li>
+
+</ul>
+<a name="N1003F"></a><a name="migration_code"></a>
+<h3 class="h4">Migrating Client Code</h3>
+<a name="N10045"></a><a name="Java+API"></a>
+<h4>Java API</h4>
+<ol>
+
+<li>
+<p>The java package structure has changed from <strong>com.yahoo.zookeeper*</strong> to <strong>org.apache.zookeeper*</strong>. This will probably effect all of your java code which makes use of ZooKeeper APIs (typically import statements)</p>
+</li>
+
+<li>
+<p>A number of constants used in the client ZooKeeper API were re-specified using enums (rather than ints). See <a href="https://issues.apache.org/jira/browse/ZOOKEEPER-7">ZOOKEEPER-7</a>, <a href="https://issues.apache.org/jira/browse/ZOOKEEPER-132">ZOOKEEPER-132</a> and <a href="https://issues.apache.org/jira/browse/ZOOKEEPER-139">ZOOKEEPER-139</a> for full details</p>
+</li>
+
+<li>
+<p>
+<a href="https://issues.apache.org/jira/browse/ZOOKEEPER-18">ZOOKEEPER-18</a> removed KeeperStateChanged, use KeeperStateDisconnected instead</p>
+</li>
+
+</ol>
+<p>
+Also see <a href="http://hadoop.apache.org/zookeeper/docs/current/api/index.html">the current java API</a>
+
+</p>
+<a name="N10077"></a><a name="C+API"></a>
+<h4>C API</h4>
+<ol>
+
+<li>
+<p>A number of constants used in the client ZooKeeper API were renamed in order to reduce namespace collision, see <a href="https://issues.apache.org/jira/browse/ZOOKEEPER-6">ZOOKEEPER-6</a> for full details</p>
+</li>
+
+</ol>
+<a name="N1008A"></a><a name="migration_data"></a>
+<h3 class="h4">Migrating Server Data</h3>
+<p>
+The following issues resulted in changes to the on-disk data format (the snapshot and transaction log files contained within the ZK data directory) and require a migration utility to be run.
+</p>
+<ul>
+
+<li>
+<p>
+<a href="https://issues.apache.org/jira/browse/ZOOKEEPER-27">ZOOKEEPER-27 Unique DB identifiers for servers and clients</a>
+</p>
+</li>
+
+<li>
+<p>
+<a href="https://issues.apache.org/jira/browse/ZOOKEEPER-32">ZOOKEEPER-32 CRCs for ZooKeeper data</a>
+</p>
+</li>
+
+<li>
+<p>
+<a href="https://issues.apache.org/jira/browse/ZOOKEEPER-33">ZOOKEEPER-33 Better ACL management</a>
+</p>
+</li>
+
+<li>
+<p>
+<a href="https://issues.apache.org/jira/browse/ZOOKEEPER-38">ZOOKEEPER-38 headers (version+) in log/snap files</a>
+</p>
+</li>
+
+</ul>
+<p>
+The following must be run once, and only once, when upgrading the ZooKeeper server instances to version 3.0.0.
+</p>
+<ol>
+
+<li>
+<p>TBD</p>
+</li>
+
+</ol>
+</div>
+
+
+<a name="N100BA"></a><a name="changes"></a>
+<h2 class="h3">Changes Since ZooKeeper 2.2.1</h2>
+<div class="section">
+<p>
+Version 2.2.1 code, documentation, binaries, etc... are still accessible on <a href="http://sourceforge.net/projects/zookeeper">SourceForge</a>
+
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<caption>Changes Since ZooKeeper 2.2.1</caption>
+
+<title>Changes Since ZooKeeper 2.2.1</title>
+
+
+<tr>
+
+<th>Issue</th>
+ <th>Notes</th>
+
+</tr>
+
+
+<tr>
+
+<td>
+ <a href="https://issues.apache.org/jira/browse/ZOOKEEPER-1">
+ ZOOKEEPER-1</a>
+ </td>
+ <td>
+ notes, placeholder - TBD during release process
+ </td>
+
+</tr>
+
+
+</table>
+</div>
+
+<p align="right">
+<font size="-2"></font>
+</p>
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2008 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: hadoop/zookeeper/trunk/docs/releasenotes.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: hadoop/zookeeper/trunk/docs/releasenotes.pdf
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/releasenotes.pdf?rev=704948&view=auto
==============================================================================
Binary file - no diff available.
Propchange: hadoop/zookeeper/trunk/docs/releasenotes.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Modified: hadoop/zookeeper/trunk/docs/zookeeperAdmin.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperAdmin.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperAdmin.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperAdmin.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
Modified: hadoop/zookeeper/trunk/docs/zookeeperInternals.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperInternals.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperInternals.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperInternals.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
Modified: hadoop/zookeeper/trunk/docs/zookeeperOtherInfo.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperOtherInfo.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperOtherInfo.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperOtherInfo.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
Modified: hadoop/zookeeper/trunk/docs/zookeeperOver.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperOver.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperOver.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperOver.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
Modified: hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperProgrammers.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.2', 'skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Developer</div>
<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
Modified: hadoop/zookeeper/trunk/docs/zookeeperStarted.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperStarted.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperStarted.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperStarted.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menupage">
<div class="menupagetitle">Getting Started</div>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
<div id="menu_1.2" class="menuitemgroup">
Modified: hadoop/zookeeper/trunk/docs/zookeeperTutorial.html
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperTutorial.html?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/docs/zookeeperTutorial.html (original)
+++ hadoop/zookeeper/trunk/docs/zookeeperTutorial.html Wed Oct 15 09:15:54 2008
@@ -113,6 +113,9 @@
<div class="menuitem">
<a href="zookeeperStarted.html">Getting Started</a>
</div>
+<div class="menuitem">
+<a href="releasenotes.html">Release Notes</a>
+</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.2', 'skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Developer</div>
<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml (original)
+++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml Wed Oct 15 09:15:54 2008
@@ -40,6 +40,7 @@
<li><strong>ZooKeeper Overview</strong><p>Technical Overview Documents for Client Developers, Adminstrators, and Contributors</p>
<ul><li><a href="zookeeperOver.html">Overview</a> - a bird's eye view of ZooKeeper, including design concepts and architecture</li>
<li><a href="zookeeperStarted.html">Getting Started</a> - a tutorial-style guide for developers to install, run, and program to ZooKeeper</li>
+ <li><a href="ext:relnotes">Release Notes</a> - new developer and user facing features, improvements, and incompatibilities</li>
</ul>
</li>
Added: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/releasenotes.xml
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/releasenotes.xml?rev=704948&view=auto
==============================================================================
--- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/releasenotes.xml (added)
+++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/releasenotes.xml Wed Oct 15 09:15:54 2008
@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2002-2004 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0//EN"
+"http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd">
+<article id="ar_ReleaseNotes">
+ <title>ZooKeeper 3.0.0 Release Notes</title>
+
+ <articleinfo>
+ <legalnotice>
+ <para>Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License. You may
+ obtain a copy of the License at <ulink
+ url="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</ulink>.</para>
+
+ <para>Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an "AS IS"
+ BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied. See the License for the specific language governing permissions
+ and limitations under the License.</para>
+ </legalnotice>
+ </articleinfo>
+
+<para>
+These release notes include new developer and user facing incompatibilities, features, and major improvements.
+</para>
+
+<itemizedlist>
+ <listitem><para><ulink url="#migration">Migration Instructions</ulink></para></listitem>
+ <listitem><para><ulink url="#changes">Changes</ulink></para></listitem>
+</itemizedlist>
+
+<section id="migration">
+<title>Migration Instructions when Upgrading to 3.0.0</title>
+
+<para>
+<emphasis>You should only have to read this section if you are upgrading from a previous version of ZooKeeper to version 3.0.0, otw skip down to <ulink url="#changes">changes</ulink></emphasis>
+</para>
+
+<para>
+A small number of changes in this release have resulted in non-backward compatible Zookeeper client user code and server instance data. The following instructions provide details on how to migrate code and date from version 2.2.1 to version 3.0.0.
+</para>
+
+<para>
+Note: ZooKeeper increments the major version number (major.minor.fix) when backward incompatible changes are made to the source base. As part of the migration from SourceForge we changed the package structure (com.yahoo.zookeeper.* to org.apache.zookeeper.*) and felt it was a good time to incorporate some changes that we had been withholding. As a result the following will be required when migrating from 2.2.1 to 3.0.0 version of ZooKeeper.
+</para>
+
+<itemizedlist>
+ <listitem><para><ulink url="#migration_code">Migrating Client Code</ulink></para></listitem>
+ <listitem><para><ulink url="#migration_data">Migrating Server Data</ulink></para></listitem>
+</itemizedlist>
+
+<section id="migration_code">
+<title>Migrating Client Code</title>
+
+<section>
+<title>Java API</title>
+
+<orderedlist>
+ <listitem><para>The java package structure has changed from <emphasis role="bold">com.yahoo.zookeeper*</emphasis> to <emphasis role="bold">org.apache.zookeeper*</emphasis>. This will probably effect all of your java code which makes use of ZooKeeper APIs (typically import statements)</para></listitem>
+ <listitem><para>A number of constants used in the client ZooKeeper API were re-specified using enums (rather than ints). See <ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-7">ZOOKEEPER-7</ulink>, <ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-132">ZOOKEEPER-132</ulink> and <ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-139">ZOOKEEPER-139</ulink> for full details</para></listitem>
+ <listitem><para><ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-18">ZOOKEEPER-18</ulink> removed KeeperStateChanged, use KeeperStateDisconnected instead</para></listitem>
+</orderedlist>
+
+<para>
+Also see <ulink url="http://hadoop.apache.org/zookeeper/docs/current/api/index.html">the current java API</ulink>
+</para>
+</section>
+
+<section>
+<title>C API</title>
+
+<orderedlist>
+ <listitem><para>A number of constants used in the client ZooKeeper API were renamed in order to reduce namespace collision, see <ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-6">ZOOKEEPER-6</ulink> for full details</para></listitem>
+</orderedlist>
+
+</section>
+</section>
+
+<section id="migration_data">
+<title>Migrating Server Data</title>
+
+<para>
+The following issues resulted in changes to the on-disk data format (the snapshot and transaction log files contained within the ZK data directory) and require a migration utility to be run.
+</para>
+
+<itemizedlist>
+ <listitem><para><ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-27">ZOOKEEPER-27 Unique DB identifiers for servers and clients</ulink></para></listitem>
+ <listitem><para><ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-32">ZOOKEEPER-32 CRCs for ZooKeeper data</ulink></para></listitem>
+ <listitem><para><ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-33">ZOOKEEPER-33 Better ACL management</ulink></para></listitem>
+ <listitem><para><ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-38">ZOOKEEPER-38 headers (version+) in log/snap files</ulink></para></listitem>
+</itemizedlist>
+
+<para>
+The following must be run once, and only once, when upgrading the ZooKeeper server instances to version 3.0.0.
+</para>
+
+<orderedlist>
+ <listitem><para>TBD</para></listitem>
+</orderedlist>
+</section>
+
+</section>
+
+<section id="changes">
+<title>Changes Since ZooKeeper 2.2.1</title>
+
+<para>
+Version 2.2.1 code, documentation, binaries, etc... are still accessible on <ulink url="http://sourceforge.net/projects/zookeeper">SourceForge</ulink>
+</para>
+
+ <table>
+<title>Changes Since ZooKeeper 2.2.1</title>
+<tgroup cols='2'>
+<colspec colname='c1'/><colspec colname='c2'/>
+<thead>
+<row>
+ <entry>Issue</entry>
+ <entry>Notes</entry>
+</row>
+</thead>
+<tbody>
+<row>
+ <entry>
+ <ulink url="https://issues.apache.org/jira/browse/ZOOKEEPER-1">
+ ZOOKEEPER-1</ulink>
+ </entry>
+ <entry>
+ notes, placeholder - TBD during release process
+ </entry>
+</row>
+
+</tbody></tgroup></table>
+
+</section>
+</article>
+
Propchange: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/releasenotes.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml?rev=704948&r1=704947&r2=704948&view=diff
==============================================================================
--- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml (original)
+++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml Wed Oct 15 09:15:54 2008
@@ -33,8 +33,9 @@
<docs label="Overview">
<welcome label="Welcome" href="index.html" />
- <overview label="Overview" href="zookeeperOver.html" />
+ <overview label="Overview" href="zookeeperOver.html" />
<started label="Getting Started" href="zookeeperStarted.html" />
+ <relnotes label="Release Notes" href="ext:relnotes" />
</docs>
<docs label="Developer">
@@ -76,6 +77,7 @@
<gzip href="http://www.gzip.org/" />
<cygwin href="http://www.cygwin.com/" />
<osx href="http://www.apple.com/macosx" />
+ <relnotes href="releasenotes.html" />
<api href="api/">
<started href="overview-summary.html#overview_description" />
<index href="index.html" />