Derby
  1. Derby
  2. DERBY-2845

Devguide tips on debugging deadlocks should be clearer

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.2.2.0
    • Fix Version/s: 10.6.1.0
    • Component/s: Documentation
    • Labels:
      None
    • Urgency:
      Normal

      Description

      There is a section of the Derby Developer's guide entitled "Debugging Deadlocks", see http://db.apache.org/derby/docs/dev/devguide/cdevconcepts50894.html.

      This section refers to an internal class in the Derby engine without giving more information about this class, or how you can use it:

      "Derby provides a class to help you in this situation, org.apache.derby.diag.LockTable."

      At the very least, the manual should include a direct pointer (link) to the Javadoc for that class, located at http://db.apache.org/derby/javadoc/engine/org/apache/derby/diag/LockTable.html.
      Ideally, some information should be provided, showing readers how to use this class for debugging, and/or describing how the information in the Javadoc can be utilized. Some links, hints and tips in this regard exist on the following wiki page: http://wiki.apache.org/db-derby/LockDebugging. In essence, the LockTable Javadoc contains most of the hints needed to interpret a deadlock error message or a dump of the lock table (see DERBY-2817 or the Derby wiki for examples).

      The same paragraph in the manual is rounded off with the sentence "For information, see the Derby Server and Administration Guide.". It is not at all clear to the reader what kind of information to look for in the Server and Administration Guide, if such relevant information exists. This reference should either be more specific, or removed.

      1. docs.diff
        2 kB
        Bryan Pendleton
      2. cdevconcepts50894.html
        6 kB
        Bryan Pendleton

        Issue Links

          Activity

          Gavin made changes -
          Workflow jira [ 12406600 ] Default workflow, editable Closed status [ 12797398 ]
          Kathey Marsden made changes -
          Status Resolved [ 5 ] Closed [ 6 ]
          Bryan Pendleton made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Fix Version/s 10.6.0.0 [ 12313727 ]
          Resolution Fixed [ 1 ]
          Hide
          Bryan Pendleton added a comment -

          Thanks John and Kim for the reviews. I fixed the typos that Kim noticed and
          committed the change to the docs trunk as revision 882655.

          Show
          Bryan Pendleton added a comment - Thanks John and Kim for the reviews. I fixed the typos that Kim noticed and committed the change to the docs trunk as revision 882655.
          Hide
          Kim Haase added a comment -

          This is great work, Bryan. Couple of tiny nits:

          You might change "snap shot" to "snapshot".

          You need a period at the end of the Reference Manual bullet item to match the one at the end of the other one.

          Show
          Kim Haase added a comment - This is great work, Bryan. Couple of tiny nits: You might change "snap shot" to "snapshot". You need a period at the end of the Reference Manual bullet item to match the one at the end of the other one.
          Hide
          John H. Embretsen added a comment -

          Bryan,

          Looks like your patch takes care of the requests made in this Jira issue. Thanks for working on it!

          Feel free to commit

          Show
          John H. Embretsen added a comment - Bryan, Looks like your patch takes care of the requests made in this Jira issue. Thanks for working on it! Feel free to commit
          Bryan Pendleton made changes -
          Attachment docs.diff [ 12425404 ]
          Attachment cdevconcepts50894.html [ 12425405 ]
          Hide
          Bryan Pendleton added a comment -

          I tried to take the various suggestoins for adding information to this page, and
          worked them together into a hopefully useful presentation.

          Please have a look at the attached patch proposal and the resulting HTML
          page and let me know what you think!

          Show
          Bryan Pendleton added a comment - I tried to take the various suggestoins for adding information to this page, and worked them together into a hopefully useful presentation. Please have a look at the attached patch proposal and the resulting HTML page and let me know what you think!
          Hide
          Bryan Pendleton added a comment -

          The LOCK_TABLE feature is also described at
          http://db.apache.org/derby/docs/10.5/ref/rrefsyscsdiagtables.html
          now, I believe. So we should be able to tie all this information together.

          Show
          Bryan Pendleton added a comment - The LOCK_TABLE feature is also described at http://db.apache.org/derby/docs/10.5/ref/rrefsyscsdiagtables.html now, I believe. So we should be able to tie all this information together.
          Bryan Pendleton made changes -
          Assignee Bryan Pendleton [ bryanpendleton ]
          John H. Embretsen made changes -
          Field Original Value New Value
          Link This issue is related to DERBY-2877 [ DERBY-2877 ]
          John H. Embretsen created issue -

            People

            • Assignee:
              Bryan Pendleton
              Reporter:
              John H. Embretsen
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development