From a3eded0843874a78e69e4b985cb2a492bfab78f3 Mon Sep 17 00:00:00 2001
From: Eric Kunze <eric.kunze@arm.com>
Date: Mon, 13 Dec 2021 15:40:04 -0800
Subject: Add rudimentary spell check for specification

We can't easily spell check the entire specification, the
pseudocode and operator tables make it unworkable. This
adds a simple python script that tries to extract just the
description of the operators for checking. It also does a check
over the entire license.

A custom dictionary is used to contain specification custom words.

Change-Id: I74558c03af1506e2970f20b3246d920c2753ca44
Signed-off-by: Eric Kunze <eric.kunze@arm.com>
---
 Makefile | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)

(limited to 'Makefile')

diff --git a/Makefile b/Makefile
index cf2ab53..407047d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,7 +1,7 @@
 #
 # This confidential and proprietary software may be used only as
 # authorised by a licensing agreement from ARM Limited
-# (C) COPYRIGHT 2020 ARM Limited
+# (C) COPYRIGHT 2020-2022 ARM Limited
 # ALL RIGHTS RESERVED
 # The entire notice above must be reproduced on all authorised
 # copies and copies may only be made to the extent permitted
@@ -11,6 +11,7 @@
 TOSAREVISION=0.24.0 draft
 MKDIR=mkdir -p
 ASCIIDOC=asciidoctor
+ASPELL=aspell
 
 HTMLDIR=out/html
 PDFDIR=out/pdf
@@ -18,13 +19,14 @@ PDFDIR=out/pdf
 COMMON_ARGS= -a revnumber="$(TOSAREVISION)"
 
 SPECSRC := tosa_spec.adoc
-SPECFILES = $(wildcard chapters/[A-Za-z]*.adoc) tosa.css
+ADOCFILES = $(wildcard chapters/[A-Za-z]*.adoc)
+SPECFILES = $(ADOCFILES) tosa.css
 
 .DELETE_ON_ERROR:
 
-.PHONY: all html pdf clean
+.PHONY: all html pdf clean spell
 
-all: html pdf
+all: spell html pdf
 
 html: $(HTMLDIR)/tosa_spec.html
 
@@ -34,6 +36,19 @@ clean:
 	$(RM) $(HTMLDIR)/tosa_spec.html
 	$(RM) $(PDFDIR)/tosa_spec.pdf
 
+spell: out/spell.txt
+
+out/spell.txt: $(ADOCFILES) FORCE
+	@echo Running spell check
+	@mkdir -p $(@D)
+	@tools/get_descriptions.py $(ADOCFILES) \
+		| $(ASPELL) list -v -l en-US --encoding=UTF-8 --add-extra-dicts=./tools/dictionary.dic\
+		| sort -u > $@
+	@-if [ -s $@ ] ; then \
+		echo Spelling errors detected, check $@; \
+		else echo No spelling errors found ; \
+	fi
+
 $(HTMLDIR)/tosa_spec.html: $(SPECSRC) $(SPECFILES)
 	$(MKDIR) $(HTMLDIR)
 	$(ASCIIDOC) -b html5 -a stylesheet=tosa.css $(COMMON_ARGS) -o $@ $<
@@ -41,3 +56,6 @@ $(HTMLDIR)/tosa_spec.html: $(SPECSRC) $(SPECFILES)
 $(PDFDIR)/tosa_spec.pdf: $(SPECSRC) $(SPECFILES)
 	$(MKDIR) $(PDFDIR)
 	$(ASCIIDOC) -r asciidoctor-pdf -b pdf $(COMMON_ARGS) -o $@ $(SPECSRC)
+
+.PHONY: FORCE
+FORCE:
-- 
cgit v1.2.1