You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by rh...@apache.org on 2010/10/15 21:49:35 UTC
svn commit: r1023088 - in /db/derby/docs/trunk: ./ src/devguide/
src/getstart/ src/tools/
Author: rhillegas
Date: Fri Oct 15 19:49:34 2010
New Revision: 1023088
URL: http://svn.apache.org/viewvc?rev=1023088&view=rev
Log:
DERBY-4851: Parameterized long release ids, subversion revision numbers, and year stamps in the user docs.
Modified:
db/derby/docs/trunk/build.xml
db/derby/docs/trunk/docs.properties
db/derby/docs/trunk/src/devguide/cdevdvlp27715.dita
db/derby/docs/trunk/src/devguide/tdevdvlp20349.dita
db/derby/docs/trunk/src/getstart/twwdactivity1.dita
db/derby/docs/trunk/src/getstart/twwdactivity2.dita
db/derby/docs/trunk/src/getstart/twwdactivity3_Setup.dita
db/derby/docs/trunk/src/getstart/twwdactivity4.dita
db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita
Modified: db/derby/docs/trunk/build.xml
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/build.xml?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/build.xml (original)
+++ db/derby/docs/trunk/build.xml Fri Oct 15 19:49:34 2010
@@ -308,6 +308,8 @@ limitations under the License.
<filterset>
<filter token="COPYRIGHT_YEAR" value="${copyright.year}"/>
<filter token="RELEASE_ID_SHORT" value="${release.id.short}"/>
+ <filter token="RELEASE_ID_LONG" value="${release.id.long}"/>
+ <filter token="SUBVERSION_REVISION" value="${subversion.revision}"/>
</filterset>
</copy>
</target>
Modified: db/derby/docs/trunk/docs.properties
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/docs.properties?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/docs.properties (original)
+++ db/derby/docs/trunk/docs.properties Fri Oct 15 19:49:34 2010
@@ -12,4 +12,6 @@ dita.extname=.dita
temp.source=${basedir}/temp_source
copyright.year=2010
release.id.short=10.7
+release.id.long=${release.id.short}.1.0
+subversion.revision=1023066
args.csspath=
Modified: db/derby/docs/trunk/src/devguide/cdevdvlp27715.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdvlp27715.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp27715.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp27715.dita Fri Oct 15 19:49:34 2010
@@ -41,10 +41,10 @@ has been shut down or until you shut dow
<p>When <ph conref="../conrefs.dita#prod/productshortname"></ph> boots a database,
a message is added to the log file. The message includes the <ph conref="../conrefs.dita#prod/productshortname"></ph> version
that the database was booted with, for example:</p>
-<codeblock>2010-02-11 22:17:36.174 GMT:
+<codeblock>@COPYRIGHT_YEAR@-02-11 22:17:36.174 GMT:
Booting <ph conref="../conrefs.dita#prod/productshortname"></ph> version The Apache Software Foundation - <ph
conref="../conrefs.dita#prod/productlongname"></ph>
-- 10.6.0.0 - (908506): instance a816c00e-0121-2140-ffd9-fffff0cfee85
+- @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@): instance a816c00e-0121-2140-ffd9-fffff0cfee85
on database directory C:\sampledb</codeblock>
<p>The number of databases running in a <ph conref="../conrefs.dita#prod/productshortname"></ph> system
is limited only by the amount of memory available in the JVM.</p>
Modified: db/derby/docs/trunk/src/devguide/tdevdvlp20349.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/tdevdvlp20349.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/tdevdvlp20349.dita (original)
+++ db/derby/docs/trunk/src/devguide/tdevdvlp20349.dita Fri Oct 15 19:49:34 2010
@@ -33,7 +33,7 @@ the application shuts down the <ph conre
by issuing the following JDBC call:</p><codeblock>DriverManager.getConnection("jdbc:derby:;shutdown=true");</codeblock><p>Shutdown
commands always raise <i>SQLExceptions</i>.</p><p>When a <ph conref="../conrefs.dita#prod/productshortname"></ph> system
shuts down, a message goes to the log file:</p>
-<codeblock>2010-02-11 22:19:13.372 GMT:
+<codeblock>@COPYRIGHT_YEAR@-02-11 22:19:13.372 GMT:
Shutting down instance a816c00e-0121-2140-ffd9-fffff0cfee85</codeblock>
<p>Typically,
an application using an embedded <ph conref="../conrefs.dita#prod/productshortname"></ph> engine
Modified: db/derby/docs/trunk/src/getstart/twwdactivity1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/twwdactivity1.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/twwdactivity1.dita (original)
+++ db/derby/docs/trunk/src/getstart/twwdactivity1.dita Fri Oct 15 19:49:34 2010
@@ -47,12 +47,12 @@ relcolwidth="1* 4*">
<stentry><lines>UNIX
(Korn Shell)</lines></stentry>
<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar ij</userinput></b>
-<systemoutput>ij version 10.6</systemoutput></codeblock></stentry>
+<systemoutput>ij version @RELEASE_ID_SHORT@</systemoutput></codeblock></stentry>
</strow>
<strow>
<stentry><lines>Windows</lines></stentry>
<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</userinput></b>
-<systemoutput>ij version 10.6</systemoutput></codeblock></stentry>
+<systemoutput>ij version @RELEASE_ID_SHORT@</systemoutput></codeblock></stentry>
</strow>
</simpletable></stepxmp></step>
<step><cmd>Create the database and open a connection to the database using
@@ -143,15 +143,15 @@ ij> insert into COUNTRIES values ( 'Alba
<li>The <codeph>derby.log</codeph> file. This file is a message and error
log that, under normal circumstances, contains a set of startup messages and
a shutdown message. <codeblock><systemoutput>----------------------------------------------------------------
-2010-02-11 21:56:41.744 GMT:
+@COPYRIGHT_YEAR@-02-11 21:56:41.744 GMT:
Booting Derby version The Apache Software Foundation - Apache
- Derby - 10.6.0.0 - (908506):
+ Derby - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@):
instance a816c00e-0121-2126-a56a-000000418588
on database directory C:\DERBYTUTOR\firstdb
Database Class Loader started - derby.database.classpath=''
-2010-02-11 21:57:38.008 GMT:
+@COPYRIGHT_YEAR@-02-11 21:57:38.008 GMT:
Shutting down instance a816c00e-0121-2126-a56a-000000418588
----------------------------------------------------------------</systemoutput></codeblock></li>
<li>The <codeph>firstdb</codeph> database directory. Within the directory
Modified: db/derby/docs/trunk/src/getstart/twwdactivity2.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/twwdactivity2.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/twwdactivity2.dita (original)
+++ db/derby/docs/trunk/src/getstart/twwdactivity2.dita Fri Oct 15 19:49:34 2010
@@ -49,19 +49,19 @@ perform some basic SQL operations.</p></
<stentry><lines>UNIX
(Korn Shell)</lines></stentry>
<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar server start</userinput></b>
-<systemoutput>2010-02-11 22:00:38.982 GMT GMT : Security manager
+<systemoutput>@COPYRIGHT_YEAR@-02-11 22:00:38.982 GMT GMT : Security manager
installed using the Basic server security policy.
-2010-02-11 22:00:39.661 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) started and ready to
+@COPYRIGHT_YEAR@-02-11 22:00:39.661 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) started and ready to
accept connections on port 1527</systemoutput></codeblock></stentry>
</strow>
<strow>
<stentry><lines>Windows</lines></stentry>
<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar server start</userinput></b>
-<systemoutput>2010-02-11 22:00:38.982 GMT : Security manager
+<systemoutput>@COPYRIGHT_YEAR@-02-11 22:00:38.982 GMT : Security manager
installed using the Basic server security policy.
-2010-02-11 22:00:39.661 : Apache Derby Network
- Server - 10.6.0.0 - (908506) started and ready to
+@COPYRIGHT_YEAR@-02-11 22:00:39.661 : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) started and ready to
accept connections on port 1527</systemoutput></codeblock></stentry>
</strow>
</simpletable></stepxmp><stepresult>A Network Server startup message appears
@@ -80,12 +80,12 @@ relcolwidth="1* 4*">
<stentry><lines>UNIX
(Korn Shell)</lines></stentry>
<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar ij</userinput></b>
-<systemoutput>ij version 10.6</systemoutput></codeblock></stentry>
+<systemoutput>ij version @RELEASE_ID_SHORT@</systemoutput></codeblock></stentry>
</strow>
<strow>
<stentry><lines>Windows</lines></stentry>
<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar ij</userinput></b>
-<systemoutput>ij version 10.6</systemoutput></codeblock></stentry>
+<systemoutput>ij version @RELEASE_ID_SHORT@</systemoutput></codeblock></stentry>
</strow>
</simpletable></stepxmp><stepresult>You will enter all subsequent commands
from the network client, so you will type the commands in the Shell-2 command
@@ -132,14 +132,14 @@ Server.</cmd><stepxmp><simpletable relco
<stentry><lines>UNIX
(Korn Shell)</lines></stentry>
<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar server shutdown</userinput></b>
-<systemoutput>2010-02-11 22:04:30.301 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) shutdown</systemoutput></codeblock></stentry>
+<systemoutput>@COPYRIGHT_YEAR@-02-11 22:04:30.301 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) shutdown</systemoutput></codeblock></stentry>
</strow>
<strow>
<stentry><lines>Windows</lines></stentry>
<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar server shutdown</userinput></b>
-<systemoutput>2010-02-11 22:04:30.301 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) shutdown</systemoutput></codeblock></stentry>
+<systemoutput>@COPYRIGHT_YEAR@-02-11 22:04:30.301 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) shutdown</systemoutput></codeblock></stentry>
</strow>
</simpletable></stepxmp><stepresult>The server shutdown confirmation appears
in both command windows.</stepresult></step>
Modified: db/derby/docs/trunk/src/getstart/twwdactivity3_Setup.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/twwdactivity3_Setup.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/twwdactivity3_Setup.dita (original)
+++ db/derby/docs/trunk/src/getstart/twwdactivity3_Setup.dita Fri Oct 15 19:49:34 2010
@@ -90,13 +90,13 @@ Connected to database jdbcDemoDB
Enter wish-list item (enter exit to end):</systemoutput>
<b><userinput>a peppermint stick</userinput></b>
<systemoutput> __________________________________________________________
-On 2010-02-11 17:11:13.838 I wished for a peppermint stick
+On @COPYRIGHT_YEAR@-02-11 17:11:13.838 I wished for a peppermint stick
__________________________________________________________
Enter wish-list item (enter exit to end):</systemoutput>
<b><userinput>a long vacation</userinput></b>
<systemoutput> __________________________________________________________
-On 2010-02-11 17:11:13.838 I wished for a peppermint stick
-On 2010-02-11 17:11:19.381 I wished for a long vacation
+On @COPYRIGHT_YEAR@-02-11 17:11:13.838 I wished for a peppermint stick
+On @COPYRIGHT_YEAR@-02-11 17:11:19.381 I wished for a long vacation
__________________________________________________________
Enter wish-list item (enter exit to end):</systemoutput>
<b><userinput>exit</userinput></b>
Modified: db/derby/docs/trunk/src/getstart/twwdactivity4.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/twwdactivity4.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/twwdactivity4.dita (original)
+++ db/derby/docs/trunk/src/getstart/twwdactivity4.dita Fri Oct 15 19:49:34 2010
@@ -121,19 +121,19 @@ performed successfully.) </stepresult></
<stentry><lines>UNIX
(Korn Shell)</lines></stentry>
<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar server start</userinput></b>
-2010-02-11 22:14:03.613 GMT : Security manager
+@COPYRIGHT_YEAR@-02-11 22:14:03.613 GMT : Security manager
installed using the Basic server security policy.
-2010-02-11 22:14:04.278 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) started and ready to
+@COPYRIGHT_YEAR@-02-11 22:14:04.278 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) started and ready to
accept connections on port 1527</codeblock></stentry>
</strow>
<strow>
<stentry><lines>Windows</lines></stentry>
<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar server start</userinput></b>
-2010-02-11 22:14:03.613 GMT : Security manager
+@COPYRIGHT_YEAR@-02-11 22:14:03.613 GMT : Security manager
installed using the Basic server security policy.
-2010-02-11 22:14:04.278 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) started and ready to
+@COPYRIGHT_YEAR@-02-11 22:14:04.278 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) started and ready to
accept connections on port 1527</codeblock></stentry>
</strow>
</simpletable> </stepxmp></substep>
@@ -167,17 +167,17 @@ Connected to database jdbcDemoDB
Enter wish-list item (enter exit to end):</systemoutput>
<b><userinput>a sunny day</userinput></b>
<systemoutput> __________________________________________________________
-On 2010-02-11 17:11:13.838 I wished for a peppermint stick
-On 2010-02-11 17:11:19.381 I wished for a long vacation
-On 2010-02-11 17:17:43.521 I wished for a sunny day
+On @COPYRIGHT_YEAR@-02-11 17:11:13.838 I wished for a peppermint stick
+On @COPYRIGHT_YEAR@-02-11 17:11:19.381 I wished for a long vacation
+On @COPYRIGHT_YEAR@-02-11 17:17:43.521 I wished for a sunny day
__________________________________________________________
Enter wish-list item (enter exit to end):</systemoutput>
<b><userinput>a new car</userinput></b>
<systemoutput> __________________________________________________________
-On 2010-02-11 17:11:13.838 I wished for a peppermint stick
-On 2010-02-11 17:11:19.381 I wished for a long vacation
-On 2010-02-11 17:17:43.521 I wished for a sunny day
-On 2010-02-11 17:17:48.547 I wished for a new car
+On @COPYRIGHT_YEAR@-02-11 17:11:13.838 I wished for a peppermint stick
+On @COPYRIGHT_YEAR@-02-11 17:11:19.381 I wished for a long vacation
+On @COPYRIGHT_YEAR@-02-11 17:17:43.521 I wished for a sunny day
+On @COPYRIGHT_YEAR@-02-11 17:17:48.547 I wished for a new car
__________________________________________________________
Enter wish-list item (enter exit to end):</systemoutput>
<b><userinput>exit</userinput></b>
@@ -195,15 +195,15 @@ Getting Started With Derby JDBC program
<stentry><lines>UNIX
(Korn Shell)</lines></stentry>
<stentry><codeblock><b><userinput>java -jar $DERBY_HOME/lib/derbyrun.jar server shutdown</userinput></b>
-<systemoutput>2010-02-11 22:19:13.475 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) shutdown</systemoutput>
+<systemoutput>@COPYRIGHT_YEAR@-02-11 22:19:13.475 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) shutdown</systemoutput>
</codeblock></stentry>
</strow>
<strow>
<stentry><lines>Windows</lines></stentry>
<stentry><codeblock><b><userinput>java -jar %DERBY_HOME%\lib\derbyrun.jar server shutdown</userinput></b>
-<systemoutput>2010-02-11 22:19:13.475 GMT : Apache Derby Network
- Server - 10.6.0.0 - (908506) shutdown</systemoutput>
+<systemoutput>@COPYRIGHT_YEAR@-02-11 22:19:13.475 GMT : Apache Derby Network
+ Server - @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@) shutdown</systemoutput>
</codeblock></stentry>
</strow>
</simpletable> </stepxmp><stepresult>The server shutdown confirmation appears
Modified: db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita?rev=1023088&r1=1023087&r2=1023088&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolssysinfo1002629.dita Fri Oct 15 19:49:34 2010
@@ -44,39 +44,39 @@ java.specification.version: 1.6
java.runtime.version: 1.6.0_20-b02
--------- Derby Information --------
JRE - JDBC: Java SE 6 - JDBC 4.0
-[C:\db-derby-10.6.0.0-bin\lib\derby.jar] 10.6.0.0 - (908506)
-[C:\db-derby-10.6.0.0-bin\lib\derbytools.jar] 10.6.0.0 - (908506)
-[C:\db-derby-10.6.0.0-bin\lib\derbynet.jar] 10.6.0.0 - (908506)
-[C:\db-derby-10.6.0.0-bin\lib\derbyclient.jar] 10.6.0.0 - (908506)
+[C:\db-derby-@RELEASE_ID_LONG@-bin\lib\derby.jar] @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
+[C:\db-derby-@RELEASE_ID_LONG@-bin\lib\derbytools.jar] @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
+[C:\db-derby-@RELEASE_ID_LONG@-bin\lib\derbynet.jar] @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
+[C:\db-derby-@RELEASE_ID_LONG@-bin\lib\derbyclient.jar] @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
------------------------------------------------------
----------------- Locale Information -----------------
Current Locale : [English/United States [en_US]]
Found support for locale: [cs]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [de_DE]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [es]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [fr]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [hu]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [it]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [ja_JP]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [ko_KR]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [pl]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [pt_BR]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [ru]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [zh_CN]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
Found support for locale: [zh_TW]
- version: 10.6.0.0 - (908506)
+ version: @RELEASE_ID_LONG@ - (@SUBVERSION_REVISION@)
------------------------------------------------------</codeblock></example>
<section><p>When you request help for a problem by posting to the derby-user
mailing list, include a copy of the information provided