db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Susan Cline (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-381) Doc review: Derby Server and Admin Guide
Date Thu, 23 Jun 2005 02:14:10 GMT
    [ http://issues.apache.org/jira/browse/DERBY-381?page=comments#action_12314279 ] 

Susan Cline commented on DERBY-381:
-----------------------------------

Server Guide Documentation Review
This is a review after Army's comments were committed.

1) Page: http://incubator.apache.org/derby/docs/adminguide/tadminconfig815768.html

It should be noted that this command only works from the host that started the network
server.  So add something like this right below this info:

java org.apache.derby.drda.NetworkServerControl
sysinfo [-h <hostname>][-p <portnumber>] 

Administrative commands (for example: org.apache.derby.drda.NetworkServerControl sysinfo)
can only 

execute on the host where the server was started even if the server was started with the -h
option.

2) Although I have included the html pages, I noticed in the PDF document
   the tables on pages 15 and 16 (of the PDF document itself) had formatting problems.  The
text 
   came out of the table cells.

3) Page 18 of the PDF had the same problem with data coming out of the table cells.

4) Page: http://incubator.apache.org/derby/docs/adminguide/tadminapps811695.html

This sentence has a typo:

3. In order to use the encrypted user id and password during JDBC connection using the Network


Client, specify9 as the securityMechanism in the connection 

remove the '9' after the word specify

5) Page: http://incubator.apache.org/derby/docs/adminguide/radmindrdahost.html

Syntax
derby.drda.host = hostname

This should appear as:

Syntax
derby.drda.host=hostname

with no spaces between either side of the equals sign.

6) Page: http://incubator.apache.org/derby/docs/adminguide/tadminadv804410.html

Set the location of the tracing files by specifying the property: 
derby.drda.traceDirectory = <directory for tracing files>

There should not be a space between the equals sign.  It should appear like this:

derby.drda.traceDirectory=<directory for tracing files>

7) Page: http://incubator.apache.org/derby/docs/adminguide/tadminadv804451.html

The tracing files are named Server.trace

Actually, they are named ServerX.trace where X represents a connection number.

8) Page: http://incubator.apache.org/derby/docs/adminguide/cadminovnsdemo.html

The following files should be installed in the %DERBY_INSTALL%\demo\programs\nserverdemo\
directory 

in order to run the sample program: 

There is no 'programs' directory.  So this should be corrected to be:

The following files should be installed in the %DERBY_INSTALL%\demo\nserverdemo\ directory
in order 

to run the sample program: 

Also on this page:

Compiled class files: 
NsSample.class 
NsSampleClientThread.class 
NsSampleWork.class 
NetworkServerUtil.class 

I think it needs to be mentioned that these classes need to be compiled and do not come with
the installation.

9) Page: http://incubator.apache.org/derby/docs/adminguide/tadminovnsrundemo.html

Open a command prompt and change directories to the %DERBY_INSTALL%\demo\programs\ directory,
where 

%DERBY_INSTALL% is the directory where you installed Derby. 

No programs directory, so change to:

Open a command prompt and change directories to the %DERBY_INSTALL%\demo\ directory, where


%DERBY_INSTALL% is the directory where you installed Derby. 

c. derby.jar 
The Derby database engine jar file.

Test the CLASSPATH settings by running the following Java command: 
 java org.apache.derby.tools.sysinfo

The derbytools jar file must be added, otherwise the test to make sure the jars are
correct can not be run (sysinfo).  So change it to this:

c. derby.jar 
The Derby database engine jar file.

d. derbytools.jar
The derby tools jar file.

Test the CLASSPATH settings by running the following Java command: 
 java org.apache.derby.tools.sysinfo

10) Page: http://incubator.apache.org/derby/docs/adminguide/cadminovsrvsmpprgm.html

To run the sample program, the following files should be installed in the 

%DERBY_INSTALL%\demo\programs\nserverdemo\ directory: 

No programs directory.

11) Page:http://incubator.apache.org/derby/docs/adminguide/tadminovrunsrvprgm.html

Open a command prompt and change directories to the %DERBY_INSTALL%\demo\programs\nserverdemo


directory, where %DERBY_INSTALL% is the directory where you installed Derby.

No programs directory.

The derbytools.jar must be added again.  So add this text after b. derby.jar

c. derbytools.jar
The derby tools jar file.

12) Page: http://incubator.apache.org/derby/docs/adminguide/cadminovcliconnect.html

\demo\programs\nserverdemo\

No programs directory.

13) Page: http://incubator.apache.org/derby/docs/adminguide/tadminovclirun.html

Open a command prompt and change directories to the %DERBY_INSTALL%\demo\programs\nserverdemo


directory, where %DERBY_INSTALL% is the directory where you installed Derby. 

No programs directory.

Susan

> Doc review: Derby Server and Admin Guide
> ----------------------------------------
>
>          Key: DERBY-381
>          URL: http://issues.apache.org/jira/browse/DERBY-381
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>  Environment: all
>     Reporter: Jeff Levitt
>     Priority: Minor
>      Fix For: 10.1.1.0

>
> This issue tracks comments for the Derby Server and Administration Guide. The deadline
for posting comments is Tuesday, June 28, noon Pacific time.
> Some guidelines to follow when posting comments to this issue are:
> - Try to make clear and concise comments about what you want changed whenever possible.
 Provide concrete comments that say "Please change <original> to <modified>" instead
of generic comments like "This section needs to be rewritten."
> - If you're reviewing the HTML Files copy, include the URL for the page in the review
comment. Obtain the URL like this:
>     * highlight the topic in the left frame
>     * right click
>     * choose "Properties"
>     * copy and paste the address in the pop up box.
> - If you're reviewing the PDF copy, in the review comment:
>     * Include the page number for the PDF, and indicate whether the number is the PDF
sheet number or the printed page number.
>     * Include the title of the section that the problem occurs in. If it's in a subsection,
try to include the hierarchy of titles.
> - Please don't review the HTML Book copy -- it'll be time consuming to match up that
copy with the underlying DITA source.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message