openstack
/
openstack-doc-tools
Code Issues Proposed changes

Add bash-completion/complete selection for command list parsing 

gnocchi commands supports complete only (not supported bash-completion)
For supporting, it adds bash-completion/complete detection
in generate_command.
Instead, it removes specify "bash-completion" in generate_subcommand.

i.e call relation is follows
  generate_subcommand <= remove specify "bash-completion"
                         remove set subcommands
    generate_command  <= add method detection
                         newly set subcommands
    discover_and_generate_subcommands
       discover_subcommands  <= use subcommands
                                for bash-completion or complete

Change-Id: Ia076114aa7fda218ed6fc349951df536e11fb710
Closes-Bug: #1514705
This commit is contained in:
Atsushi SAKAI 2015-11-10 22:04:02 +09:00
parent b5075a8136
commit 5143dbae01
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
os_doc_tools/commands.py
View File

@ -298,6 +298,7 @@ def generate_command(os_command, os_file):
next_line_screen = True
line_index = -1
in_screen = False
subcommands = 'complete'
for line in help_lines:
line_index += 1
xline = quote_xml(line)
@ -383,11 +384,15 @@ def generate_command(os_command, os_file):
in_screen = True
elif len(line) > 0:
os_file.write("\n%s" % xline.rstrip())
# subcommands (select bash-completion, complete for bash-completion)
if 'bash-completion' in line:
subcommands = 'bash-completion'
if in_screen:
os_file.write("</computeroutput></screen>\n")
os_file.write(" </section>\n")
return subcommands
def generate_subcommand(os_command, os_subcommand, os_file, extra_params,
@ -615,12 +620,11 @@ def document_single_project(os_command, output_dir):
else:
api_name = ''
title = data.get('title', '')
subcommands = data.get('subcommands', 'bash-completion')
out_filename = "ch_cli_" + os_command + "_commands.xml"
out_file = open(os.path.join(output_dir, out_filename), 'w')
generate_heading(os_command, api_name, title, out_file)
generate_command(os_command, out_file)
subcommands = generate_command(os_command, out_file)
if os_command == 'cinder':
out_file.write("""