openstack
/
openstack-doc-tools
Code Issues Proposed changes

Do no build Debian Install Guide by default 

Disable building of the Guide by default, add a switch to enable it.
We're not publishing the Guide in current releases at all, so no
need to build it.

Change-Id: I31f235bce2e65b5de4ca2528c85c8c06d8550626
This commit is contained in:
Andreas Jaeger 2015-05-06 20:45:42 +02:00
parent fcfe1f6af3
commit 4eadc65172
2 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
RELEASE_NOTES.rst
View File

@ -1,6 +1,13 @@
Release notes Release notes
============= =============
0.27
----
* ``openstack-doc-test``: Do not build Debian Install Guide by
default, built it only if the parameter ``--enable-debian-install``
is passed.
0.26 0.26
---- ----

24
os_doc_tools/doctest.py
View File

@ -893,14 +893,15 @@ def build_book(book, publish_path, log_path):
out_file.write(output) out_file.write(output)
if base_book == "install-guide": if base_book == "install-guide":
# Build Debian # Build Debian
base_book = "install-guide (for debian)" if cfg.CONF.enable_debian_install:
output = subprocess.check_output( base_book = "install-guide (for debian)"
["mvn", "generate-sources", "-B", output = subprocess.check_output(
comments, release, ["mvn", "generate-sources", "-B",
"-Doperating.system=apt-debian", "-Dprofile.os=debian"], comments, release,
stderr=subprocess.STDOUT "-Doperating.system=apt-debian", "-Dprofile.os=debian"],
) stderr=subprocess.STDOUT
out_file.write(output) )
out_file.write(output)
# Build Fedora # Build Fedora
base_book = "install-guide (for Fedora)" base_book = "install-guide (for Fedora)"
output = subprocess.check_output( output = subprocess.check_output(
@ -929,7 +930,10 @@ def build_book(book, publish_path, log_path):
stderr=subprocess.STDOUT stderr=subprocess.STDOUT
) )
# Success # Success
base_book = "install-guide (for Debian, Fedora, openSUSE, Ubuntu)" base_book = "install-guide (for "
if cfg.CONF.enable_debian_install:
base_book += "Debian, "
base_book += "Fedora, openSUSE, Ubuntu)"
# HOT template guide # HOT template guide
elif base_book == 'hot-guide': elif base_book == 'hot-guide':
# Make sure that the build dir is clean # Make sure that the build dir is clean
@ -1457,6 +1461,8 @@ cli_OPTS = [
cfg.MultiStrOpt("url-exception", cfg.MultiStrOpt("url-exception",
help="URL that will be skipped during reachability " help="URL that will be skipped during reachability "
"check."), "check."),
cfg.BoolOpt("enable-debian-install", default=False,
help="Enable building of Debian Install Guide."),
] ]
OPTS = [ OPTS = [