todo-builder.sh

   1 #!/bin/sh
   2
   3 # This script helps building the file docs/TODOs.txt and should be executed by
   4 # developers with SVN write-access
   5
   6 if ! test -e "index.php"; then
   7         echo "$0: Please execute this script from root directory."
   8         exit 1
   9 fi
  10
  11 echo "$0: Generating TODOs.txt..."
  12 echo "### WARNING: THIS FILE IS AUTO-GENERATED BY $0 ###" > docs/TODOs.txt
  13 echo "### DO NOT EDIT THIS FILE. ###" >> docs/TODOs.txt
  14 find -type f -name "*.php" -exec grep -Hin "@TODO" {} \; | sort >> docs/TODOs.txt
  15 echo "### ### DEPRECATION FOLLOWS: ### ###" >> docs/TODOs.txt
  16 find -type f -name "*.php" -exec grep -Hin "@DEPRECATED" {} \; | sort >> docs/TODOs.txt
  17 echo "$0: Done."
  18 exit 0