You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2008/09/16 22:47:44 UTC
[jira] Created: (DERBY-3879) Getting Started Guide has typo and
version problems
Getting Started Guide has typo and version problems
---------------------------------------------------
Key: DERBY-3879
URL: https://issues.apache.org/jira/browse/DERBY-3879
Project: Derby
Issue Type: Bug
Affects Versions: 10.4.2.0
Reporter: Kim Haase
Assignee: Kim Haase
Priority: Minor
Mamta Satoor noticed the following in reviewing the 10.4.2 release:
Just spotted 2 documentation issues (very trivial) in Getting Started
with Derby. By no means, the release has to stop for them because i
think these 2 minor issues have been with the docs for probably all
the doc releases.
1)In the section 'Setting the environment variables", Step 1, for
Windows says set DERBY_HOME=c:\Derby_10.
We should not have the . at the end
2)In many different sections of this doc, we are showing incorrect
version of ij and Derby (I think they are all showing 10.2. we should
fix them to show 10.4 since we are talking about Derby 10.4 release).
One example of such a place in this doc is the section "Creating a
Derby database and running SQL statements" shows how to run ij in UNIX
and Windows and then it shows the output from ij displaying the ij
version. The output of ij for the 2 operating system in this section
shows to be running ij10.2 rather than 10.4 as shown below. We need to
fix the version number of ij in this section
UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
ij version 10.2
Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase resolved DERBY-3879.
------------------------------
Resolution: Fixed
Fix Version/s: 10.5.0.0
Derby Info: (was: [Patch Available])
Committed patch DERBY-3879-2.diff to documentation trunk at revision 702568.
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Fix For: 10.5.0.0
>
> Attachments: DERBY-3879-2.diff, DERBY-3879-2.zip, DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635763#action_12635763 ]
Kim Haase commented on DERBY-3879:
----------------------------------
I plan to commit this patch in one week (10/7) unless I hear that further changes are needed. Thanks.
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-3879:
-----------------------------
Attachment: DERBY-3879.zip
DERBY-3879.stat
DERBY-3879.diff
Attaching DERBY-3879.diff, DERBY-3879.stat, and DERBY-3879.zip, with the following changes.
M src/getstart/twwdactivity1.dita
M src/getstart/twwdactivity1_Setup.dita
M src/getstart/twwdactivity3_Setup.dita
M src/getstart/twwdactivity2.dita
M src/getstart/twwdactivity4.dita
M src/tools/rtoolssysinfo1002629.dita
M src/devguide/cdevdvlp27715.dita
In twwdactivity1.dita (Creating a Derby database and running SQL statements), the DERBYTUTOR directory was created within the Derby distribution. This is not the best practice. Putting it in C:\DERBYTUTOR creates one fewer version number to keep up with, so I've made that change.
In twwdactivity2.dita (Activity 2: Run SQL using the client driver), we previously described the derby.log contents at the end of the activity as follows:
Apache Derby Network Server - 10.2.2.0 - (485682) started and ready to
accept connections on port 1527 at 2007-05-04 20:04:33.511 GMT
... Database engine messages not shown ...
2007-05-04 20:08:43.883 GMT:
Shutting down instance c013800d-010f-82e9-fa03-00000011f280
This is not what appears in the log currently. The log appears to be erased when I run ij, so at the end all that's there is the shutdown message. I'm removing the paragraph about the log and the output from the topic, since the log output is not helpful. (If anyone is concerned about this and wants details, let me know.)
In twwdactivity3_Setup.dita (Activity 3: Run a JDBC program using the embedded driver), I changed the dates and times to be more current and edited a line that was too long.
In twwdactivity4.dita (Activity 4: Create and run a JDBC program using the client driver and Network Server), I made the twwdactivity3_Setup.dita changes as well as updating the startup and shutdown messages.
I also fixed some table formatting issues in this section of the Guide, involving two more files (twwdactivity1_overview.dita and twwdactivity1_Setup.dita).
In rtoolssysinfo1002629.dita (sysinfo example) I updated the version number and also updated Java from 1.4.2 to 1.6, to set a good example for users.
In cdevdvlp27715.dita (Booting databases) I updated the derby.log output and also changed "error log" to the more accurate "log file".
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12632281#action_12632281 ]
Kim Haase commented on DERBY-3879:
----------------------------------
The version problem also occurs in the Developer's Guide and Tools Guide. The Tools Guide uses the shortversionnumber defined in conrefs.dita, so the only problem is to change the build number in the one topic where it occurs (rtoolssysinfo1002629.dita, "sysinfo example"). The Dev Guide topic cdevdvlp27715.dita (Booting databases) needs updating from 10.2.
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-3879:
-----------------------------
Attachment: DERBY-3879-2.zip
DERBY-3879-2.diff
Thanks very much, Knut. I think it probably makes sense to use the hardcoded version number in the Tools Guide topic, the way the other books do. That way the same change will need to be made in all these places when we do a new release. So I've edited src/tools/rtoolssysinfo1002629.dita to do that. I'm attaching DERBY-3879-2.diff and DERBY-3879-2.zip with that change.
I'll commit this in a couple days unless I hear there's a problem.
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3879-2.diff, DERBY-3879-2.zip, DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Knut Anders Hatlen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12636064#action_12636064 ]
Knut Anders Hatlen commented on DERBY-3879:
-------------------------------------------
The patch looks good to me. Though many of the version numbers in the
getting started guide will still look outdated once we get a new
release out...
One minor comment:
+- <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>.2.0 - (689064): instance a816c00e-011c-7658-a92a-fffff0cfee85
With this markup, the 10.5 docs will say 10.5.2.0, even if the first
10.5 release will have version 10.5.1.x, and the svn revision number
will not match the version number.
The same approach is also used in the existing source in
rtoolssysinfo1002629.dita, so the patch doesn't actually introduce
this problem. Now there's one more possibility for inconsistencies in
that file, since the names of the jar files in the sysinfo output are
hard coded as C:\db-derby-10.4.2.0-bin\lib\*.jar, whereas the Locale
Information section of the sysinfo output says
+ version: <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>.2.0 - (689064)
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-3879:
-----------------------------
Derby Info: [Patch Available]
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Closed: (DERBY-3879) Getting Started Guide has typo and
version problems
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-3879?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase closed DERBY-3879.
----------------------------
Fixes now appear in Latest Alpha Manuals, so closing issue.
> Getting Started Guide has typo and version problems
> ---------------------------------------------------
>
> Key: DERBY-3879
> URL: https://issues.apache.org/jira/browse/DERBY-3879
> Project: Derby
> Issue Type: Bug
> Affects Versions: 10.4.2.0
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Fix For: 10.5.0.0
>
> Attachments: DERBY-3879-2.diff, DERBY-3879-2.zip, DERBY-3879.diff, DERBY-3879.stat, DERBY-3879.zip
>
>
> Mamta Satoor noticed the following in reviewing the 10.4.2 release:
> Just spotted 2 documentation issues (very trivial) in Getting Started
> with Derby. By no means, the release has to stop for them because i
> think these 2 minor issues have been with the docs for probably all
> the doc releases.
> 1)In the section 'Setting the environment variables", Step 1, for
> Windows says set DERBY_HOME=c:\Derby_10.
> We should not have the . at the end
> 2)In many different sections of this doc, we are showing incorrect
> version of ij and Derby (I think they are all showing 10.2. we should
> fix them to show 10.4 since we are talking about Derby 10.4 release).
> One example of such a place in this doc is the section "Creating a
> Derby database and running SQL statements" shows how to run ij in UNIX
> and Windows and then it shows the output from ij displaying the ij
> version. The output of ij for the 2 operating system in this section
> shows to be running ij10.2 rather than 10.4 as shown below. We need to
> fix the version number of ij in this section
> UNIX (Korn Shell) java -jar $DERBY_HOME/lib/derbyrun.jar ij
> ij version 10.2
> Windows java -jar %DERBY_HOME%\lib\derbyrun.jar ij
> ij version 10.2
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.