summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2016-11-09 17:08:05 +1100
committerChris Johns <chrisj@rtems.org>2016-11-09 17:08:05 +1100
commit9330bfbaa7e7855c4b1caa75de78c97197d45733 (patch)
tree395712f2db02d74d32a9b75ca322e5eeb2b3d512
parent5431beb47290b642e5b6e2b4e12b07db758c6dcd (diff)
downloadrtems-docs-9330bfbaa7e7855c4b1caa75de78c97197d45733.tar.bz2
waf: Users without the extra fonts need to use '--disable-extra-fonts' to build PDF.
-rw-r--r--README.txt9
-rw-r--r--common/latex.py3
-rw-r--r--common/waf.py5
3 files changed, 13 insertions, 4 deletions
diff --git a/README.txt b/README.txt
index 190337e..e0c06c4 100644
--- a/README.txt
+++ b/README.txt
@@ -18,7 +18,7 @@ The RTEMS Documentation output formats are:
PDF - Single PDF per manual.
SIngle HTML - Single HTML, one file per manual.
-The PDF format is cerated using Latex and that uses texlive packages. This
+The PDF format is created using Latex and that uses texlive packages. This
exposes us to the complex world of Latex however the quality of the documents
created is worth it.
@@ -229,12 +229,17 @@ Note: waf-1.9.5 is a little noisy when running tex builds and tests. I hope
To build enter in the top directory:
- $ ./waf configure [--pdf] [--singlehtml] [--prefix] [--sphinx-verbose]
+ $ ./waf configure [--pdf] [--singlehtml] [--prefix] \
+ [--sphinx-verbose] [--disable-extra-fonts]
$ ./waf
The '--pdf' and '--singlehtml' options can be added to configure to build those
output formats.
+The '--disable-extra-fonts' allows you to build PDF documents with out the
+fonts we use for a better quality document. Use this option to build without
+needing the extra fonts accepting you will get poor quality documents.
+
To build and install to a specific location:
$ ./waf configure --prefix=/foo/my/location
diff --git a/common/latex.py b/common/latex.py
index bf5c91d..7f2765c 100644
--- a/common/latex.py
+++ b/common/latex.py
@@ -107,7 +107,6 @@ def local_packages():
return packages
def configure_tests(conf):
-
#
# Using a hint from ita (thank you) :
# https://github.com/waf-project/waf/blob/master/demos/tex/wscript
@@ -164,4 +163,6 @@ def configure_tests(conf):
if fails == 0:
conf.env.RTEMSEXTRAFONTS = 'rtemsextrafonts.sty'
else:
+ if not conf.options.disable_extra_fonts:
+ conf.fatal('Extra fonts not found, install or use --disable-extra-fonts')
conf.env.RTEMSEXTRAFONTS = 'rtemsextrafonts-null.sty'
diff --git a/common/waf.py b/common/waf.py
index c1d3f81..33fff4d 100644
--- a/common/waf.py
+++ b/common/waf.py
@@ -203,7 +203,6 @@ def doc_pdf(ctx, source_dir, conf_dir):
quiet = True)
def doc_singlehtml(ctx, source_dir, conf_dir):
-
#
# Use a run command to handle stdout and stderr output from inliner. Using
# a standard rule in the build context locks up.
@@ -283,6 +282,10 @@ def cmd_build(ctx, conf_dir = ".", source_dir = "."):
doc_html(ctx, source_dir, conf_dir)
def cmd_options(ctx):
+ ctx.add_option('--disable-extra-fonts',
+ action = 'store_true',
+ default = False,
+ help = "Disable building with extra fonts for better quality (lower quality).")
ctx.add_option('--sphinx-verbose',
action = 'store',
default = "-Q",