starlingx
/
docs
Code Issues Proposed changes

Extend HTML formatting check (r5, r6, dsR6) 

Find subsitutions enclosed in word boundaries or html tags.
e.g " |org| " and "<strong>|org|</strong>"

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Idd6124399ca44de5e3d0c52c5cff0924bbca50b5
(cherry picked from commit 0137c7db58)
This commit is contained in:
Ron Stone 2022-04-27 12:55:24 -04:00
parent a88fc4b04f
commit 877747f475
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
htmlChecks.sh
View File

@ -32,10 +32,12 @@ if [ ${#INCLUDE_FILES[@]} != 0 ]; then
fi
echo "Checking for unexpanded substitution errors in output ..."
INCLUDE_FILES=( $(grep -rl --include="*.html" ' |\S\+| ' .) )
INCLUDE_FILES=( $(grep -rlo --include="*.html" --exclude="doc_contribute_guide.html" '[>\s]|\S\+|[<\s]' .) )
if [ ${#INCLUDE_FILES[@]} != 0 ]; then
echo -e "Found ${#INCLUDE_FILES[@]} HTML file(s) that may have unexpanded substitution(s):\n${RED}"
grep -r --include="*.html" ' |\S\+| ' . | awk -F: '{if(f!=$1)print ""; f=$1; print $0;}'
grep -ro --include="*.html" --exclude="doc_contribute_guide.html" '[>\s]|\S\+|[<\s]' . | awk -F: '{if(f!=$1)print ""; f=$1; print $0;}'
echo -e "${NC}\nCorrect the issue(s) in the corresponding rST file(s).\nHINT: Substitions are not allowed in code blocks, :ref:s,\n:doc:s, or within rST markup such as **, \`\`, and so on."
error=1
fi