help texts are inconsistent in VPN related commands

Bug #1335160 reported by Andreas Jaeger
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-neutronclient
Fix Released
Low
linwei,wu

Bug Description

$ neutron help vpn-ipsecpolicy-delete
usage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json,xml}]
                                      IPSECPOLICY

Delete a given IPsec policy.

positional arguments:
  IPSECPOLICY ID or name of ipsecpolicy to delete.

The last line should be instead:
  IPSECPOLICY ID or name of IPsec policy to delete.

So, it should be everywhere "IPsec policy" and not "ipsecpolicy"

This is a problem with all of the delete commands for resources.

Changed in python-neutronclient:
assignee: nobody → Amit Prakash Pandey (amitpp23)
Changed in python-neutronclient:
status: New → Confirmed
Revision history for this message
Amit Prakash Pandey (amitpp23) wrote :

I have confirmed it as I think it should reflect the change as suggested. I have found similar improvements for IKE Policy and vShield too.

Revision history for this message
Amit Prakash Pandey (amitpp23) wrote :

Please suggest further improvements in other keywords too if you find some more. As of now I will be updating these 3 keywords mentioned above.

Revision history for this message
Amit Prakash Pandey (amitpp23) wrote :

Any suggestion for more files where these errors occur is also welcome , as of now I am looking at files in neutron.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-neutronclient (master)

Fix proposed to branch: master
Review: https://review.openstack.org/105718

Changed in python-neutronclient:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on python-neutronclient (master)

Change abandoned by Kyle Mestery (<email address hidden>) on branch: master
Review: https://review.openstack.org/105718
Reason: This change is old enough and hasn't seen any updates since July 9, 2014. Abandoning it, please revive it if you plan to work on it again.

Akihiro Motoki (amotoki)
summary: - help texts are inconsistent
+ help texts are inconsistent in VPN related commands
Changed in python-neutronclient:
assignee: Amit Prakash Pandey (amitpp23) → nobody
status: In Progress → Confirmed
Akihiro Motoki (amotoki)
Changed in python-neutronclient:
importance: Undecided → Low
linwei,wu (wlwwu)
Changed in python-neutronclient:
assignee: nobody → linwei,wu (wlwwu)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-neutronclient (master)

Fix proposed to branch: master
Review: https://review.openstack.org/266463

Changed in python-neutronclient:
status: Confirmed → In Progress
Revision history for this message
Akihiro Motoki (amotoki) wrote :

I think cleaner way is to define some new attribute like 'display_resource_name' and refer to it in neutronclient/neutron/v2_0/__init__.py when generating help messages.

Revision history for this message
linwei,wu (wlwwu) wrote :

if we define another display_resource_name, does it conflict with get_parser function defined in delete command?

my way is that we inherit Deletecommand class and use get_parser to display our help information. We can define our own private get_parser function and then change what we should display in this function. other functions still inherit from father class.

is that okay?

Revision history for this message
Reedip (reedip-banerjee-deactivatedaccount) wrote :

Dear linwei.,wu ,
No it will not conlfict with the get_parser function.
Please see my comment in the main patch...

Revision history for this message
linwei,wu (wlwwu) wrote :

thanks. I see your comment. I will deliver a new patch then...

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-neutronclient (master)

Reviewed: https://review.openstack.org/266463
Committed: https://git.openstack.org/cgit/openstack/python-neutronclient/commit/?id=c2545f869a65564d5ff231ff453272c6a3310d6c
Submitter: Jenkins
Branch: master

commit c2545f869a65564d5ff231ff453272c6a3310d6c
Author: linwwu <email address hidden>
Date: Wed Jan 13 08:22:05 2016 +0800

    Remove inconsistency from vpn help text

    Improve help text for IKEPOLICY VPNSERVICE IPSECPOLICY
    IPSECSITECONNECTION
    in python-neutronclient
    Fixes bug #1335160

    Change-Id: I5da7efe8f8c8e6494884571b3d70237782cd314f
    Closes-bug: #1335160

Changed in python-neutronclient:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.