This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[doc RFA] Use of FIXME, TODO, etc. in new code is prohibited.
- From: dje at google dot com (Doug Evans)
- To: gdb-patches at sourceware dot org
- Date: Tue, 2 Nov 2010 09:37:06 -0700 (PDT)
- Subject: [doc RFA] Use of FIXME, TODO, etc. in new code is prohibited.
Ok to check in?
2010-11-02 Doug Evans <dje@google.com>
* gdbint.texinfo (Coding Standards): Use of FIXME, TODO, etc.
in new code is prohibited.
Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.327
diff -u -p -r1.327 gdbint.texinfo
--- gdbint.texinfo 20 Oct 2010 22:53:36 -0000 1.327
+++ gdbint.texinfo 2 Nov 2010 16:34:03 -0000
@@ -5855,6 +5855,9 @@ than trying to fit them into the 20 char
line, since either the comment or the code will inevitably get longer
than will fit, and then somebody will have to move it anyhow.
+The use of @code{FIXME} and all similar comments in new code is prohibited.
+The rule is to not write code that requires them.
+
@subsection C Usage
@cindex C data types
@@ -5980,7 +5983,9 @@ They exist mainly for consistency with t
@itemize @bullet
@item
-Use @code{FIXME} instead of @code{TODO}.
+The use of @code{TODO} is prohibited, as is @code{FIXME} and
+all similar comments.
+The rule is to not write code that requires them.
@end itemize