dev@glassfish.java.net

Re: schema documentation command integration

From: Timothy Quinn <tim.quinn_at_oracle.com>
Date: Wed, 17 Mar 2010 10:42:43 -0500

Hi, Justin.

Two mild concerns.

One is whether the command could be more specific as to just what type
of documentation it is producing. Create-documentation seems really
broad to me.

Another is maybe subtle but worth thinking about, I think. I think
this would be the first "create" command that does not update the
config itself as recorded in domain.xml (or, with create-domain,
actually products a brand new domain.xml). That is, every other
"create" command creates something that is used during the execution
of the app server...a domain, a JDCB connection, etc. There is also a
parallel delete command for each of those.

In contrast, this command produces something that's certainly useful
but does not alter the configuration of the domain and for which there
is no delete counterpart.

So is this really a "describe-config" or "describe-metadata" or
"describe-config-metadata" command? Again, I'm not sure any of those
is the right alternative command name, but I think you see what I'm
getting at.

- Tim

On Mar 17, 2010, at 8:41 AM, Justin Lee wrote:

> No complaints, then?
>
> -------- Original Message --------
> Subject: schema documentation command integration
> Date: Mon, 15 Mar 2010 13:00:08 -0400
> From: Justin Lee <justin.d.lee_at_oracle.com>
> To: dev_at_glassfish.dev.java.net
>
> Attached is the patch to integrate my command for generating some
> documenation on the schema. Fairly straightforward "svn add" but
> there
> are changes to the pom.xml and osgi.bundle that warrant a closer
> review. Also I believe this has been requested for inclusion in 3.0.1
> so I've opened bug
> https://glassfish.dev.java.net/issues/show_bug.cgi?id=11682 to follow
> that. Do the pom/osgi changes look ok?
>
> <schema-
> doc_command_integration
> .patch
> >---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net