admin@glassfish.java.net

Re: Command name inconsistencies

From: Paul Davies <Paul-Martin.Davies_at_Sun.COM>
Date: Fri, 07 Aug 2009 15:41:12 -0700

Hi Kedar,

As these commands are being developed under the auspices of the
GlassFish project, would it not be possible to contact the module
owners, who must be known to us, to suggest that the command names be
consistent?

I realize that we do not have control over arbitrary 3rd-party modules,
but we do provide guidelines <http://docs.sun.com/doc/820-7727/ghrpm> to
ensure consistency. In the interest of setting a good example to
contributors to the GlassFish project and owners of arbitrary 3rd-party
modules, should we try to follow our own conventions?

Regards,
-Paul



On 08/07/09 15:21, Kedar Mhaswade wrote:
> I appreciate your efforts, but in a modular server, that's going to
> result -- the inconsistency in command names because we don't have
> control over how modules write/name their commands.
>
> Yes, but we should do the best practices for naming.
>
> Paul Davies wrote:
>> Hi,
>>
>> While looking at the new asadmin commands in build 58, I noticed a
>> couple of commands the names of which appear not to follow the
>> established conventions for asadmin command names:
>>
>> * jruby-container-config
>> * setup-ldap-for-admin
>
>>
>> I was wondering if, for the sake of consistency and ease of use, the
>> names these commands should be change. If so, I would suggest the
>> following names:
>>
>> * configure-jruby-container
>> * configure-ldap-for-admin
>
> I wrote this new command which I am going to document extensively and
> yes,
> I can rename it per your suggestion. As my commit log says, this command
> is still experimental, very close to being inducted in the hall of
> fame ;)
>
> Thanks.
>
> -Kedar
>
>>
>> Regards,
>>
>> --
>> Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
>> http://blogs.sun.com/techscribe/
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: admin-unsubscribe_at_glassfish.dev.java.net
> For additional commands, e-mail: admin-help_at_glassfish.dev.java.net
>

-- 
Paul Davies, Senior Technical Writer, Sun Microsystems, Inc.
http://blogs.sun.com/techscribe/