35 Commits

Author SHA1 Message Date
Andreas Jaeger
20139677b3 Document cinderclient v2 as well
Document cinder v2 commands as well.

Partial-Bug: #1369149
Change-Id: I9ba1c4d47dcb71bfb003779c5bc765ba6348d9c8
2014-09-13 21:53:42 +02:00
Jenkins
a04938cc6b Merge "Document glance v2 commands" 2014-09-11 20:28:55 +00:00
Andreas Jaeger
a2824e109c Document glance v2 commands
The glance v2 commands need to be called as:
glance -os-image-api-version 2 CMD

Implement logic for this and enhance output.
Closes-Bug: #1367430

Change-Id: Ibc81d49494a203c9c8f469a2a0f93e4c1786af7e
2014-09-10 22:17:26 +02:00
Jenkins
eafed8d5f8 Merge "Generate subcommands for python-openstackclient" 2014-09-10 08:53:00 +00:00
Jenkins
84dece8339 Merge "commands: add 'openstack' to the list of clients" 2014-09-10 00:49:13 +00:00
Jenkins
cb88cbf185 Merge "Use ironic's bash-completion for CLI commands" 2014-09-09 22:18:55 +00:00
Christian Berendt
9695dd8cfb Generate subcommands for python-openstackclient
Change-Id: I9fc1193871b573bf41b1995236ca8908ccb3ff6b
2014-09-10 00:09:43 +02:00
Christian Berendt
e94f522ada commands: add 'openstack' to the list of clients
Change-Id: Id0dc99c4e3a0c6713fd93be364900074637b08e0
2014-09-09 23:27:34 +02:00
Christian Berendt
cdde3005f5 Improve output of CLI documentation
* highlight client version (<literal>VERSION</literal>)
* use "ceilometer meter-list" instead of "ceilometer meter-list command"
  as title for subcommands

Change-Id: I4ef841df4122af25eab7c7efae97a1ef87d39057
2014-09-09 21:33:02 +02:00
Ruby Loo
799ac5a333 Use ironic's bash-completion for CLI commands
This removes the list of ironic subcommands. Ironic now has a bash-completion
subcommand, and that will be used instead, to generate the list of subcommands.

Change-Id: I5adcbc8f755f6031ddc122205203ccfcedcf7a15
Closes-Bug: #1367333
2014-09-09 15:38:25 +00:00
Andreas Jaeger
d2d93f7273 Document openstack client
Handle openstack client command.

Change-Id: I1c55eaf7619d07c0bc07e6ef3328bb10c24e9079
2014-09-06 18:25:40 +02:00
Andreas Jaeger
84e60e943c Add API for sahara description
Change-Id: If42f188550c9e9e205cfd149975237c28521ae1b
2014-07-19 17:20:33 +02:00
Peter Stachowski
de741f0a2e 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
2014-07-15 11:01:05 -04:00
Jenkins
c5418eac95 Merge "Rewrite return statement in method use_help_flag" 2014-07-12 12:37:06 +00:00
Christian Berendt
100263e3ea Rewrite return statement in method use_help_flag
Change-Id: I8deffced2c9e8a8590d71a8df4151f5e67d00257
2014-07-10 13:40:38 +02:00
Andreas Jaeger
ef07792647 Update XML root elements
Write our root elements in a consistent way.

Change-Id: I3f74cc7fd0346c44b2cf445bb4f8638af4c70e4b
2014-07-10 08:39:55 +02:00
Peter Stachowski
7461b48006 Added support for *-manage CLI doc generation
Support for the *-manage commands was added to commands.py. Two new
options were added as well, --all-api and --all-manage.

--all-api generates files for all API commands
--all-manage generates files for all manage commands

--all generates files for all commands, API and manage

At present, only trove-manage is supported for *-manage commands.

As an aside, the Swift CLI help command is different from most other
CLI help, and as it is the same as the *-manage help it was changed to
use the same help syntax.

Change-Id: I851f39a405f91216257a5965a6ce5c01d1889851
Closes-Bug: #1338806
2014-07-06 22:42:43 -04:00
Jenkins
ae361e26cd Merge "Improve help text for commands.py" 2014-06-06 08:44:39 +00:00
Roger Luethi
7b84699884 commands.py: handle missing command
The current code aborts with a traceback if the command meant to be
documented is missing. This patch makes the program handle that case
more gracefully.

Change-Id: Id767bcf5731339d219b6b05af27fbe7722881591
2014-06-06 10:29:00 +02:00
Roger Luethi
82a7e0e6c6 Improve help text for commands.py
If no arguments are given, print the whole help text. Since the list of
supported commands is hard-coded, provide that list in the help text.

Change-Id: Icc6a606b435b02cec151cb606e4ef94754b1c53d
2014-06-06 10:26:53 +02:00
Andreas Jaeger
6b27ac7092 Fix some more pylint warnings
Fix some more warnings from pylint.

Move check_output into common.py and use this instead of local copy.

Change-Id: Ifc2079e8d4302d313cfe438d11e4601482637764
2014-05-19 18:22:25 +02:00
Jenkins
4fb4906e9e Merge "fixed several pep8 issues" 2014-05-18 13:50:11 +00:00
Andreas Jaeger
ff2a921194 Remove some pylint warnings
Remove some warnings noticed by pylint.

There're still a lot of warnings, this is just an iterative improvement.

Change-Id: Iafecf55176f230b91353ecd5b5014ba749056f89
2014-05-18 15:25:56 +02:00
Christian Berendt
dfa10c5c5d fixed several pep8 issues
* E129 visually indented line with same indent as next logical line
  * E129 visually indented line with same indent as next logical line
  * E265 block comment should start with '# '
  * E713 test for membership should be 'not in'

Change-Id: I8488f7ad4399153d99325806fe87919c0b4cda7e
2014-05-17 08:37:07 +02:00
Andreas Jaeger
8bf05b2267 auto-commands: Improve swift display
Remove Usage: from paragraph and add separate line with the command.

Change-Id: I24bdf4fa7226978cdaa000803b238ffe701abfc4
2014-05-01 08:56:53 +02:00
Andreas Jaeger
b42cf18bab Place </screen> on proper line, fix swift usage
Change way on how the screens are generated so that we really
have </screen> on the closing line.

Also, update swift usage line so that it is not inside a screen but in a
normal para.

Add new option --output-directory for defining the directory where the
files will be written to.

Change-Id: Ie5d039ad673290720993586bd137c51183afa822
2014-04-29 19:29:52 +02:00
Andreas Jaeger
df0fe3061e Update Service spelling for commands
It's Identity service and Database Service.

Also, update latest sahara version.

Change-Id: I8ebc3af68133504260c1b478905227047bc84b86
2014-03-30 19:50:54 +02:00
Jenkins
cfab9601aa Merge "Handle CLI commands for ironic and sahara" 2014-03-13 10:34:26 +00:00
Gauvain Pocentek
dcad89865b Fix generation of command usage (--help)
Show the first line of the usage but not
the explanations about the client.

Change-Id: I4a376fc4b75723f1969d772762c57f372bb79302
2014-03-08 18:27:03 +01:00
Andreas Jaeger
2c1364e675 Handle CLI commands for ironic and sahara
Add handling of ironic and sahara. Since these are still in incubation,
do not run by default.

Change-Id: I413e286a454b859ddf520d8ae966ea4b8d563f9d
2014-03-08 10:28:02 +01:00
Andreas Jaeger
1083e40d21 Add client version number
Output the version number of the client package in the generated
docbook.

Change-Id: I2644348952d1e119920aaabbad00c5dcdc317059
2014-03-05 22:12:17 +01:00
Andreas Jaeger
33be17b7ef Improve cli output
Implement some suggestions from Summer (see
https://review.openstack.org/#/c/73476)
and enhance.

Fix parsing of options, shown in output of "cinder --metadata".

Change-Id: I3a330dbdad0439c2785d6da141eadc63c550848e
2014-02-17 08:06:40 +01:00
Andreas Jaeger
e2fdb79996 Generate chapters instead of sections for commands
Since these sections are not needed for the appendices anymore, we
can use chapters for the command reference. This patch changes
the tool to write chapters.

Change-Id: Ibbb2334120bc40b1c147432c9a089186c484a4fa
2014-01-31 20:54:10 +01:00
Andreas Jaeger
0863f76f20 Improve docbook format for cli commands
Thanks to Diane for a great proposal!

Also fixes autogenerate_config_docs/common.py to pass pep8 check.

Closes-Bug: #1274699
Change-Id: Ic7b9cacc99a8bdf39c7a0f7e429d9f538370f048
2014-01-31 19:48:09 +01:00
Andreas Jaeger
c586091172 Add tool to document cli tools
Call "os_doc_tools/commands.py" nova to generate a file
section_cli_nova_commands.xml with the command line options.

Allows generation of all supported clients with --all command.
The tool gets installed as: openstack-auto-commands

blueprint os-user-doc
Change-Id: Ie4b200818bd585d3fce0b27f0639ad03069b3b7b
2014-01-22 20:52:56 +01:00