db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-6065) LockTable API link in the documentation is broken
Date Wed, 06 Feb 2013 14:05:13 GMT

    [ https://issues.apache.org/jira/browse/DERBY-6065?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13572416#comment-13572416
] 

Rick Hillegas commented on DERBY-6065:
--------------------------------------

Thinking more about this, I wonder why the Developer's Guide needs to link to the LockTable
javadoc at all. It seems to me that the only reason to consult that javadoc is because the
Reference Manual does not describe this diagnostic vti in sufficient detail. The Reference
Manual does bother to document SPACE_TABLE in greater detail, telling the user what the returned
columns mean. Instead of adding these diagnostic vtis to the public api, it might make more
sense to beef up the descriptions in the "SYSCS_DIAG diagnostic tables and functions" section
of the Reference  Manual.

Beefing up the description of LOCK_TABLE would just involve copying the header information
from LockTable into the Reference Manual. The other, under-documented vtis could be handled
similarly.
                
> LockTable API link in the documentation is broken
> -------------------------------------------------
>
>                 Key: DERBY-6065
>                 URL: https://issues.apache.org/jira/browse/DERBY-6065
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.9.1.0
>            Reporter: Bryan Pendleton
>            Assignee: Kim Haase
>            Priority: Minor
>
> I happened to notice that some of the links in the documentation are broken.
> For example, on http://db.apache.org/derby/docs/10.9/devguide/cdevconcepts50894.html
> the link to LockTable API documentation is broken.
> There are also broken links to the documentation in the wiki, but that's not something
we track with JIRA issues, I think. But it would be nice to figure out if we can clean up
those links easily. For example, on  http://wiki.apache.org/db-derby/LockDebugging there are
broken links to the LockTable API documentation, as well as to the SYSCS_DIAG table documentation.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message