Merge lp:~nwilliams/akiban-persistit/release-script into lp:akiban-persistit

Proposed by Nathan Williams
Status: Merged
Approved by: Peter Beaman
Approved revision: 328
Merged at revision: 323
Proposed branch: lp:~nwilliams/akiban-persistit/release-script
Merge into: lp:akiban-persistit
Diff against target: 506 lines (+308/-84)
7 files modified
build_release.sh (+205/-0)
doc/GettingStarted.rst (+7/-10)
doc/ReleaseNotes.rst (+81/-21)
doc/build/build-doc.sh (+1/-1)
doc/build/build-doc.sh.orig (+0/-48)
doc/conf.py (+13/-3)
src/main/javadoc/overview.html (+1/-1)
To merge this branch: bzr merge lp:~nwilliams/akiban-persistit/release-script
Reviewer Review Type Date Requested Status
Peter Beaman Pending
Review via email: mp+110581@code.launchpad.net

Description of the change

Add script for building release packages, minor doc tweaks, first pass 3.1.2 release notes.

Nothing terribly interesting. The script will take a release branch (created elsewhere, already present in existing release process) and build all release artifacts: open and community edition zip/tars with signing and docs for the website.

There was a bit added to the Sphinx config and tweaks to GettingStarted to consolidate some of the repetition in version numbers. These were factored out into common substitutions defined in the config so we only have to change one place. Minor rewording to use these new defines and links add as well.

Also take a first pass at the release notes for 3.1.2. Basically just describing fixed bugs. This could definitely use some review. Additionally, reorganize the release notes to better handle multiple entries: common section for building, etc and then date/summary/issues for each release.

To post a comment you must log in.
Revision history for this message
Peter Beaman (pbeaman) wrote :

Looks great.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added file 'build_release.sh'
2--- build_release.sh 1970-01-01 00:00:00 +0000
3+++ build_release.sh 2012-06-15 17:42:20 +0000
4@@ -0,0 +1,205 @@
5+#!/bin/bash
6+#
7+# Copyright © 2012 Akiban Technologies, Inc. All rights reserved.
8+#
9+# This program is free software: you can redistribute it and/or modify
10+# it under the terms of the GNU Affero General Public License as
11+# published by the Free Software Foundation, version 3 (only) of the
12+# License.
13+#
14+# This program is distributed in the hope that it will be useful,
15+# but WITHOUT ANY WARRANTY; without even the implied warranty of
16+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+# GNU Affero General Public License for more details.
18+#
19+# You should have received a copy of the GNU Affero General Public License
20+# along with this program. If not, see <http://www.gnu.org/licenses/>.
21+#
22+# This program may also be available under different license terms. For more
23+# information, see www.akiban.com or contact licensing@akiban.com.
24+#
25+
26+#
27+# Build build artifacts associated with a release
28+# - Documentation (apidocs and sphinx html, for website)
29+# - akiban-persistit-X.X.X-website-docs.tar.gz
30+# - Bundles/packages
31+# - akiban-persistit-X.X.X.zip (binary, AGPL)
32+# - akiban-persistit-X.X.X.tar.gz (binary, AGPL)
33+# - akiban-persistit-X.X.X-source.zip (source, AGPL)
34+# - akiban-persistit-X.X.X-source.tar.gz (source, AGPL)
35+# - akiban-persistit-community-X.X.X.zip (binary, EULA)
36+# - akiban-persistit-community-X.X.X.tar.gz (binary, EULA)
37+#
38+
39+set -e
40+
41+# $1 - APIDOC_URL (empty OK)
42+function docs_build {
43+ rm -rf target/site/apidocs
44+ rm -rf target/sphinx
45+ mvn javadoc:javadoc >/dev/null
46+ cd doc/build
47+ APIDOC_URL="$1" bash -e build-doc.sh >/dev/null
48+ cd ../../
49+ rm -r target/sphinx/html/{.buildinfo,.doctrees,objects.inv}
50+}
51+
52+# $1 - revno
53+# $2 - args to maven
54+function maven_build {
55+ mvn $2 -DBZR_REVISION="$1" -DskipTests=true clean compile test-compile package >/dev/null
56+}
57+
58+
59+REQUIRED_PROGS="bzr mvn javac sphinx-build curl awk sed tr basename zip tar gpg"
60+BRANCH_DEFAULT="lp:~akiban-technologies/akiban-persistit"
61+COMM_LICENSE_URL="http://www.akiban.com/akiban-persistit-community-license-agreement-plaintext"
62+
63+VERSION=""
64+BRANCH_URL=""
65+WORKSPACE="/tmp/persistit_release"
66+
67+while getopts "hb:v:w:" FLAG; do
68+ case "${FLAG}" in
69+ h) ;;
70+ b) BRANCH="${OPTARG}" ;;
71+ v) VERSION="${OPTARG}" ;;
72+ w) WORKSPACE="${OPTARG}" ;;
73+ *) echo "Unhandled option" 1>&2 ; exit 1 ;;
74+ esac
75+done
76+
77+if [ "${VERSION}" = "" ]; then
78+ echo "Missing required version arg -v" 1>&2
79+ exit 1
80+fi
81+
82+if [ "${BRANCH}" = "" ]; then
83+ BRANCH_URL="${BRANCH_DEFAULT}/${VERSION}"
84+fi
85+
86+
87+echo "Build packages for version: ${VERSION}"
88+echo "Use source branch: ${BRANCH_URL}"
89+echo "Use workspace location: ${WORKSPACE}"
90+
91+
92+echo "Checking for required programs"
93+for PROG in ${REQUIRED_PROGS}; do
94+ if [ "$(which ${PROG})" = "" ]; then
95+ echo " ${PROG} not found in PATH" 1>&2
96+ exit 1
97+ fi
98+done
99+
100+
101+NAME="akiban-persistit"
102+BRANCH_DIR="${WORKSPACE}/${VERSION}"
103+SOURCE_DIR="${WORKSPACE}/${NAME}-${VERSION}-source"
104+OPEN_DIR="${WORKSPACE}/${NAME}-${VERSION}"
105+COMM_DIR="${WORKSPACE}/${NAME}-community-${VERSION}"
106+WEBDOCS_DIR="${WORKSPACE}/${NAME}-${VERSION}-website-docs"
107+
108+
109+echo "Cleaning workspace ${WORKSPACE}"
110+rm -rf "${WORKSPACE}"
111+mkdir -p "${WORKSPACE}"
112+cd "${WORKSPACE}"
113+
114+
115+echo "Fetching revision number"
116+REVNO=$(bzr revno -q "${BRANCH_URL}")
117+echo "Revision $REVNO"
118+
119+
120+echo "Exporting branch"
121+bzr export -q "${BRANCH_DIR}" "${BRANCH_URL}"
122+
123+
124+echo "Making package directories"
125+cp -r "${BRANCH_DIR}" "${SOURCE_DIR}"
126+cp -r "${BRANCH_DIR}" "${OPEN_DIR}"
127+rm -r "${OPEN_DIR}"/{doc,examples/scripts,src,pom.xml}
128+mkdir "${OPEN_DIR}/doc"
129+cp -r "${OPEN_DIR}" "${COMM_DIR}"
130+
131+
132+echo "Building open edition and docs"
133+cd "${BRANCH_DIR}"
134+maven_build "${REVNO}"
135+docs_build "../apidocs"
136+
137+
138+echo "Copying docs and jars"
139+cd "${WORKSPACE}"
140+cp -r "${BRANCH_DIR}"/target/{site/apidocs,sphinx/html} "${OPEN_DIR}/doc"
141+cp -r "${BRANCH_DIR}"/target/sphinx/text/ReleaseNotes "${OPEN_DIR}/ReleaseNotes.txt"
142+mv "${BRANCH_DIR}"/target/*-sources.jar "${OPEN_DIR}/${NAME}-${VERSION}-sources.jar"
143+mv "${BRANCH_DIR}"/target/*.jar "${OPEN_DIR}/${NAME}-${VERSION}.jar"
144+
145+
146+echo "Downloading and formating community license"
147+cd "${WORKSPACE}"
148+curl -s "${COMM_LICENSE_URL}" |
149+ # Pull out the content between the two regexes, excluding the matches themselves
150+ awk '/<div class="content">/ {flag=1;next} /<\/div>/ {flag=0} flag {print}' |
151+ # Replace paragraph end marks for the first 4 paragraphs with newlines
152+ awk '{if(NR < 8) sub(/<\/p>/, "\n"); print }' |
153+ # Delete all: <p>, </p>, </div>, and &nbsp; occurrences
154+ sed -e 's/<p>//g' -e 's/<\/p>//g' -e 's/<\/div>//g' -e 's/&nbsp;//g' |
155+ # Replace unicode quotes with simple ones
156+ sed -e 's/[“”]/"/g' -e "s/’/'/g" |
157+ # Un-link email address(es)
158+ sed -e 's/<a href=".*">//g' -e 's/<\/a>//g' |
159+ # Collapse repeated spaces
160+ tr -s ' ' |
161+ # Wrap nicely at 80 characters
162+ fold -s \
163+ > "${COMM_DIR}/LICENSE.txt"
164+
165+
166+echo "Building community edition and docs"
167+cd "${BRANCH_DIR}"
168+cp "${COMM_DIR}/LICENSE.txt" .
169+awk 'BEGIN { FS="\n"; RS="";}\
170+ {sub(/[ ]*<licenses>.*<\/licenses>/,\
171+ "<licenses>\n<license>\n<name>Proprietary</name>\n<url>http://www.akiban.com/akiban-persistit-community-license-agreement</url>\n<distribution>manual</distribution>\n</license>\n</licenses>\n"); print;}'\
172+ pom.xml > pom_comm.xml
173+maven_build "${REVNO}" "-f pom_comm.xml"
174+docs_build "../apidocs"
175+cp -r target/{site/apidocs,sphinx/html} "${COMM_DIR}/doc"
176+cp target/sphinx/text/ReleaseNotes "${COMM_DIR}/ReleaseNotes.txt"
177+rm target/*-sources.jar
178+mv target/*.jar "${COMM_DIR}/${NAME}-${VERSION}.jar"
179+
180+
181+echo "Creating zip and tar.gz files"
182+cd "${WORKSPACE}"
183+for DIR in "${OPEN_DIR}" "${SOURCE_DIR}" "${COMM_DIR}"; do
184+ BASE_DIR="`basename ${DIR}`"
185+ zip -r "${DIR}.zip" "$BASE_DIR" >/dev/null
186+ tar czf "${DIR}.tar.gz" "${BASE_DIR}"
187+done
188+
189+
190+echo "Building docs for website"
191+mkdir "${WEBDOCS_DIR}"
192+cd "${BRANCH_DIR}"
193+docs_build ""
194+cp -r target/{site/apidocs,sphinx/html} "${WEBDOCS_DIR}"
195+cd ${WORKSPACE}
196+tar czf "${WEBDOCS_DIR}.tar.gz" "$(basename $WEBDOCS_DIR)"
197+
198+
199+if [ "$SKIP_SIGNING" = "" ]; then
200+ echo "Signing files for Launchpad upload"
201+ for FILE in `ls *.zip *.tar.gz`; do
202+ gpg --armor --sign --detach-sig "${FILE}" 1>/dev/null
203+ done
204+fi
205+
206+
207+echo "All output files are in: ${WORKSPACE}"
208+echo "Done"
209+
210
211=== modified file 'doc/GettingStarted.rst'
212--- doc/GettingStarted.rst 2012-06-11 21:25:37 +0000
213+++ doc/GettingStarted.rst 2012-06-15 17:42:20 +0000
214@@ -20,18 +20,16 @@
215 Download and Install
216 --------------------
217
218-Download ``akiban-persistit-3.1.1.zip`` from link found at http://www.akiban.com/akiban-persistit.
219-
220-Unpack the distribution kit into a convenient directory using any unzip utility. For example, use ``jar`` to unpack the distribution kit to the current working directory as follows::
221-
222- jar xvf akiban-persistit-3.1.1.zip
223-
224-Review the ``LICENSE.txt`` file located in the root of the installation directory. Persistit is licensed under the GNU Affero General Public License or a free-use community license, see http://www.akiban.com/akiban-licensing-options for more details. By installing, copying or otherwise using the Software contained in the distribution kit, you agree to be bound by the terms of the license agreement. If you do not agree to these terms, remove and destroy all copies of the software in your possession immediately.
225+Download |zip_file_name| from the `Launchpad project <https://launchpad.net/akiban-persistit/+download>`_ or directly from `akiban.com <http://www.akiban.com/akiban-persistit>`_.
226+
227+Unpack the distribution kit into a convenient directory using any unzip utility. For example, use |unpack_zip_cmd| to unpack the distribution kit into the current working directory.
228+
229+Review the ``LICENSE.txt`` file located in the root of the installation directory. Persistit is licensed under the GNU Affero General Public License or a free-use community license, see our `licensing options <http://www.akiban.com/akiban-licensing-options>`_ for more details. By installing, copying or otherwise using the Software contained in the distribution kit, you agree to be bound by the terms of the license agreement. If you do not agree to these terms, remove and destroy all copies of the software in your possession immediately.
230
231 Working with Persistit
232 ----------------------
233
234-Add the ``akiban-persistit-3.1.1.jar``, as found in the root directory of the distribution kit, to your project's classpath. For example, copy it to ``jre/lib/ext`` in your Java Runtime Environment, or add it to your classpath environment variable.
235+Add the |jar_file_name|, is found in the root directory of the distribution kit, to your project's classpath. For example, copy it to ``jre/lib/ext`` in your Java Runtime Environment, or add it to your classpath environment variable.
236
237 That's it. You are ready to work with Persistit.
238
239@@ -131,8 +129,7 @@
240
241 datapath=.
242 buffer.count.8192=32
243- volume.1=${datapath}/hwdemo,create,pageSize:8192,\
244- initialPages:5,extensionPages:5,maximumPages:100000
245+ volume.1=${datapath}/hwdemo,create,pageSize:8192,initialPages:5,extensionPages:5,maximumPages:100000
246 journalpath=${datapath}/hwdemo_journal
247
248 See :ref:`Configuration` for additional information about Persistit configuration properties.
249
250=== modified file 'doc/ReleaseNotes.rst'
251--- doc/ReleaseNotes.rst 2012-05-31 19:24:17 +0000
252+++ doc/ReleaseNotes.rst 2012-06-15 17:42:20 +0000
253@@ -1,22 +1,16 @@
254 ************************************
255-Akiban Persistit 3.1.1 Release Notes
256+Akiban Persistit
257 ************************************
258
259-Release Date
260-============
261-May 31, 2012
262-
263 Overview
264 ========
265-This is the first open source release of the Persistit project (https://launchpad.net/akiban-persistit).
266-
267 See http://www.akiban.com/akiban-persistit for a summary of features and benefits, licensing information and how to get support.
268
269 Documentation
270 =============
271 Users Guide: http://www.akiban.com/ak-docs/admin/persistit
272
273-JavaDoc: http://www.akiban.com/ak-docs/admin/persistit-api
274+JavaDoc: http://www.akiban.com/sites/all/libraries/persistit-api/index.html
275
276 Building Akiban-Persistit
277 =========================
278@@ -41,6 +35,73 @@
279
280 in each of the examples subdirectories to build and run the examples.
281
282+Buffer Pool Configuration
283+=========================
284+For optimal performance, proper configuration of the Persistit buffer pool is required. See section "Configuring the Buffer Pool" in the configuration document http://www.akiban.com/ak-docs/admin/persistit/Configuration.html
285+
286+.. note:: Especially when used with multi-gigabyte heaps, the default Hotspot JVM server heuristics are be suboptimal for Persistit applications. Persistit is usually configured to allocate a large fraction of the heap to Buffer instances that are allocated at startup and held for the duration of the Persistit instance. For efficient operation, all of the Buffer instances must fit in the tenured (old) generation of the heap to avoid very significant garbage collector overhead. Use either -XX:NewSize or -Xmn to adjust the relative sizes of the new and old generations.
287+
288+|
289+|
290+
291+************************************
292+3.1.2
293+************************************
294+
295+Release Date
296+============
297+June 15, 2012
298+
299+Overview
300+========
301+This is a bug fix release of the Persistit project (https://launchpad.net/akiban-persistit).
302+
303+Fixed Issues
304+============
305+
306+Infinite Loop When Repacking Buffer
307+-----------------------------------
308+
309+https://bugs.launchpad.net/bugs/1005206
310+
311+This was introduced late into the 3.1.1 development cycle. This could occur if a buffer required restructuring during pruning of a long value that was previously stored under a transaction. Upon the next save of this buffer to disk (e.g. shutdown), an infinite loop would occur.
312+
313+Corruption Exceptions During Various Operations
314+-----------------------------------------------
315+
316+https://bugs.launchpad.net/bugs/1010079
317+
318+.. note::
319+ Only the message indicates a database corruption. The data volume is actually correct and intact.
320+
321+This was introduced late into the 3.1.1 development cycle. This could occur if pruning a buffer containing a long record previously stored under a transaction required removal of keys and then that buffer was reused without further modification. A parallel structure associated with the every ``Buffer``, the ``FastIndex``, was not maintained during this operation.
322+
323+Slow Accumulator Operations
324+---------------------------
325+
326+https://bugs.launchpad.net/bugs/1012859
327+
328+This bug preexisted, but was unknown to, the 3.1.1 release. If a thread starting a new transaction was interrupted during the call to ``begin()``, there was a chance for an internal object to wind up in an invalid state. This invalid state caused no visible consequences other than slower than expected ``Accumulator`` actions if this had occurred many times.
329+
330+Known Issues
331+============
332+As described in the *3.1.1 Known Issues*.
333+
334+|
335+|
336+
337+************************************
338+3.1.1
339+************************************
340+
341+Release Date
342+============
343+May 31, 2012
344+
345+Overview
346+========
347+This is the first open source release of the Persistit project (https://launchpad.net/akiban-persistit).
348+
349 Known Issues
350 ============
351
352@@ -49,37 +110,36 @@
353
354 All operations within Trees such as store, fetch, remove and traverse are correctly supported within transactions. However, the operations to create and delete Tree instances currently do not respect transaction boundaries. For example, if a transaction creates a new Tree, it is immediately visible within other Transactions and will continue to exist even if the original transaction aborts. (However, records inserted or modified by the original transaction will not be visible until the transaction commits.) Prior to creating/removing trees, transaction processing should be quiesced and allowed to complete.
355
356-Problems with Disk Full - Bug 916071
357+Problems with Disk Full
358 ------------------------------------
359
360+https://bugs.launchpad.net/akiban-persistit/+bug/916071
361+
362 There are rare cases where Persistit will generate exceptions other than java.io.IOException: No space left on device when a disk volume containing the journal or volume file fills up. The database will be intact upon recovery, but the application may receive unexpected exceptions.
363
364-Out of Memory Error, Direct Memory Buffer - Bug 985117
365+Out of Memory Error, Direct Memory Buffer
366 ------------------------------------------------------
367
368+https://bugs.launchpad.net/akiban-persistit/+bug/985117
369+
370 Out of Memory Error, Direct Memory Buffer. Can cause failed transactions under extreme load conditions as a result of threads getting backed up writing to the journal file. However, this error is transient and recoverable by by retrying the failed transaction.
371
372 * Workaround: Ensure your application has the ability to retry failed transactions
373
374-
375-Tree#getChangeCount may return inaccurate result - Bug 986465
376+Tree#getChangeCount may return inaccurate result
377 -------------------------------------------------------------
378
379+https://bugs.launchpad.net/akiban-persistit/+bug/986465
380+
381 The getChangeCount method may return inaccurate results as its not currently transactional. The primary consumer is the PersistitMap. As a result of this bug Persistit may not generate java.util.ConcurrentModiciationException when it is supposed to.
382
383-Multi-Version-Values sometimes not fully pruned - Bug 1000331
384+Multi-Version-Values sometimes not fully pruned
385 -------------------------------------------------------------
386
387+https://bugs.launchpad.net/akiban-persistit/+bug/1000331
388+
389 Multi-version values are not always pruned properly causing volume growth. The number of MVV records and their overhead size can be obtaining by running the IntegrityCheck task.
390-
391 * Workaround 1: Run the IntegrityCheck task (CLI command icheck) with the -P option which will prune the MVVs. This will remove obsolete MVV instances and in many cases free up pages in which new data can be stored. However, it will not reduce the actual size of the volume file.
392
393 * Workaround 2: To reduce the size of the volume you can use the CLI commands save and load to offload and then reload the data into a newly created volume file. See http://www.akiban.com/ak-docs/admin/persistit/Management.html#management for more information about these operations.
394
395-
396-Buffer Pool Configuration
397-=========================
398-For optimal performance, proper configuration of the Persistit buffer pool is required. See section "Configuring the Buffer Pool" in the configuration document http://www.akiban.com/ak-docs/admin/persistit/Configuration.html
399-
400-.. note:: Especially when used with multi-gigabyte heaps, the default Hotspot JVM server heuristics are be suboptimal for Persistit applications. Persistit is usually configured to allocate a large fraction of the heap to Buffer instances that are allocated at startup and held for the duration of the Persistit instance. For efficient operation, all of the Buffer instances must fit in the tenured (old) generation of the heap to avoid very significant garbage collector overhead. Use either -XX:NewSize or -Xmn to adjust the relative sizes of the new and old generations.
401-
402
403=== modified file 'doc/build/build-doc.sh'
404--- doc/build/build-doc.sh 2012-06-11 21:25:37 +0000
405+++ doc/build/build-doc.sh 2012-06-15 17:42:20 +0000
406@@ -69,5 +69,5 @@
407
408 sphinx-build -a "$DOC_TARGET_PATH" "$DOC_FINAL_PATH"
409
410-fold -s "${DOC_TARGET_PATH}/ReleaseNotes.rst" | sed 's/``//g' | sed 's/\.\. note:/NOTE/' | sed 's/::/:/' > ../../target/sphinx/text/ReleaseNotes
411+fold -s "${DOC_TARGET_PATH}/ReleaseNotes.rst" | sed -e 's/``//g' -e 's/\.\. note:/NOTE/' -e 's/::/:/' -e 's/^|$//' > ../../target/sphinx/text/ReleaseNotes
412
413
414=== removed file 'doc/build/build-doc.sh.orig'
415--- doc/build/build-doc.sh.orig 2012-05-30 16:25:09 +0000
416+++ doc/build/build-doc.sh.orig 1970-01-01 00:00:00 +0000
417@@ -1,48 +0,0 @@
418-#/bin/sh
419-#
420-# Copyright © 2011-2012 Akiban Technologies, Inc. All rights reserved.
421-#
422-# This program is free software: you can redistribute it and/or modify
423-# it under the terms of the GNU Affero General Public License as
424-# published by the Free Software Foundation, version 3 (only) of the
425-# License.
426-#
427-# This program is distributed in the hope that it will be useful,
428-# but WITHOUT ANY WARRANTY; without even the implied warranty of
429-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
430-# GNU Affero General Public License for more details.
431-#
432-# You should have received a copy of the GNU Affero General Public License
433-# along with this program. If not, see <http://www.gnu.org/licenses/>.
434-#
435-# This program may also be available under different license terms. For more
436-# information, see www.akiban.com or contact licensing@akiban.com.
437-#
438-
439-# ---------------------
440-#
441-# Builds the Akiban Persistit doc set. Currently this process is based on
442-# the asciidoc tool (http://www.methods.co.nz/asciidoc/).
443-#
444-# Here are the steps:
445-# 1. Run a Java program AsciiDocPrep to prepare a text asciidoc file.
446-# Among other things, AsciiDocPrep fills in JavaDoc hyperlinks.
447-# 2. Run asciidoc to generate an html file.
448-# 3. Use sed to replace some characters. Turns out asciidoc doesn't like
449-# to link to URLs having spaces, so AsciDocPrep replaces those spaces
450-# with the "`" character. This step converts those back to spaces.
451-#
452-# Run this script from the root of the persistit source directory. This
453-# script writes changes only into a directory /tmp/akiban-persistit-doc.
454-# The end-product files, user_guide.html and user_guide.xml are written
455-# there.
456-#
457-rm -rf /tmp/akiban-persistit-doc
458-mkdir /tmp/akiban-persistit-doc
459-javac -d /tmp/akiban-persistit-doc -cp ../../core/target/classes/ src/*.java
460-java -cp /tmp/akiban-persistit-doc:../../core/target/classes AsciiDocPrep in=../TOC.txt out=/tmp/akiban-persistit-doc/doc.txt base=apidocs index=../../core/target/site/apidocs/index-all.html
461-asciidoc -a toc -n -d book -b xhtml11 -o /tmp/akiban-persistit-doc/doc.html /tmp/akiban-persistit-doc/doc.txt
462-asciidoc -a toc -n -d book -b docbook -o /tmp/akiban-persistit-doc/doc.xml /tmp/akiban-persistit-doc/doc.txt
463-sed s/\`/\ / /tmp/akiban-persistit-doc/doc.html > /tmp/akiban-persistit-doc/user_guide.html
464-sed s/\`/\ / /tmp/akiban-persistit-doc/doc.xml > /tmp/akiban-persistit-doc/user_guide.xml
465-
466
467=== modified file 'doc/conf.py'
468--- doc/conf.py 2012-05-31 18:49:39 +0000
469+++ doc/conf.py 2012-06-15 17:42:20 +0000
470@@ -48,10 +48,20 @@
471 # |version| and |release|, also used in various other places throughout the
472 # built documents.
473 #
474-# The short X.Y version.
475+# version = short X.Y version.
476+# release = full version, including alpha/beta/rc tags.
477 version = '3.1.1'
478-# The full version, including alpha/beta/rc tags.
479-release = '3.1.1'
480+release = version
481+
482+# Included while processing every rst file. Used only for working around inability
483+# to format substitutions directly, but could have more uses.
484+rst_epilog = """
485+.. |jar_file_name| replace:: ``{0}-{1}.jar``
486+.. |zip_file_name| replace:: ``{0}-{1}.zip``
487+.. |tar_file_name| replace:: ``{0}-{1}.tar.gz``
488+.. |unpack_zip_cmd| replace:: ``jar -xvf {0}-{1}.zip``
489+.. |unpack_tar_cmd| replace:: ``tar -xzf {0}-{1}.tar.gz``
490+""".format("akiban-persistit", release)
491
492 # The language for content autogenerated by Sphinx. Refer to documentation
493 # for a list of supported languages.
494
495=== modified file 'src/main/javadoc/overview.html'
496--- src/main/javadoc/overview.html 2012-05-31 21:07:44 +0000
497+++ src/main/javadoc/overview.html 2012-06-15 17:42:20 +0000
498@@ -22,7 +22,7 @@
499 <html>
500 <body>
501 <div id="header">
502-<h1>Persistit 3.1.1</h1>
503+<h1>Persistit</h1>
504 </div>
505 <div id="content">
506 <div id="preamble">

Subscribers

People subscribed via source and target branches