mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
4f3a9f46d2
* update Travis to build on Trusty for code layout * fix shellcheck replace ! -z by -n * shellcheck: fix -n doesn't work with unquoted arguments * more shellcheck fixes * use bash instead of posix
28 lines
1.4 KiB
Bash
Executable File
28 lines
1.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
|
|
# check that returns are placed before note and since
|
|
output=$(unbuffer ag --noaffinity --file-search-regex '\.h$' --multiline '\\(note|since)[^\n]+(\n\s*\* [^\n]+)*\n\s*\* \\return' ${TRAVIS_BUILD_DIR} | tee /dev/stderr)
|
|
if [[ -n $output ]]; then
|
|
echo -e "\n\x1B[31m*** Docstring computation: \\\return(s) should be placed before \\\note and \\since\x1B[0m"
|
|
exit 1
|
|
fi
|
|
|
|
# check that \since and \deprecated are placed at the end of the command block
|
|
output=$(unbuffer ag --noaffinity --file-search-regex '\.h$' --multiline '(\\(deprecated|since)[^\n]+\n)+\s*\*[^\/](?!\s*\\(deprecated|since))' ${TRAVIS_BUILD_DIR} | tee /dev/stderr)
|
|
if [[ -n $output ]]; then
|
|
echo -e "\n\x1B[31m*** Docstring computation: \\\deprecated and \\\since should be placed at the end of command blocks\x1B[0m"
|
|
echo -e "To fix it, you may want to run (multiple times) at the top level directory:"
|
|
echo 'sed -i -r '"'"'$!N;s/^(\s*\*\s+\\(deprecated|since)[^\n]+)\n(\s*\*([^\/].*|$))/\3\n\1/;P;D'"'"' $(ag -c --noaffinity --file-search-regex '"'"'\.h$'"'"' --multiline '"'"'(\\(deprecated|since)[^\n]+\n)+\s*\*[^\/]'"'"' . | cut -d: -f1)'
|
|
exit 1
|
|
fi
|
|
|
|
|
|
|
|
# code snippets command
|
|
output=$(unbuffer ag --noaffinity --file-search-regex '\.h$' --multiline '~~~\{\.\w+\}' ${TRAVIS_BUILD_DIR} | tee /dev/stderr)
|
|
if [[ -n $output ]]; then
|
|
echo -e "\n\x1B[31m*** Docstring computation: code snippets should use \\\code{.xx} rather than ~~~{.xx} \x1B[0m"
|
|
exit 1
|
|
fi
|