TODO convention.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Sun, 05 Aug 2012 23:26:34 +0300
changeset 249 5ad075a475f2
parent 248 a94915e43ca1
child 250 3557a963ce72
TODO convention.
HACKING.rst
Makefile
--- a/HACKING.rst	Wed Aug 01 09:14:08 2012 +0300
+++ b/HACKING.rst	Sun Aug 05 23:26:34 2012 +0300
@@ -71,6 +71,20 @@
 As 'dictd -c5' format does not support comment syntax we filter out all
 lines that start with '#'.
 
+TODO convention.
+================
+
+Entries or parts of text that was not completed marked by keywords:
+
+  TODO
+                incomplete
+  XXX
+                urgent incomplete
+
+Makefile rules ``todo`` find this occurrence in sources::
+
+  $ make todo
+
 World wide dictionary formats and standards.
 ============================================
 
--- a/Makefile	Wed Aug 01 09:14:08 2012 +0300
+++ b/Makefile	Sun Aug 05 23:26:34 2012 +0300
@@ -311,6 +311,10 @@
 echo; \
 sed -n -e '/^[[:alnum:]_-]*:/{s=^\(.*\):.*=  \1=;p;}' $(BUILD_SCRIPTS)
 
+.PHONY: todo
+todo:
+	grep -nH 'TODO\|XXX' $(RST_FILES) $(C5_FILES)
+
 .PHONY: stat
 stat: STAT.rst