Revision 406820d295610301c4725f8779e4e698927f53b8 authored by Tobias Meisel on 20 July 2021, 13:15:31 UTC, committed by Tobias Meisel on 21 July 2021, 08:01:09 UTC
1 parent 40f5816
generate-project-file-doc-qa.sh
#!/bin/bash
# This script creates the quality assurance page and augments the
# input file parameter documentation by information about end-to-end
# tests in which the respective parameters are used.
if [ $# -ne 3 ]; then
echo "USAGE: $0 SRCDIR BUILDDIR DATADIR" >&2
exit 1
fi
set -e
srcdir="$1"
builddir="$2"
datadir="$3"
docauxdir="$builddir/DocAux"
doxdir="$docauxdir/dox"
toolsdir="$srcdir/scripts/doc"
param_cache="$docauxdir/documented-parameters-cache.txt"
qafile="$doxdir/project-file-doc-qa.dox"
check_quality_script="$toolsdir/check-project-params.py"
mkdir -p "$doxdir"
# Gather information about documented parameters.
"$toolsdir/get-project-params.sh" "$srcdir" \
| "$toolsdir/normalize-param-cache.py" >"$param_cache"
# Document ctest project files
# and find out which tags and attributes are tested in which prj file and what
# is not tested at all.
"$toolsdir/linked-xml-file.py" "$datadir" "$docauxdir"
# Write QA information.
cat <<"EOF" >"$qafile"
/*! \page project_file_doc_qa OGS Input File Parameters—Quality Assurance
This page lists issues with the OGS input file parameter documentation.
If it is empty, there are no issues detected.
EOF
"$check_quality_script" "$docauxdir" "$srcdir" >>"$qafile" || true
cat <<EOF >>"$qafile"
*/
EOF
# Finish parameter documentation dox files by appending auxiliary information,
# e.g., associated ctests, data type, etc.
"$toolsdir/append-xml-tags.py" prj "$datadir" "$docauxdir"
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...