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 TYPES="php ctp xml"
   7
   8 if ! test -e "index.php"; then
   9   echo "$0: Please execute this script from root directory."
  10   exit 1
  11 fi
  12
  13 echo "$0: Generating TODOs.txt..."
  14 echo "### WARNING: THIS FILE IS AUTO-GENERATED BY $0 ###" > docs/TODOs.txt
  15 echo "### DO NOT EDIT THIS FILE. ###" >> docs/TODOs.txt
  16 for type in $TYPES; do
  17         find -type f -name "*.$type" -exec grep -Hin "@TODO" {} \; | sort >> docs/TODOs.txt
  18 done
  19 echo "### ### DEPRECATION FOLLOWS: ### ###" >> docs/TODOs.txt
  20 for type in $TYPES; do
  21         find -type f -name "*.$type" -exec grep -Hin "@DEPRECATED" {} \; | sort >> docs/TODOs.txt
  22 done
  23 echo "$0: Done."
  24 exit 0