No manuals for neutron list commands in CLI Reference

[Bathri Ajay Raj]

There is no manual for a number of neutron list command in the CLI Reference document.

URL: http://docs.openstack.org/cli-reference/neutron.html

List of commands that do not have any manual :

address-scope-list
agent-list
availability-zone-list
ext-list
firewall-list
firewall-policy-list
firewall-rule-list
flavor-list
flavor-profile-list
floatingip-list
gateway-device-list
ipsec-site-connection-list
lb-healthmonitor-list
lb-member-list
lb-pool-list
lb-vip-list
lbaas-healthmonitor-list
lbaas-listener-list
lbaas-loadbalancer-list
lbaas-pool-list
meter-label-list
meter-label-rule-list
net-external-list
net-gateway-list
net-list
port-list
qos-policy-list
queue-list
quota-list
rbac-list
router-list
security-group-rule-list
service-provider-list
subnet-list
subnetpool-list
vpn-endpoint-group-list
vpn-ikepolicy-list
vpn-ipsecpolicy-list
vpn-service-list

[Andreas Jaeger (jaegerandi)]

If you run our tools:

openstack-auto-commands neutron
OpenStack Auto Documenting of Commands (using openstack-doc-tools version 0.31.1)

Documenting 'neutron'
Documenting 'neutron help (version 4.0.0)'
Discovering subcommands of 'neutron' None ...
218 subcommands discovered.
Documenting subcommand 'address-scope-create'...
Documenting subcommand 'address-scope-delete'...
Documenting subcommand 'address-scope-list'...
Subcommand 'address-scope-list' is deprecated, skipping.
Documenting subcommand 'address-scope-show'...
Documenting subcommand 'address-scope-update'...
Documenting subcommand 'agent-delete'...
Documenting subcommand 'agent-list'...
Subcommand 'agent-list' is deprecated, skipping.

The error here is that the check for deprecation is wrong, see:

neutron help address-scope-list:

  --request-format {json}
                        DEPRECATED! Only JSON request format is supported.
  -D, --show-details Show detailed information.

Only the one option is deprecated, not the complete entry.

To fix this, update openstack-doc-tools/os_doc/commands.py and regenerate neutron.rst in openstack-manuals.

[Andreas Jaeger (jaegerandi)]

Correction: os_doc_tools/commands.py in openstack-doc-tools

[KATO Tomoyuki (kato-tomoyuki)]

Bathri, are you still working on this bug?

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/306827
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=34e4b80ad2f2e47182803fec9867394c3168e86d
Submitter: Jenkins
Branch: master

commit 34e4b80ad2f2e47182803fec9867394c3168e86d
Author: KATO Tomoyuki <email address hidden>
Date: Sun Apr 17 22:21:36 2016 +0900

    [cli-ref] Update python-neutronclient to 4.2.0

    with improperly skipped subcommands

    Closes-Bug: #1552158
    Closes-Bug: #1551675
    Change-Id: I51d6d318b0e31c2351b2b5496e3c9ad8d29a9e8c

[Doug Hellmann (doug-hellmann)]

This issue was fixed in the openstack/openstack-doc-tools 1.0.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.