yahoo-eng-team team mailing list archive

[Reedip <reedip.banerjee@xxxxxxxxxxxxxxxxxx>]

Public bug reported:

Openstack CLIs have the support of displaying help file for all components, specifically neutron.
However, for a new user/developer, understanding the help file is important.

When we pass incorrect attributes to a nova client, we get the following output:
##########################
reedip@reedip-VirtualBox:/opt/stack/sqlalchemy$ nova agent-delete
usage: nova agent-delete <id>
error: too few arguments
Try 'nova help agent-delete' for more information.
##########################

The last line gives a useful information to the new user/developer as to what he/she can do to find out more information.
Something like this can be added to the neutron-client as well

Current output of neutron client:
##########################
reedip@reedip-VirtualBox:/opt/stack/sqlalchemy$ neutron firewall-create
usage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--prefix PREFIX] [--request-format {json,xml}]
                               [--tenant-id TENANT_ID] [--name NAME]
                               [--description DESCRIPTION] [--shared]
                               [--admin-state-down] [--router ROUTER]
                               POLICY
neutron firewall-create: error: too few arguments
##########################

Expected output:
##########################
reedip@reedip-VirtualBox:/opt/stack/sqlalchemy$ neutron firewall-create
usage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--prefix PREFIX] [--request-format {json,xml}]
                               [--tenant-id TENANT_ID] [--name NAME]
                               [--description DESCRIPTION] [--shared]
                               [--admin-state-down] [--router ROUTER]
                               POLICY
neutron firewall-create: error: too few arguments
Try 'neutron help firewall-delete' for more information.
##########################

** Affects: neutron
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1495742

Title:
  [Neutron][Improvement]Neutron can ask user to see the help file in
  case the user passes wrong arguments in CLI

Status in neutron:
  New

Bug description:
  Openstack CLIs have the support of displaying help file for all components, specifically neutron.
  However, for a new user/developer, understanding the help file is important.

  When we pass incorrect attributes to a nova client, we get the following output:
  ##########################
  reedip@reedip-VirtualBox:/opt/stack/sqlalchemy$ nova agent-delete
  usage: nova agent-delete <id>
  error: too few arguments
  Try 'nova help agent-delete' for more information.
  ##########################

  The last line gives a useful information to the new user/developer as to what he/she can do to find out more information.
  Something like this can be added to the neutron-client as well

  Current output of neutron client:
  ##########################
  reedip@reedip-VirtualBox:/opt/stack/sqlalchemy$ neutron firewall-create
  usage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--prefix PREFIX] [--request-format {json,xml}]
                                 [--tenant-id TENANT_ID] [--name NAME]
                                 [--description DESCRIPTION] [--shared]
                                 [--admin-state-down] [--router ROUTER]
                                 POLICY
  neutron firewall-create: error: too few arguments
  ##########################

  Expected output:
  ##########################
  reedip@reedip-VirtualBox:/opt/stack/sqlalchemy$ neutron firewall-create
  usage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--prefix PREFIX] [--request-format {json,xml}]
                                 [--tenant-id TENANT_ID] [--name NAME]
                                 [--description DESCRIPTION] [--shared]
                                 [--admin-state-down] [--router ROUTER]
                                 POLICY
  neutron firewall-create: error: too few arguments
  Try 'neutron help firewall-delete' for more information.
  ##########################

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1495742/+subscriptions