db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Myrna van Lunteren <m.v.lunte...@gmail.com>
Subject Re: [jira] Commented: (DERBY-296) Document error messages in the Derby Reference Manual
Date Mon, 13 Jun 2005 23:17:19 GMT
On 6/13/05, Jeff Levitt <derby@mylevita.com> wrote:

> The above two reasons provide better information to
> the user than just telling them to output it from the
> VTI, but also make it hard to run some sort of script
> to create DITA from the VTI output. While I think
> that would be very helpful indeed (and much faster),
> we would still have to go back each time and add the
> message details and user responses, as well as the
> substituted parameter values.
> However, if there is indeed a way to print out the
> messages from the VTI, I think if a user just wants to
> do that instead of looking at the docs, and the
> command is available to them, then there should be
> instructions on how to do that in the docs. If
> someone wants to open a JIRA issue to do that, I'd be
> happy to take on that task. I'd appreciate it if you
> could provide the command to do it, as well as a
> suggestion of which book and which part of that book
> to place it, as that will make creating the pacth much
> easier, and more likely to make it in 10.1.
 I had said the engine javadoc describe the vti, and it's true (
org.apache.derby.diag.ErrorMessages) but the javadoc is out of date...
 The way to get it to work currently I found in the tests (
you do: (in ij:)
 select * from new org.apache.derby.diag.ErrorMessages() c
and that dumps out all messages.
To get just one particular message, you'd do:
 select * from new org.apache.derby.diag.ErrorMessages() c where 
 I am wondering though, is it ok to document this? 
It's very non-standard way of doing things...
 At the same time, to recreate your doc with additional comments, it must be 
possible to write a program that uses the ErrorMessages vti in combination 
with an extra file(/extra files) & attaches the extra hints for each 
errormessage...And build the error message doc up that way. So you'd miss a 
manual step to keep error messages and debugging hints in sync.

View raw message