openstack team mailing list archive

[Hua ZZ Zhang <zhuadl@xxxxxxxxxx>]

Dean,

thank you for clarifying this. good to know we have some perspective of how
to resolve this issue.
Since Openstack community grow very fast, more and more projects and people
are involved. As one big community, developers from different projects need
to see an uniform hacking rules and best practice when they're moving
forward so fast. If the consensus should be reached as earlier as possible,
a lot of efforts of maitaining compatibility, document and fix can be saved
in the future.

Best Regards,

                                                                             
 Edward Zhang(张华)                    地址:北京市海淀区东北旺西路8号 中关村 
 Staff Software Engineer               软件园28号楼 环宇大厦3层 邮编：100193 
 Travel&Transportation Standards       Address: 3F Ring, Building 28         
 Emerging Technology Institute(ETI)    Zhongguancun Software Park, 8         
 IBM China Software Development Lab    Dongbeiwang West Road, Haidian        
 e-mail: zhuadl@xxxxxxxxxx             District, Beijing, P.R.C.100193       
 Notes ID: Hua ZZ Zhang/China/IBM                                            
 Tel: 86-10-82450483                                                         
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             
                                                                             





                                                                           
             Dean Troyer                                                   
             <dtroyer@xxxxxxxx                                             
             m>                                                         To 
                                       Hua ZZ Zhang/China/IBM@IBMCN        
             2012-07-20 00:27                                           cc 
                                       openstack@xxxxxxxxxxxxxxxxxxx       
                                                                   Subject 
                                       Re: [Openstack] Command Argument    
                                       Naming Style                        
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           
                                                                           




On Thu, Jul 19, 2012 at 4:36 AM, Hua ZZ Zhang <zhuadl@xxxxxxxxxx> wrote:
  I found an interesting thing about the naming style of current command
  arguments. it is a little difference across different components.
  you can see nova/quantum/swift/keystone are using both dash '-' and
  underline '_'. Only keystone is mixed with two style:  --xx_yyy_zzz
  --xx-yyy-zzz
  And glance use the --xx-yyy-zzz style which only contains dash '-'. IMO,
  it's better to be consisitent in naming style for all core components,
  including the usage text. secondly, avoid using same argument name with
  different meanings or different argument name for the same meaning.
  Thirdly, keep it simple as possible, don't use unnecessary symbols.



We strive for consistency and unfortunately we are still not there yet.
The goal is to use '-' in option names everywhere but we also have backward
compatibility to consider.  Glance and keystone are the two that I've
managed to complete so far, the others are on my list and I haven't gotten
there yet.

The goal is to add the options containing '-' and document those while
maintaining the options containing '_' for compatibility and documenting
them as deprecated, if at all, and to be removed sometime in the future (>6
months at least).

FWIW, glance will never have the '_' option names because it is a new
client and already breaks backward compatibility with the original glance
client.

dt

--

Dean Troyer
dtroyer@xxxxxxxxx