DOCS/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 "modules.php"; then
   7   echo "$0: Please execute this script from root directory."
   8   exit 1
   9 fi
  10
  11 TODO=`dirname $0`/TODOs.txt
  12
  13 echo "$0: Generating TODOs.txt ..."
  14 echo "### WARNING: THIS FILE IS AUTO-GENERATED BY $0 (uid=${UID}/user=${USER}) ###" > ${TODO}
  15 echo "### DO NOT EDIT THIS FILE. ###" >> ${TODO}
  16 echo "$0: Searching for @TODO ..."
  17 find -type f -name "*.php" -exec grep -Hin "@TODO" {} \; | sort >> ${TODO}
  18 find -type f -name "*.tpl" -exec grep -Hin "@TODO" {} \; | sort >> ${TODO}
  19 find -type f -name "*.xml" -exec grep -Hin "@TODO" {} \; | sort >> ${TODO}
  20 find -type f -name ".htaccess" -exec grep -Hin "@TODO" {} \; | sort >> ${TODO}
  21 echo "### ### DEPRECATION FOLLOWS: ### ###" >> ${TODO}
  22 echo "$0: Searching for @DEPRECATED ..."
  23 find -type f -name "*.php" -exec grep -Hin "@DEPRECATED" {} \; | sort >> ${TODO}
  24 find -type f -name "*.tpl" -exec grep -Hin "@DEPRECATED" {} \; | sort >> ${TODO}
  25 find -type f -name "*.xml" -exec grep -Hin "@DEPRECATED" {} \; | sort >> ${TODO}
  26 find -type f -name ".htaccess" -exec grep -Hin "@DEPRECATED" {} \; | sort >> ${TODO}
  27 echo "$0: Checking for template-warnings.log ..."
  28 LOG=`dirname $0`/template-warnings.log
  29 if test -e "${LOG}"; then
  30         echo "$0: Found a template-warnings.log, adding it..."
  31         echo "### ### template-warnings.log follows: ### ###" >> ${TODO}
  32         cat ${LOG} >> ${TODO}
  33 fi
  34 echo "$0: Done."
  35 exit 0