openstack
/
openstack-doc-tools
Code Issues Proposed changes

Merge "[config-ref] remove unnecessary template files"

This commit is contained in:
Jenkins 2016-11-21 07:24:20 +00:00 committed by Gerrit Code Review
parent ce8c49555b e8f0c4c53e
commit 1cf2f2018e
3 changed files with 0 additions and 155 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
autogenerate_config_docs/templates/autohelp.docbook.j2
View File

@ -1,58 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_{{ pkg }}_{{ cat }}">
<caption>Description of {{ nice_cat }} configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{% for group in groups %}
<tr>
<th colspan="2">[{{ group }}]</th>
</tr>
{% for item in items[loop.index0] %}
<tr>
<td><option>{{ item[0] }}</option> = <replaceable>{{ item[1] }}</replaceable></td>
<td>
<p>{{ item[2] | replace('<', '&lt;') | replace('>', '&gt;') }}</p>
{% if len(item) >= 4 %}
<dl>
{% for flagname, flagdesc in item[3] %}
<dt>{{ flagname }}</dt><dd>{{ flagdesc }}</dd>
{% endfor %}
</dl>
{% endif %}
</td>
</tr>
{% endfor %}
{% endfor %}
</tbody>
</table>
</para>

70
autogenerate_config_docs/templates/changes.docbook.j2
View File

@ -1,70 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="{{ project }}-conf-changes-{{ release|lower }}">
<!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
<title>New, updated, and deprecated options in {{ release }} for {{ codename }}</title>
{% if new_opts %}
<table>
<caption>New options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Option = default value</td>
<td>(Type) Help string</td>
</tr>
</thead>
{% for cells in new_opts %}
<tr>
{% for cell in cells %}
<td>{{ cell }}</td>
{% endfor %}
</tr>
{% endfor %}
</table>
{% endif %}
{% if new_defaults %}
<table>
<caption>New default values</caption>
<col width="33%"/>
<col width="33%"/>
<col width="33%"/>
<thead>
<tr>
<td>Option</td>
<td>Previous default value</td>
<td>New default value</td>
</tr>
</thead>
{% for cells in new_defaults %}
<tr>
{% for cell in cells %}
<td>{{ cell }}</td>
{% endfor %}
</tr>
{% endfor %}
</table>
{% endif %}
{% if deprecated_opts %}
<table>
<caption>Deprecated options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<td>Deprecated option</td>
<td>New Option</td>
</tr>
</thead>
{% for cells in deprecated_opts %}
<tr>
{% for cell in cells %}
<td>{{ cell }}</td>
{% endfor %}
</tr>
{% endfor %}
</table>
{% endif %}
{% if not new_opts and not new_defaults and not deprecated_opts %}
<para>There are no new, updated, and deprecated options in {{ release }} for {{ codename }}.</para>
{% endif %}
</section>

27
autogenerate_config_docs/templates/swift.docbook.j2
View File

@ -1,27 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- The tool that generated this table lives in the
openstack-doc-tools repository. The editions made in
this file will *not* be lost if you run the script again. -->
<table rules="all">
<caption>Description of configuration options for
<literal>[{{ section }}]</literal> in <filename>{{ filename }}.conf</filename>
</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{% for option in options %}
<tr>
<td><option>{{ option[0] }}</option> = <replaceable>{{ option[1] }}</replaceable></td>
<td>{{ option[2] }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</para>