Merge pull request #268 from jjhursey/check-doc

Improve reference checker at the end of make

Author: rhc54

Chap_Introduction.tex

@@ -201,14 +201,14 @@ \section{Organization of this document}
 \item \ac{PMIx} Initialization and Finalization in \chapterref{chap:api_init}
 \item Key/Value Management in \chapterref{chap:api_kv_mgmt}
 \item Process Management in \chapterref{chap:api_proc_mgmt}
-\item Job Management in \chapterref{chap:api_job_mgmt}
+\item Job Management and Reporting in \chapterref{chap:api_job_mgmt}
 \item Event Notification in \chapterref{chap:api_event}
 \item Data Packing and Unpacking in \chapterref{chap:api_data_mgmt}
 \item Security in \chapterref{chap:api_security}
 \item \ac{PMIx} Server Specific Interfaces in \chapterref{chap:api_server}
-\item Scheduler-Specific Interface in \chapterref{chap:api_scheduler}
+\item Fabric Support Definitions in \chapterref{chap:api_fabric}
 \item Process Sets and Groups in \chapterref{chap:api_sets_groups}
-\item Network Coordinates in \chapterref{chap:network_coords}
+\item Tools and Debuggers in \chapterref{chap:api_tools}
 \item Python Bindings in \appendixref{app:python}
 \end{itemize}
 

Makefile

@@ -62,9 +62,7 @@ pmix-standard.pdf: $(CHAPTERS) $(SOURCES) pmix.sty pmix-standard.tex figs/pmix-l
 	pdflatex -interaction=batchmode -file-line-error pmix-standard.tex || \
 		pdflatex -interaction=errorstopmode -file-line-error pmix-standard.tex  < /dev/null
 	pdflatex -interaction=batchmode -file-line-error pmix-standard.tex
-	@echo "====> Checking References (pmix-standard.log)"
-	@grep "Hyper reference" pmix-standard.log | grep Warning \
-	&& { echo "====> Error check references (above)" ; exit 1; } || { exit 0; }
+	@./bin/check-doc.sh
 	@echo "====> Success"
 	@cp pmix-standard.pdf pmix-standard-${version}.pdf
 

bin/check-doc.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+#
+# A script to run after every 'make' of the standard to check its integrity.
+#
+FINAL_STATUS=0
+
+#
+# Check for "Hyper reference" warnings which indicate missing cross reference.
+#
+echo "====> Checking Hyper References"
+grep "Hyper reference" pmix-standard.log | grep Warning
+if [ $? == 0 ] ; then
+    echo "====> Error check references (above)"
+    FINAL_STATUS=$((FINAL_STATUS+1))
+else
+    echo "====> Passed"
+fi
+
+#
+# Check for Acronym used but not defined
+#
+echo "====> Checking Cross References"
+grep "Warning: Reference" pmix-standard.log | grep "undefined"
+if [ $? == 0 ] ; then
+    echo "====> Error check references (above)"
+    FINAL_STATUS=$((FINAL_STATUS+1))
+else
+    echo "====> Passed"
+fi
+
+#
+# Check for Acronym used but not defined
+#
+echo "====> Checking Acronyms"
+grep "Acronym" pmix-standard.log | grep "is not defined on input"
+if [ $? == 0 ] ; then
+    echo "====> Error check references (above)"
+    FINAL_STATUS=$((FINAL_STATUS+1))
+else
+    echo "====> Passed"
+fi
+
+
+#
+# All done
+#
+exit $FINAL_STATUS

pmix-standard.tex

@@ -125,6 +125,10 @@
 \acrodef{IL}{Intermediate Launcher}
 \acrodef{FEA}{Fork/Exec Agent}
 
+% Acronyms that we may remove at a later time
+\acrodef{PRRTE}[PRRTE]{PMIx-based Reference RunTime Environment}
+\acrodef{PRI}[PRI]{PMIx Reference Implementation}
+
 %%%%%%%%%%%%%%%%%%%