]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
more docs and hand-holding.
authorAlan T. DeKok <aland@freeradius.org>
Fri, 27 Sep 2019 17:53:11 +0000 (13:53 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Fri, 27 Sep 2019 17:55:00 +0000 (13:55 -0400)
Spoon-feeding developers is a good idea.

scripts/build/missing-xlat-doc.sh

index 48a6b0e5a925b227f8149a4eef6d39a2d697dc39..4d3cd7f956a3b0b7c127341178d32c08be566bbc 100755 (executable)
@@ -48,12 +48,20 @@ done
 #  Files should be identical.  If not, panic.
 #
 if ! diff $OUTPUT $CORRECT 2>/dev/null ; then
+        echo "FAILED: $@"
+       echo
        echo "ERROR: Some registered xlats are not documented."
        echo "Please compare the following two files:"
        echo "    expected - $CORRECT"
         echo "    found    - $OUTPUT"
        echo
-       echo "If the found output is correct, then just copy that file to the expected output".
+       echo "If the found output is correct, then just copy 'found' to 'expected'".
+       echo
+       echo "If the xlat is built-in, please document it in"
+       echo "    doc/antora/modules/unlang/pages/xlat/builtin.adoc"
+       echo
+       echo "If the xlat is in a module, please document it in"
+       echo "    raddb/mods-available/NAME"
        exit 1
 fi