The help strings for configuration option are text strings,
not a code item. So, they are not necessary.
Also, it breaks literal markups within the help strings.
Change-Id: I4b9279d5f49a03137d9c1369622fde1ed2df684e
Partial-Bug: #1585927
Sync install guide translation build tool with the
changes I8df6b3b382137d08d60f85bc41bcd98ac1f4eb47
and Iffced3907ac2fddd42e6adc56b6e4859fde8e987.
Change-Id: Ie3d20ab930738925f2daacd4cd305b4ad8ec1798
Since we finished common directory migration from common-rst
to common, this patch removes common directory switcher, that
is merged at the change I7ba517136807513f982e66010906b97621f844fc,
to migrate common directory for rst files from common-rst to common.
Change-Id: I40aac8ec2d497d83b41048b2576a3a0ab04c8a93
This is very much a hack, but its really just to see if it is possible
to convert the bullet lists into text that renders correctly with rst.
This was tested with the nova-hyperv.rst:
f0607509e3/doc/config-reference/source/tables/nova-hyperv.rst
Change-Id: Iab063774f6732d52cd8e79f82ff0fc93bd6d306b
openstack-doc-test is used for building of DocBook XML files. For index
page generation openstack-indexpage can be used.
Remove openstack-doc-test together with all support files.
Change-Id: I5589bc634e1f630f79b3d6e8bffee939c5300bf2
We removed the Vagrantfile in the past, it is safe to remove the entries
from the .gitignore file.
Change-Id: I870afd33d8dd72bd19b9d59b5ce540bcbf551c27
The DocBook XML glossary is gone, remove the special support in our
tools for it.
implements bp docbook-removal
Change-Id: Ida2bb926718ae7e03ac2ded120cea99c80147857
Companies may have VPN, and in China, there is a firewall named
G.F.W., they both may block some protocols or ports, so if I run
autohelp-wrapper, it will fail like this:
/opt/stack/openstack-doc-tools/autogenerate_config_docs$ ./autohelp-wrapper update ceilometer
Cloning into '/opt/stack/openstack-doc-tools/autogenerate_config_docs/sources/openstack-manuals'...
fatal: unable to connect to git.openstack.org:
git.openstack.org[0: 104.130.246.128]: errno=Connection timed out
git.openstack.org[1: 2001:4800:7819:103:be76:4eff:fe06:63c]: errno=Network is unreachable
Now we have -g option, which can set GITPROJ, but GITBASE still
use git://git.openstack.org/openstack, so it still fail:
/opt/stack/openstack-doc-tools/autogenerate_config_docs$ ./autohelp-wrapper -g https://github.com/openstack update ceilometer
Here I proposal to use environment variable value for GITPROJ and
GITBASE if they exist, so some devs, like me, can get rid of
hacking autohelp-wrapper to work then restore it when commit.
Change-Id: If7dc3ebe398c71d6461a5983d4aab1bc87984697
Closes-Bug: #1574224
If you manually generate CLI reference documents without
cliff-tablib installed, all commands that allow you to specify
a '-f <format>' option will not have 'html' as one of the
supported values. For example, the diff will look like:
- [-f {csv,html,json,table,value,yaml}]
+ [-f {csv,json,table,value,yaml}]
cliff-tablib has been added to the requirements to avoid this.
Change-Id: I0a655e25922788a4266ff201aa3574fc2e65a0ea
when run ./autohelp-wrapper rst aodh, it failed with:
AttributeError: 'BoolOpt' object has no attribute 'deprecated_reason'
we need to check the value before we use it
Change-Id: I362606ba186d1582f850bfa4d602503d6ea5079a
Closes-Bug: #1573953
- added --version option.
- added support for printing help if no options given, or if
'help' was used (i.e. 'openstack-auto-commands help')
openstack-manuals was also added to .gitignore so that
running the 'doc-tools-update-cli-reference' script will
not affect the os_doc_tools repo if the tool is run
within the repo.
Change-Id: I4c5ac6e7f207cd953040ce7b40cf1a5f13acf709
- added ability to supply multiple clients at a time.
- added flag to continue processing clients even if an error
occurs.
- fixed issue where an empty file was created if the client
wasn't found.
- fixed issue where specifying --all-api and --all-manage would
result in only --all-api being generated.
Change-Id: I8586279d884e1223ee7eb8ab12f50aa5ddc82561
- fixed issue where 'complete' generated wrong subcommands
if they were hyphenated.
- fixed issue where 'hardcoded' subcommands (in clients.yaml)
were ignored.
- added 'auth' to list of swift commands
Change-Id: If929299e38f21f3420d3fcb70a11daaa11c067bf
Bash variable expansion "${version##* }" doesn't match the char ")"
as "*". This patch add the process for "DeprecationWarning)" message.
Change-Id: If8e7dd047ea5e12487dc90f5a0fb7aeb4292ae13
Closes-Bug: #1565574
1.) This patch removes the Admin User Guide from the
Tools repository.
Change-Id: I97b180dff42893a9fa3d7872f73ed2935580d099
Implements: blueprint user-guides-reorganised
To use the heading level 2 for service API version,
the heading level of subcommands uses level 3.
Also, this change doesn't affect the command
that doesn't have explicit service API version description.
Change-Id: I90d0f791c01f233d8033ad17302b0fd27ea81c89
