[openstack-doc-tools] openstack-auto-commands should strip off trailing whitespace

[Peter Stachowski]

Some of the output help from *-manage CLIs (eg. trove-manage) have white-space at the end of the line. This causes the gate-openstack-manuals-tox-checkniceness test to fail on the generated .xml files.

Any trailing white-space should be stripped off by the tool before writing the .xml file.

[OpenStack Infra (hudson-openstack)]

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

[Andreas Jaeger (jaegerandi)]

IMO we should patch also the code projects that produce extra whitespace, could you send a patch to trove as well, please?

[Peter Stachowski (peterstac)]

I will do that

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/107520
Committed: https://git.openstack.org/cgit/openstack/openstack-doc-tools/commit/?id=de741f0a2e9beb4aad90cd1d599177b47e658732
Submitter: Jenkins
Branch: master

commit de741f0a2e9beb4aad90cd1d599177b47e658732
Author: Peter Stachowski <email address hidden>
Date: Tue Jul 15 10:23:17 2014 -0400

    Removed trailing whitespace from help output

    Some of the output help from *-manage CLIs (eg. trove-manage) have
    whitespace at the end of the line.
    This causes the gate-openstack-manuals-tox-checkniceness test to fail
    on the generated .xml files.

    Trailing white-space is now stripped off by the tool before writing the
    .xml file.

    Change-Id: I94aa3a02f7bbe2e88beb510551a2aff76ed24f8a
    Closes-Bug: #1342988

[Peter Stachowski (peterstac)]

I debugged through the print help routine and it turns out it's a bug in argparse.py module of the python libraries. If the next 'part' of the help is longer than the line length and the current line is empty, it'll print out the indent with the empty line. I'll try and see what the best work around is (and submit a bug to python)

[Peter Stachowski (peterstac)]

The bug only exists in python 2.7 - looks like it's been fixed in 3.4 already, so it'll eventually go away. I'll look at patching it from our side, but it might not be worth the effort.

[Peter Stachowski (peterstac)]

One more clarification - it's fixed in python 2.7.8 (but not in 2.7.3, which is the version I'm using). Since it will shortly be irrelevant, I'm not going to pursue it further (unless other feel strongly about it).