summaryrefslogtreecommitdiffstats
path: root/common/waf.py
diff options
context:
space:
mode:
authorAmar Takhar <amar@rtems.org>2016-01-18 17:53:44 -0500
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:24 -0400
commitf916fcaaae92aa57dd1d644badd1979bd93a4d35 (patch)
treede1d1d5bff4039bd0beb2eabe1eb7c6f9303f3ee /common/waf.py
parentd389819eea3a84e388935153e3be847342809da3 (diff)
downloadrtems-docs-f916fcaaae92aa57dd1d644badd1979bd93a4d35.tar.bz2
Add support for spellchecking with a custom dictionary.
To use: 1. Install aspell 2. waf spell <list of files> * waf spell mydoc.rst * waf spell *.rst This uses a custom dictionary stored in common/spell/dict/. We should add all RTEMS and programming terms to this to ensure we are consistent. Amar.
Diffstat (limited to 'common/waf.py')
-rw-r--r--common/waf.py37
1 files changed, 35 insertions, 2 deletions
diff --git a/common/waf.py b/common/waf.py
index 5437ab3..88c5690 100644
--- a/common/waf.py
+++ b/common/waf.py
@@ -1,9 +1,40 @@
import sys, os
+from waflib.Build import BuildContext
+def cmd_spell(ctx):
+ from waflib import Options
+ from sys import argv
+ from subprocess import call
+
+ Options.commands = None # stop warnings about knowing commands.
+
+ if not ctx.env.BIN_ASPELL:
+ ctx.fatal("'aspell' is required please add binary to your path and re-run configure.")
+
+ if len(argv) < 3:
+ ctx.fatal("Please supply at least one file name")
+
+ files = argv[2:]
+
+ path = ctx.path.parent.abspath()
+
+ # XXX: add error checking eg check if file exists.
+ for file in files:
+ cmd = ctx.env.BIN_ASPELL + ["-c", "--personal=%s/common/spell/dict/rtems" % path, "--extra-dicts=%s/common/spell/en_GB-ise-w_accents.multi" % path, file]
+
+ print "running:", cmd
+ call(cmd)
+
+
+class spell(BuildContext):
+ __doc__ = "Check spelling. Supply a list of files or a glob (*.rst)"
+ cmd = 'spell'
+ fun = 'cmd_spell'
def cmd_configure(ctx):
- ctx.find_program("sphinx-build", var="SPHINX_BUILD")
+ ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD")
+ ctx.find_program("aspell", var="BIN_ASPELL", mandatory=False)
def cmd_build(ctx, conf_dir=".", source_dir="."):
srcnode = ctx.srcnode.abspath()
@@ -21,7 +52,7 @@ def cmd_build(ctx, conf_dir=".", source_dir="."):
)
ctx(
- rule = "${SPHINX_BUILD} -b html -c %s -j %d -d build/doctrees %s build/html" % (conf_dir, ctx.options.jobs, source_dir),
+ rule = "${BIN_SPHINX_BUILD} -b html -c %s -j %d -d build/doctrees %s build/html" % (conf_dir, ctx.options.jobs, source_dir),
cwd = ctx.path.abspath(),
source = ctx.path.ant_glob('**/*.rst'),# + ctx.path.ant_glob('conf.py'),
target = ctx.path.find_or_declare('html/index.html')
@@ -66,3 +97,5 @@ def cmd_build_path(ctx):
)
cmd_build(ctx, conf_dir="build", source_dir="build")
+
+