db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (DERBY-5758) System procedures in Reference Manual should be alphabetized
Date Fri, 18 May 2012 20:29:06 GMT

     [ https://issues.apache.org/jira/browse/DERBY-5758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Kim Haase updated DERBY-5758:
-----------------------------

    Attachment: DERBY-5758.diff

Attaching DERBY-5758.diff, which changes the order of system procedures in the refderby.ditamap
file and adds relationship table entries so that the HTML frame output files will have links
to related topics. 

I'm including only the map file rather than including a zip of all the HTML output files that
show the results of the relationship tables. Instead, I'll mention that the following system
procedures don't seem to be related to any others -- are they? Are they related to other reference
topics in some way?

SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE 
SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE 
SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE 
SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY 

You can build the manual or study the patch to see if the cross-references seem valid. Thanks!

I'll commit the patch early next week unless I hear that further changes would be helpful.
                
> System procedures in Reference Manual should be alphabetized
> ------------------------------------------------------------
>
>                 Key: DERBY-5758
>                 URL: https://issues.apache.org/jira/browse/DERBY-5758
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.9.0.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-5758.diff
>
>
> The system procedure topics in the Reference Manual are currently organized partly alphabetically
and partly by subject. The number of system procedures has increased to the point where this
organization is probably confusing for readers. The procedure topics should be alphabetized,
and the relationship table in the map file should be used to provide links among related procedure
topics.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message