Openstack Command-Line Interface Reference has a wrong description

[wuyongpeng]

On the Documentation of 《Openstack Command-Line Interface Reference》（2015-11-02） has a wrong description：

In Chapter 6 ，Containers service command-line client，the CLI ‘magnum baymodel-create’ Optional arguments（page 162）：

 -name 〈name〉 Name of the bay to create

shoud be replaced of：

-name 〈name〉 Name of the baymodel to create

[Andreas Jaeger (jaegerandi)]

This needs to be fixed in python-magnumclient, documentation team will import changes of released client automatically.

[KATO Tomoyuki (kato-tomoyuki)]

Already fixed at python-magnumclient:

http://git.openstack.org/cgit/openstack/python-magnumclient/commit/?id=8b7a740955bc946f953298d6fddaf2386d0b83bb

Please wait the next release of python-magnumclient.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Kevin Lefevre (<email address hidden>) on branch: master
Review: https://review.openstack.org/270185

[KATO Tomoyuki (kato-tomoyuki)]

Xing Chen, this is not fixed yet. The upstream change is merged. However, the new version is not released with this new strings.

[Chason Chan (chen-xing)]

Hi KATO, is not this bug fixed yet?

[KATO Tomoyuki (kato-tomoyuki)]

Can you look at the CLI reference?

http://docs.openstack.org/cli-reference/magnum.html#magnum-baymodel-create

CLI reference is auto-generated document for the specific CLI version. So, the change for the help message need 2 step fix. step 1: upstream change, i.e. python-magnumclient(already fixed). step 2: update the docs with the fixed version (not yet released, so we can't update the docs).

I strongly recommend you shouldn't change the bug status if you are uncertain.

[Chason Chan (chen-xing)]

Sorry, I just see you comment at #2， and I didn't understand the CLI reference. Thanks for your explaination!

[KATO Tomoyuki (kato-tomoyuki)]

See "Please wait the next release of python-magnumclient." at comment #2...

[Chason Chan (chen-xing)]

Yeah, I see it and I also look at the CLI reference. It has not been fixed. But I think once the python-magnumclient was fixed, the doc will be correct automaticly. And we can consider the bug as fixed , what we next to do is , as you said, to wait . So I change the bug's status. Thank you again for telling me about the CLI reference generation process.

[KATO Tomoyuki (kato-tomoyuki)]

Xing Chen, "WILL be" doesn't mean "releasED" at all. We can't consider the bug as FIXED. I advise you to learn OpenStack bug triage process...

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/300748
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=43cb93d7b8b046b990ed2da498c6e9cd9adedb1e
Submitter: Jenkins
Branch: master

commit 43cb93d7b8b046b990ed2da498c6e9cd9adedb1e
Author: KATO Tomoyuki <email address hidden>
Date: Sat Apr 2 23:54:02 2016 +0900

    [cli-ref] Update python-magnumclient to 2.0.0

    Closes-Bug: #1520193
    Change-Id: I8b90fb513233fcd926a9c740567f3ef2ee0f603b

[OpenStack Infra (hudson-openstack)]

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