widelands-dev team mailing list archive

[GunChleoc <fios@xxxxxxxxxxxxxxxxxxx>]

GunChleoc has proposed merging lp:~widelands-dev/widelands/bug-1341674_codecheck into lp:widelands.

Requested reviews:
  Widelands Developers (widelands-dev)
Related bugs:
  Bug #1341674 in widelands: "Consolidate TODO FIXME BUG to one style."
  https://bugs.launchpad.net/widelands/+bug/1341674

For more details, see:
https://code.launchpad.net/~widelands-dev/widelands/bug-1341674_codecheck/+merge/227936

Codecheck rule for https://code.launchpad.net/~widelands-dev/widelands/bug-1341674

The other branch needs to be committed first, or this will flag up tons of stuff that isn't fixed in Trunk yet.
-- 
https://code.launchpad.net/~widelands-dev/widelands/bug-1341674_codecheck/+merge/227936
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/bug-1341674_codecheck into lp:widelands.

=== added file 'cmake/codecheck/rules/format_TODO_comments'
--- cmake/codecheck/rules/format_TODO_comments	1970-01-01 00:00:00 +0000
+++ cmake/codecheck/rules/format_TODO_comments	2014-07-23 14:52:16 +0000
@@ -0,0 +1,21 @@
+#!/usr/bin/python
+
+error_msg ="Please use the format \"TODO(<username>): ...\" for your TODO comments, and don't put them in the doygen comments"
+
+regexp = r"""(FIXME|(\s|/|[*])BUG|TODO(?![(])|\Wtodo(?![(])|[*]\s*TODO|///\s*TODO)"""
+
+forbidden = [
+    "// FIXME this is a todo comment",
+    "// BUG this is a todo comment",
+    "// TODO this is a todo comment",
+    "// TODO: This is a todo comment",
+    "* TODO: This is a todo comment",
+    "/// TODO: This is a todo comment",
+    "\TODO: This is a todo comment",
+    "\\\todo: This is a todo comment"
+]
+
+allowed = [
+    "// TODO(<username>) this is a todo comment",
+    "// TODO(<username>): This is a todo comment"
+]