1#!/bin/bash 2set -e 3 4ARG_COMMIT=$1 5DIFF_SUBSET="scripts/.diff_*" 6DIFF_DOC_ALL="scripts/.diff_all.txt" 7DIFF_DOC_FIXED="scripts/.diff_fixed.txt" 8LAST_SEVERITY= 9LAST_DOC= 10 11function check_doc() 12{ 13 local TOP_SEVERITY LANGUAGE=$1 14 15 if [ "${LANGUAGE}" == "EN" ] ; then 16 SVT_CRITIAL="critical" 17 SVT_IMPORTANT="important" 18 SVT_MODERATE="moderate" 19 DOC=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_EN\.md/p"` 20 else 21 SVT_CRITIAL="紧急" 22 SVT_IMPORTANT="重要" 23 SVT_MODERATE="普通" 24 DOC=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_CN\.md/p"` 25 fi 26 27 echo "Checking doc: ${DOC}" 28 29 # check DOS encoding 30 git show ${ARG_COMMIT} -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL} 31 git show ${ARG_COMMIT} -1 ${DOC} | sed -n "/^+/p" > ${DIFF_DOC_ALL}.dos 32 dos2unix ${DIFF_DOC_ALL}.dos >/dev/null 2>&1 33 CSUM1=`md5sum ${DIFF_DOC_ALL} | awk '{ print $1 }'` 34 CSUM2=`md5sum ${DIFF_DOC_ALL}.dos | awk '{ print $1 }'` 35 if [ "${CSUM1}" != "${CSUM2}" ]; then 36 echo "ERROR: ${DOC} is DOS encoding. Fix it by: 'dos2unix ${DOC}'" 37 exit 1 38 fi 39 40 TITLE=`sed -n "/^+## /p" ${DIFF_DOC_ALL} | tr -d " +#"` 41 FILE=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $3 }'` 42 COMMIT=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $4 }'` 43 SEVERITY=`sed -n "/^+| 20[0-9][0-9]-/p" ${DIFF_DOC_ALL} | tr -d " " | awk -F "|" '{ print $5 }'` 44 HORIZONTAL_LINE=`sed -n "/^+------$/p" ${DIFF_DOC_ALL}` 45 END_LINE=`tail -n 1 ${DIFF_DOC_ALL}` 46 # echo "### ${COMMIT}, ${SEVERITY}, ${TITLE}, ${FILE}" 47 48 # check blank line after Heading 1 49 HEADING_1=`sed -n '1p' ${DOC}` 50 if sed -n '2p' ${DOC} | grep -q [a-z,A-Z] ; then 51 echo "ERROR: ${DOC}: Should reserve blank line after '${HEADING_1}'" 52 exit 1 53 fi 54 55 # check space 56 if sed -n "/##/p" ${DOC} | grep -v '## [a-z,A-Z]' ; then 57 echo "ERROR: ${DOC}: Should only 1 space between '#' and word" 58 exit 1 59 fi 60 61 # check new content location 62 if ! git show ${ARG_COMMIT} -1 ${DOC} | grep -q 'Release Note' ; then 63 echo "ERROR: ${DOC}: Adding new content at the top but not bottom" 64 exit 1 65 fi 66 67 # check title 68 if grep -Eq '### NEW|### new' ${DIFF_DOC_ALL} ; then 69 echo "ERROR: ${DOC}: Please use '### New'" 70 exit 1 71 fi 72 73 if grep -Eq '### FIXED|### fixed' ${DIFF_DOC_ALL} ; then 74 echo "ERROR: ${DOC}: Please use '### Fixed'" 75 exit 1 76 fi 77 78 # check TAB before index of 'New' body 79 if grep -q $'\t[0-9]' ${DOC} ; then 80 echo "ERROR: ${DOC}: Don't add TAB before index:" 81 grep $'\t[0-9]' ${DOC} 82 exit 1 83 fi 84 85 # check upper case and line end 86 if [ "${LANGUAGE}" == "EN" ] ; then 87 if grep -q '^[0-9]\. [a-z]' ${DOC} ; then 88 echo "ERROR: ${DOC}: Please use upper case of first word(i.e. \"1. add ..\" => \"1. Add ...\"):" 89 grep '^[0-9]\. [a-z]' ${DOC} 90 exit 1 91 fi 92 93 # check end with '.' 94 if sed -n '/^[0-9]\. [A-Z]/p' ${DOC} | grep -q '[^.]$' ; then 95 echo "ERROR: ${DOC}: Please end line with '.'" 96 grep '^[0-9]\. [A-Z]' ${DOC} | grep '[^.]$' 97 exit 1 98 fi 99 else 100 # check end with '。' 101 if sed -n '/^[0-9]\. /p' ${DOC} | grep -q '[^。]$' ; then 102 echo "ERROR: ${DOC}: Please end line with '。'" 103 grep '^[0-9]\. ' ${DOC} | grep '[^。]$' 104 exit 1 105 fi 106 fi 107 108 # check space after index of 'New' body 109 SUM1=`grep '^[0-9]\.' ${DOC} | wc -l` 110 SUM2=`grep '^[0-9]\.[[:blank:]]' ${DOC} | wc -l` 111 if [ "$SUM1" != "$SUM2" ]; then 112 echo "ERROR: ${DOC}: Please add space after index (e.g: '1. ' but not '1.'):" 113 grep '^+[0-9]\.' ${DIFF_DOC_ALL} 114 exit 1 115 fi 116 117 # check standalone file 118 if ! echo ${FILE} | grep -Eq '\.bin|\.elf|\.img' ; then 119 echo "ERROR: ${DOC}: '${FILE}' missing the file format suffix" 120 exit 1 121 fi 122 if ! echo ${FILE} | grep -q { ; then 123 if ! git log ${ARG_COMMIT} -1 --name-only | grep -q ${FILE}; then 124 echo "ERROR: ${DOC}: '${FILE}' is not updated in this patch" 125 exit 1 126 fi 127 fi 128 129 # check title 130 if [ "${TITLE}" != "${FILE}" ]; then 131 echo "ERROR: ${DOC}: Title '${TITLE}' is not match with '${FILE}'" 132 exit 1 133 fi 134 135 # check commit 136 COMMIT=${COMMIT//#/ } 137 for LIST in ${COMMIT}; do 138 CMT=`echo ${LIST} | cut -d : -f 2` 139 if ! git log ${ARG_COMMIT} -1 | grep -q ${CMT} ; then 140 echo "ERROR: ${DOC}: '${CMT}' is not match in commit message" 141 exit 1 142 fi 143 144 if ! echo ${FILE} | grep -q { ; then 145 if echo ${FILE} | grep -Eq 'spl_|tpl_|bl31_|bl32_|tee_' ; then 146 FILE_PATH=`find -name ${FILE}` 147 if [ -z "${FILE_PATH}" ]; then 148 echo "ERROR: ${DOC}: No ${FILE}" 149 exit 1 150 fi 151 if ! strings ${FILE_PATH} | grep -q ${CMT} ; then 152 echo "ERROR: ${DOC}: ${FILE} is not build from '${CMT}'" 153 exit 1 154 fi 155 fi 156 fi 157 done 158 159 # check severity 160 if [ "${SEVERITY}" != "${SVT_CRITIAL}" -a "${SEVERITY}" != "${SVT_IMPORTANT}" -a "${SEVERITY}" != "${SVT_MODERATE}" ]; then 161 echo "ERROR: ${DOC}: Unknown main severity: ${SEVERITY}" 162 exit 1 163 fi 164 165 # check horizontal line 166 if [ -z "${HORIZONTAL_LINE}" ]; then 167 echo "ERROR: ${DOC}: No horizontal line '------' at the last of new content" 168 exit 1 169 fi 170 171 # check horizontal line 172 if [ "${END_LINE}" == "+------" ]; then 173 echo "ERROR: ${DOC}: No blank line after '------'" 174 exit 1 175 fi 176 177 # check 'Fixed' content 178 if grep -q "^+### Fixed" ${DIFF_DOC_ALL} ; then 179 awk -v RS='### Fixed' 'END{printf "%s", $0}' ${DIFF_DOC_ALL} > ${DIFF_DOC_FIXED} 180 sed -i "/^$/d" ${DIFF_DOC_FIXED} 181 sed -i "/Index/d" ${DIFF_DOC_FIXED} 182 sed -i "/---/d" ${DIFF_DOC_FIXED} 183 sed -i "/^+$/d" ${DIFF_DOC_FIXED} 184 185 while read LINE 186 do 187 EACH_SEVERITY=`echo "${LINE}" | awk -F "|" '{ print $3 }' | tr -d " "` 188 if [ "${EACH_SEVERITY}" != "${SVT_CRITIAL}" -a "${EACH_SEVERITY}" != "${SVT_IMPORTANT}" -a "${EACH_SEVERITY}" != "${SVT_MODERATE}" ]; then 189 if [ -z "${EACH_SEVERITY}" ]; then 190 echo "ERROR: ${DOC}: No severity found, please use Table to list what you '### Fixed'" 191 else 192 echo "ERROR: ${DOC}: Unknown severity: ${EACH_SEVERITY}" 193 fi 194 exit 1 195 fi 196 197 # echo "## EACH: $EACH_SEVERITY" 198 if [ -z "${TOP_SEVERITY}" ]; then 199 TOP_SEVERITY="${EACH_SEVERITY}" 200 elif [ "${TOP_SEVERITY}" == "${SVT_MODERATE}" ]; then 201 if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" -o "${EACH_SEVERITY}" == "${SVT_IMPORTANT}" ]; then 202 TOP_SEVERITY="${EACH_SEVERITY}" 203 fi 204 elif [ "${TOP_SEVERITY}" == "${SVT_IMPORTANT}" ]; then 205 if [ "${EACH_SEVERITY}" == "${SVT_CRITIAL}" ]; then 206 TOP_SEVERITY="${EACH_SEVERITY}" 207 fi 208 fi 209 done < ${DIFF_DOC_FIXED} 210 211 if [ "${SEVERITY}" != "${TOP_SEVERITY}" ]; then 212 echo "ERROR: ${DOC}: Top severity should be '${TOP_SEVERITY}' as it's the highest level of all sub severity" 213 exit 1 214 fi 215 216 # check top severity miss match 217 if [ ! -z ${LAST_SEVERITY} ]; then 218 if [ "${LAST_SEVERITY}" == "普通" -a "${TOP_SEVERITY}" != "moderate" ]; then 219 MISS_MATCH="y" 220 elif [ "${LAST_SEVERITY}" == "重要" -a "${TOP_SEVERITY}" != "important" ]; then 221 MISS_MATCH="y" 222 elif [ "${LAST_SEVERITY}" == "紧急" -a "${TOP_SEVERITY}" != "critical" ]; then 223 MISS_MATCH="y" 224 elif [ "${LAST_SEVERITY}" == "moderate" -a "${TOP_SEVERITY}" != "普通" ]; then 225 MISS_MATCH="y" 226 elif [ "${LAST_SEVERITY}" == "important" -a "${TOP_SEVERITY}" != "重要" ]; then 227 MISS_MATCH="y" 228 elif [ "${LAST_SEVERITY}" == "critical" -a "${TOP_SEVERITY}" != "紧急" ]; then 229 MISS_MATCH="y" 230 fi 231 232 if [ "${MISS_MATCH}" == "y" ]; then 233 echo "ERROR: ${DOC}: top Severity is '${SEVERITY}', while ${LAST_DOC}: top Severity is '${LAST_SEVERITY}'" 234 echo " Available Severity types are: moderate(普通), important(重要), critical(紧急)" 235 exit 1 236 fi 237 fi 238 239 LAST_SEVERITY="${SEVERITY}" 240 LAST_DOC="${DOC}" 241 fi 242} 243 244function check_docs() 245{ 246 if git log ${ARG_COMMIT} -1 --name-only | grep -Eq '\.bin|\.elf' ; then 247 DOC_CN=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_CN\.md/p"` 248 DOC_EN=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/_EN\.md/p"` 249 if [ -z "${DOC_CN}" -o -z "${DOC_EN}" ]; then 250 echo "ERROR: Should update CN and EN Release-Note when .bin/elf changed" 251 exit 1 252 fi 253 254 NUM=`git log ${ARG_COMMIT} -1 --name-only | sed -n "/\.md/p" | wc -l` 255 if [ ${NUM} -gt 2 ]; then 256 echo "ERROR: More than 2 release note are updated" 257 exit 1 258 fi 259 260 if ! which dos2unix > /dev/null 2>&1 ; then 261 echo "ERROR: No 'dos2unix'. Fix by: sudo apt-get install dos2unix" 262 exit 1 263 fi 264 265 check_doc CN 266 check_doc EN 267 fi 268 269 rm -f ${DIFF_SUBSET} 270} 271 272function pack_loader_image() 273{ 274 for FILE in `ls ./RKBOOT/*MINIALL*.ini` 275 do 276 if [ "${FILE}" = "./RKBOOT/RK302AMINIALL.ini" -o \ 277 "${FILE}" = "./RKBOOT/RK30BMINIALL.ini" -o \ 278 "${FILE}" = "./RKBOOT/RK30MINIALL.ini" -o \ 279 "${FILE}" = "./RKBOOT/RK310BMINIALL.ini" ]; then 280 continue; 281 fi 282 283 if grep -q '^PATH=img/' ${FILE}; then 284 continue; 285 fi 286 287 echo "Pack loader: ${FILE}" 288 ./tools/boot_merger ${FILE} 289 rm -f *loader*.bin *download*.bin *idblock*.img 290 echo 291 done 292} 293 294function pack_trust_image() 295{ 296 # Pack 32-bit trust 297 for FILE in `ls ./RKTRUST/*TOS*.ini` 298 do 299 if ! test -s ${FILE}; then 300 continue; 301 elif ! grep -q 'TOS' ${FILE}; then 302 continue; 303 elif grep -q '^PATH=img/' ${FILE}; then 304 continue; 305 fi 306 307 echo "Pack trust: ${FILE}" 308 # Parse orignal path 309 TOS=`sed -n "/TOS=/s/TOS=//p" ${FILE}|tr -d '\r'` 310 TOS_TA=`sed -n "/TOSTA=/s/TOSTA=//p" ${FILE}|tr -d '\r'` 311 312 # replace "./tools/rk_tools/" with "./" to compatible legacy ini content of rkdevelop branch 313 TOS=$(echo ${TOS} | sed "s/tools\/rk_tools\//\.\//g") 314 TOS_TA=$(echo ${TOS_TA} | sed "s/tools\/rk_tools\//\.\//g") 315 316 if [ x${TOS_TA} != x -a x${TOS} != x ]; then 317 ./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000 318 ./tools/loaderimage --pack --trustos ${TOS_TA} ./trust_with_ta.img 0x68400000 319 elif [ ${TOS} ]; then 320 ./tools/loaderimage --pack --trustos ${TOS} ./trust.img 0x68400000 321 elif [ ${TOS_TA} ]; then 322 ./tools/loaderimage --pack --trustos ${TOS_TA} ./trust.img 0x68400000 323 else 324 exit 1 325 fi 326 rm -f trust*.img 327 echo 328 done 329 330 # Pack 64-bit trust 331 for FILE in `ls ./RKTRUST/*TRUST*.ini` 332 do 333 if grep -q '^PATH=img/' ${FILE}; then 334 continue; 335 fi 336 337 echo "Pack trust: ${FILE}" 338 ./tools/trust_merger ${FILE} 339 rm -f trust*.img 340 echo 341 done 342} 343 344function check_dirty() 345{ 346 for FILE in `find -name '*spl*.bin' -o -name '*tpl*.bin' -o -name '*usbplug*.bin' -o -name '*bl31*.elf' -o -name '*bl32*.bin'`; do 347 echo "Checking clean: ${FILE}" 348 if strings ${FILE} | grep '\-dirty ' ; then 349 echo "ERROR: ${FILE} is dirty" 350 exit 1 351 fi 352 done 353} 354 355function check_stripped() 356{ 357 for FILE in `find -name '*bl31*.elf'`; do 358 echo "Checking strip: ${FILE}" 359 INFO=`file ${FILE}` 360 if echo ${INFO} | grep -q "not stripped" ; then 361 echo "ERROR: ${FILE} is not stripped" 362 exit 1 363 fi 364 done 365} 366 367function check_mode() 368{ 369 echo "Checking file mode..." 370 if git whatchanged ${ARG_COMMIT} -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | awk '{ print $2 }' | grep -q 755 ; then 371 git whatchanged ${ARG_COMMIT} -1 --oneline | sed -n '/RKBOOT\//p; /RKTRUST\//p; /bin\//p; /doc\//p;' | grep 755 372 echo "ERROR: Set 644 file permission but not 755." 373 exit 1 374 fi 375} 376 377function finish() 378{ 379 echo "OK, everything is nice." 380 echo 381} 382 383check_mode 384check_docs 385check_dirty 386check_stripped 387pack_loader_image 388pack_trust_image 389finish 390