Hi Paul,
Looks good. Here are my comments:
"configure-jruby-container– configures the Enterprise Server JRuby
container"
- There should be a space after configure-jruby-container and between
dash(-).
- Why are you calling 'Enterprise Server' instead of GlassFish?
*--jruby-home*
"The directory where the JRuby runtime interpreter is installed." Should
be "The directory where the JRuby is installed."
I think "However, the subcommand does not check for a JRuby runtime
interpreter in the directory." can be removed, it makes it confusing.
Isn't saying path to jruby installation is good enough.
*--jruby-runtime*
"To prevent runtime errors, this number must be greater than zero, at
least the number that
is specified by the --jruby-runtime-min option, and must not exceed the
number that is
specified by the --jruby-runtime-max option. The subcommand does not
check that these
conditions are met."
Should be
"Must be > 0 and >= --jruby-runtime-min and <= --jruby-runtime-max."
IMO, too many words make it more confusing. This way its clear as to
what is expected.
And the command should check the range and throw errors. If its not
doing so then its a bug.
*--jruby-runtime-min*
"To prevent runtime errors, this number must be greater than zero, and
must not exceed the
number that is specified by the --jruby-runtime option or the
--jruby-runtime-max
option. The subcommand does not check that these conditions are met."
just like --jruby-runtime, it can be concise:
"Must be > 0 and <= --jruby-runtime and <= --jruby-runtime-max.
*--jruby-runtime-max*
"To prevent runtime errors, this number must be greater than zero, and
at least the number
that is specified by the --jruby-runtime option or the
--jruby-runtime-min option. The
subcommand does not check that these conditions are met."
should be
"Must be > 0 and >= --jruby-runtime and >= --jruby-runtime-min."
I see there is short form mentioned with all of these commands. This is
not implemented or not planned to be implemented so wondering why you
have it in man pages?
*--show*
"Specifies whether the current settings of the Enterprise Server JRuby
container are
displayed."
Why you have "Enterprise Server" instead of "GlassFish"?
Perhaps this is much easier to read: "Displays current setting of
GlassFish JRuby container."
-vivek.
Paul Davies wrote:
> Hi,
>
> Please review the attached draft of the configure-jruby-container man
> page.
>
> To ensure that I can process your feeback in time for GlassFish v3
> hard code freeze, please give me your feedback no later than end of
> day next Wednesday, October 7th, 2009.
>
> Thank you.
>