Hi Jane,
> We're planning to do this for GlassFish V2 FCS?
Yes, for the man pages I am definitely planning to do this for GlassFish V2 FCS.
> A bug should be filed in CLI in order to get this fixed in the usage-text
Will you file this bug, or should I?
> I will need to work with your team to make sure this "option variable"
> or the name of placeholder is consistent with the manpage synopsis and
> the usage-text. This requires some work.
One way to ensure consistency would be to fix the man pages, generate text from
the man pages and use the generated text as the basis for the command's usage-text.
> We're not changing the
> --port/--host/... options but all options that have default values.
Yes, my undesrtanding is that we should make this change for *all* options where
default values are currently given in the synopsis.
> And should we also change the true/false options as well?
For Booleans, I would suggest using {true|false} without any <replaceable>
tagging or other formatting to indicate placeholder text.
> Let's talk some more in the next admin iteam meeting.
Absolutely.
Regards,
--
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/