Changeset 9330bfb in rtems-docs

Timestamp:

Nov 9, 2016, 6:08:05 AM (4 years ago)

Author:

Chris Johns <chrisj@…>

Branches:

4.11, 5, am, master

Children:

58c815c, 6297ad3

Parents:

5431beb

Message:

waf: Users without the extra fonts need to use '--disable-extra-fonts' to build PDF.

Files:

• README.txt (modified) (2 diffs)
• common/latex.py (modified) (2 diffs)
• common/waf.py (modified) (2 diffs)

README.txt

@@ -19 +19 @@
  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.
@@ -230 +230 @@
 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:

common/latex.py

@@ -108 +108 @@
 
 def configure_tests(conf):
-
     #
     # Using a hint from ita (thank you) :
@@ -165 +164 @@
         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'

common/waf.py

@@ -204 +204 @@
 
 def doc_singlehtml(ctx, source_dir, conf_dir):
-
     #
     # Use a run command to handle stdout and stderr output from inliner. Using
@@ -284 +283 @@
 
 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',