Changeset f916fca in rtems-docs

Timestamp:

01/18/16 22:53:44 (8 years ago)

Author:

Amar Takhar <amar@…>

Branches:

4.11, 5, master

Children:

4f81ff1

Parents:

d389819

git-author:

Amar Takhar <amar@…> (01/18/16 22:53:44)

git-committer:

Amar Takhar <verm@…> (05/03/16 00:51:24)

Message:

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.

Files:

• book/wscript (modified) (1 diff)
• bsp_howto/wscript (modified) (1 diff)
• c_user/wscript (modified) (1 diff)
• common/spell/dict/rtems (added)
• common/spell/en_GB-ise-w_accents-only.rws (added)
• common/spell/en_GB-ise-w_accents.multi (added)
• common/waf.py (modified) (3 diffs)
• cpu_supplement/wscript (modified) (1 diff)
• develenv/wscript (modified) (1 diff)
• filesystem/wscript (modified) (1 diff)
• networking/wscript (modified) (1 diff)
• porting/wscript (modified) (1 diff)
• posix1003_1/wscript (modified) (1 diff)
• posix_users/wscript (modified) (1 diff)
• rtemsconfig/wscript (modified) (1 diff)
• shell/wscript (modified) (1 diff)
• user/wscript (modified) (1 diff)

book/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure_path, cmd_build_path, cmd_options_path
+from waf import cmd_configure_path, cmd_build_path, cmd_options_path, spell, cmd_spell
 
 

bsp_howto/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

c_user/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

common/waf.py

@@ -1 +1 @@
 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="."):
@@ -22 +53 @@
 
         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'),
@@ -67 +98 @@
 
         cmd_build(ctx, conf_dir="build", source_dir="build")
+
+

cpu_supplement/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

develenv/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

filesystem/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

networking/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

porting/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

posix1003_1/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

posix_users/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

rtemsconfig/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_options_path, cmd_configure_path, cmd_build_path
+from waf import cmd_options_path, cmd_configure_path, cmd_build_path, spell, cmd_spell
 
 

shell/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):

user/wscript

@@ -3 +3 @@
 path.append(abspath('../common/'))
 
-from waf import cmd_configure, cmd_build
+from waf import cmd_configure, cmd_build, spell, cmd_spell
 
 def configure(ctx):