Derby
  1. Derby
  2. DERBY-4134

Remove a rebundent use of derby.jar in DERBY tutorial, and add an easier way to start Network Server

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.4.1.3
    • Fix Version/s: 10.5.1.1
    • Component/s: Documentation, Web Site
    • Labels:
      None
    1. DERBY-4134-3.stat
      0.1 kB
      Yun Lee
    2. DERBY-4134-3.diff
      2 kB
      Yun Lee
    3. DERBY-4134-2.diff
      2 kB
      Yun Lee
    4. DERBY-4134-1.diff
      2 kB
      Yun Lee

      Activity

      Hide
      Yun Lee added a comment -

      That's good!

      Show
      Yun Lee added a comment - That's good!
      Hide
      John H. Embretsen added a comment -

      I committed 'DERBY-4134-3.diff' with some adjustments:

      Replaced "could actually be replaced with just one line of code" with "could actually be replaced with just one command line".

      Added a note about using derbyrun.jar in the section "Stop Network Server" as well.

      Changed the following paragraph in the "Stop Network Server" section:

      Old:

      "The window running the NetworkServer should output a 'Shutdown successful' message."

      New:

      "The window running the NetworkServer should output a message confirming the shutdown."

      This was changed because the message being output upon a successful shutdown is not "Shutdown successful" but more like:

      "Apache Derby Network Server - 10.4.1.3 - (648739) shutdown at 2009-04-20 07:51:19.982 GMT"

      Sending build/site/papers/DerbyTut/ns_intro.html
      Sending src/documentation/content/xdocs/papers/DerbyTut/ns_intro.xml
      Transmitting file data ..
      Committed revision 766613.

      The changes should be visible on the website within a couple of hours.

      Show
      John H. Embretsen added a comment - I committed ' DERBY-4134 -3.diff' with some adjustments: Replaced "could actually be replaced with just one line of code" with "could actually be replaced with just one command line". Added a note about using derbyrun.jar in the section "Stop Network Server" as well. Changed the following paragraph in the "Stop Network Server" section: Old: "The window running the NetworkServer should output a 'Shutdown successful' message." New: "The window running the NetworkServer should output a message confirming the shutdown." This was changed because the message being output upon a successful shutdown is not "Shutdown successful" but more like: "Apache Derby Network Server - 10.4.1.3 - (648739) shutdown at 2009-04-20 07:51:19.982 GMT" Sending build/site/papers/DerbyTut/ns_intro.html Sending src/documentation/content/xdocs/papers/DerbyTut/ns_intro.xml Transmitting file data .. Committed revision 766613. The changes should be visible on the website within a couple of hours.
      Hide
      Yun Lee added a comment -

      John, I have provided a new patch based on derbysite trunk. Thanks to your advice, I have touched the new tool Forrest!

      Good luck!
      Yun

      Show
      Yun Lee added a comment - John, I have provided a new patch based on derbysite trunk. Thanks to your advice, I have touched the new tool Forrest! Good luck! Yun
      Hide
      John H. Embretsen added a comment -

      Hi Yun,

      The contents of the new patch looks ok to me. However, I am not able to match the current patch (DERBY-4134-2.diff) directly with the xml source files in the website source tree. It would help a lot (in order to get your change committed) if you could create a new version of the patch using "svn diff" from the top level ("trunk" directory) of your local checkout of the website source tree.

      You can find information about checking out, editing and building the website here:
      http://db.apache.org/derby/papers/derby_web.html

      The source of http://db.apache.org/derby/papers/DerbyTut/ns_intro.html can be found in the website source tree at:
      src/documentation/content/xdocs/papers/DerbyTut/ns_intro.xml

      Show
      John H. Embretsen added a comment - Hi Yun, The contents of the new patch looks ok to me. However, I am not able to match the current patch ( DERBY-4134 -2.diff) directly with the xml source files in the website source tree. It would help a lot (in order to get your change committed) if you could create a new version of the patch using "svn diff" from the top level ("trunk" directory) of your local checkout of the website source tree. You can find information about checking out, editing and building the website here: http://db.apache.org/derby/papers/derby_web.html The source of http://db.apache.org/derby/papers/DerbyTut/ns_intro.html can be found in the website source tree at: src/documentation/content/xdocs/papers/DerbyTut/ns_intro.xml
      Hide
      Yun Lee added a comment -

      John, thanks for your valuable advice, I have applied themm all in my new patch, welcome your comments!

      Yun

      Show
      Yun Lee added a comment - John, thanks for your valuable advice, I have applied themm all in my new patch, welcome your comments! Yun
      Hide
      John H. Embretsen added a comment -

      I had a quick look at the patch (in source code format, so I did not apply the patch and check the rendered results in a web browser).
      Generally it looks good, though I'd like to see some minor changes:

      +<p class="code-block">Windows:
      +C:\Apache\db-derby-10.4.1.3-bin\bin> java -jar derbyrun.jar server start

      I do not think that command will work if your current working directory is the bin directory, as shown. When using the java -jar invocation method you need to reference the jar file directly. Something like this would work:

      +<p class="code-block">Windows:
      +C:\Apache\db-derby-10.4.1.3-bin> java -jar lib\derbyrun.jar server start

      or:

      +<p class="code-block">Windows:
      +C:\Apache\db-derby-10.4.1.3-bin\lib> java -jar derbyrun.jar server start

      Less importantly, as you are removing the entry for derby.jar in this context, maybe it would be good to let users know that they still need to have the jar file in the same location as before. This is just a suggestion, e.g. like this:

      <span class="codefrag">derbynet.jar</span>: contains the code for

      • the Derby Network Server
        + the Derby Network Server and a reference to the engine jar file (derby.jar)

      Finally, I suggest changing the header "An easier way" to "An easier way: derbyrun.jar" or something like that, which I think would be more informative. Perhaps others have a better suggestion?

      Show
      John H. Embretsen added a comment - I had a quick look at the patch (in source code format, so I did not apply the patch and check the rendered results in a web browser). Generally it looks good, though I'd like to see some minor changes: +<p class="code-block">Windows: +C:\Apache\db-derby-10.4.1.3-bin\bin> java -jar derbyrun.jar server start I do not think that command will work if your current working directory is the bin directory, as shown. When using the java -jar invocation method you need to reference the jar file directly. Something like this would work: +<p class="code-block">Windows: +C:\Apache\db-derby-10.4.1.3-bin> java -jar lib\derbyrun.jar server start or: +<p class="code-block">Windows: +C:\Apache\db-derby-10.4.1.3-bin\lib> java -jar derbyrun.jar server start Less importantly, as you are removing the entry for derby.jar in this context, maybe it would be good to let users know that they still need to have the jar file in the same location as before. This is just a suggestion, e.g. like this: <span class="codefrag">derbynet.jar</span>: contains the code for the Derby Network Server + the Derby Network Server and a reference to the engine jar file (derby.jar) Finally, I suggest changing the header "An easier way" to "An easier way: derbyrun.jar" or something like that, which I think would be more informative. Perhaps others have a better suggestion?
      Hide
      Yun Lee added a comment -

      Thre is a flaw in 'Step 4: Derby Network Server' of 'DERBY Turial'(http://db.apache.org/derby/papers/DerbyTut/ns_intro.html).
      There is a redundant inclusion on derby.jar for configuring environment to start or stop the Network Server.

      And, it's pointed out by John Embretsen that,
      'It is much easier to start the Network Server now than before (10.1?), due to various jar file improvements. With the latest releases, the
      entire sections "Configure envoronment" and "Start Network Server" at http://db.apache.org/derby/papers/DerbyTut/ns_intro.html could actually be replaced with a paragraph showing how to run
      "java -jar derbyrun.jar server start"...'

      Show
      Yun Lee added a comment - Thre is a flaw in 'Step 4: Derby Network Server' of 'DERBY Turial'( http://db.apache.org/derby/papers/DerbyTut/ns_intro.html ). There is a redundant inclusion on derby.jar for configuring environment to start or stop the Network Server. And, it's pointed out by John Embretsen that, 'It is much easier to start the Network Server now than before (10.1?), due to various jar file improvements. With the latest releases, the entire sections "Configure envoronment" and "Start Network Server" at http://db.apache.org/derby/papers/DerbyTut/ns_intro.html could actually be replaced with a paragraph showing how to run "java -jar derbyrun.jar server start"...'

        People

        • Assignee:
          Yun Lee
          Reporter:
          Yun Lee
        • Votes:
          0 Vote for this issue
          Watchers:
          1 Start watching this issue

          Dates

          • Created:
            Updated:
            Resolved:

            Development