On 10/22/09 02:51 PM, Bill Shannon wrote:
> Dixie Pine wrote:
>> On 10/21/09 09:14 PM, Nandini Ektare wrote:
>>>
>>>>> *BUG?* 4848 and 8080 should not be in the command message, but they
>>>>> are. They should be shown as <adminport> and <instanceport>
>>>>> replaceables. I changed the man page. Can the command message be
>>>>> fixed?
>>>>>
>>>>
>>>> It's a feature. :-)
>>>>
>>>> Seriously, people asked for the usage message to indicate the default
>>>> values of the options, where they're known, so that's what the code
>>>> does.
>>>> If there's consensus that that should be removed, that's easy to do.
>>>>
>>>> Let's see what people think. I created a poll...
>>>>
>>>> http://sun.doodle.com/6t38vi48u5uyvpg4
>>>>
>>> I like the feature because
>>> 1. It's like example and usage merged together (thought it may not
>>> be a widely used practice, I feel it 's convenient)
>>> 2. More important: In v3 we can't see defaults in the usual place --
>>> domain.xml. So this feature helps to that end.
>> If we are choosing to do this (include defaults for replaceables) you
>> need to do it everywhere, which you don't. This is why users get
>> confused and think they should type 4848---because they don't see
>> this often in a command message.
>>
>> Do you all really want to redo all the messages to include default
>> values? And how would you describe this is the message?
> The default values are supplied automatically, assuming the command
> implementation has specified the correct metadata.
Yes, I'm just talking about the message. Without somehow saying this
value is a default, people apparently get confused and think they should
type it.
>
>> The defaults are listed in the man pages with the descriptions of the
>> options in the Options section, in a much more complete way than they
>> can be shown in Synopsis or in a command message.
>
> I'm fine with having the man page describe this differently than the
> usage message. The man page can include much more text, including
> text to describe the default value. The usage message is trying to
> be very concise.
>
>> While we're discussing this, the true|false presentation would be
>> better if the actual boolean were shown. First listed would be the
>> default. Users could get used to that and not think they should type
>> true.
>
> I'm not sure what you're referring to. The usage message generally
> includes
> only one of "true" or "false", depending on what the default value is.
This one is not a problem that I know of, so never mind.
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: admin-unsubscribe_at_glassfish.dev.java.net
> For additional commands, e-mail: admin-help_at_glassfish.dev.java.net
>