Moved files + added interface + generic socket file listener

[core.git] / contrib / todo-builder.sh

diff --git a/contrib/todo-builder.sh b/contrib/todo-builder.sh
new file mode 100755 (executable)
index 0000000..295b6ba
--- /dev/null
+++ b/contrib/todo-builder.sh
@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# This script helps building the file docs/TODOs.txt and should be executed by
+# developers with SVN write-access
+
+if ! test -e "docs"; then
+  echo "$0: Please execute this script from root directory."
+  exit 1
+fi
+
+echo "$0: Generating TODOs.txt..."
+echo "### WARNING: THIS FILE IS AUTO-GENERATED BY $0 ###" > docs/TODOs.txt
+echo "### DO NOT EDIT THIS FILE. ###" >> docs/TODOs.txt
+find -type f -name "*.php" -exec grep -Hin "@TODO" {} \; | sort >> docs/TODOs.txt
+echo "### ### DEPRECATION FOLLOWS: ### ###" >> docs/TODOs.txt
+find -type f -name "*.php" -exec grep -Hin "@DEPRECATED" {} \; | sort >> docs/TODOs.txt
+echo "$0: Done."
+exit 0