RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 17:47:44 +00:00
Code Issues Activity Actions

Meta: Check auto-generated manpages for completeness on CI

Browse source
This commit is contained in:
Ben Wiederhake 2021-10-26 22:41:31 +02:00 • committed by Linus Groh
parent 50a65f02a8
commit 55e1edd51b
2 changed files with 43 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
Meta/export-argsparser-manpages.sh
View file

@ -10,6 +10,20 @@ if ! command -v tar >/dev/null 2>&1 ; then
exit 1
fi
if [ "$#" = "0" ]; then
VERIFY_GIT_STATE=n
elif [ "$#" = "1" ] && [ "$1" = "--verify-git-state" ]; then
VERIFY_GIT_STATE=y
else
echo "USAGE: $0 [--verify-git-state]"
echo "This script runs Serenity and exports a set of manpages through ArgsParser,"
echo "and places them in Base/usr/share/man/."
echo "If --verify-git-state is given, this script verifies that this does not modify"
echo "the git state, i.e. that all exported manpages already were in the repository"
echo "with the exact same content."
exit 1
fi
echo "This script assumes passwordless sudo."
sudo true
@ -49,3 +63,18 @@ sudo umount fsmount
rmdir fsmount
echo "Successfully (re-)generated manpages in Base/usr/share/man/"
if [ "$VERIFY_GIT_STATE" = "y" ]; then
echo "Verifying git state ..."
if [ "" != "$(git clean -n Base/usr/share/man)" ] || ! git diff --quiet Base/usr/share/man; then
echo "Failed: There are missing and/or outdated manpages."
echo "$ git status Base/usr/share/man"
git status Base/usr/share/man
echo "$ git diff Base/usr/share/man"
git diff Base/usr/share/man
echo "You may need to run ./Meta/export-argsparser-manpages.sh on your system and commit/squash the resulting changes."
exit 1
else
echo "Verified: No missing or outdated manpages. Great!"
fi
fi