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] Commented: (DERBY-4758) Adding documentation about the PlanExporter Tool
Date Mon, 09 Aug 2010 15:03:16 GMT

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

Kim Haase commented on DERBY-4758:

Thanks for the additional documentation, Nirmal. I'll take a look at the formatting and style
here too.

I have a couple of questions about the Using PlanExporter topic.

The syntax shows "[arguments]" in square brackets, which would normally indicate that the
arguments are optional. However, I don't see any indication of what the default behavior is
if an argument is omitted. Does the tool automatically generate some form of output with a
default name, or do you in fact have to specify one or more of the arguments described? If
you do, there should be no brackets around "arguments".

(Actually, the correct term here would be "options", not arguments, since they start with
a hyphen.)

In the argument syntax, there's currently no description of what "path" must be. I gather
you can specify an absolute or relative path, rather than just a filename in the current directory
as with the -adv -xsl option. But to judge from the example, it seems the tool appends the
".xml" or ".html" suffix to the root filename you specify. Is that true?


> Adding documentation about the PlanExporter Tool
> ------------------------------------------------
>                 Key: DERBY-4758
>                 URL: https://issues.apache.org/jira/browse/DERBY-4758
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: C.S. Nirmal J. Fernando
>            Assignee: C.S. Nirmal J. Fernando
>            Priority: Critical
>         Attachments: DERBY-4758-2.zip, DERBY-4758.zip, derby4758-2.diff, derby4758.diff
> Providing a user guide documentation in http://db.apache.org/derby/docs/10.6/tools/

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message