From: dje@google.com (Doug Evans)
To: gdb-patches@sourceware.org
Subject: [doc RFA] Use of FIXME, TODO, etc. in new code is prohibited.
Date: Tue, 02 Nov 2010 16:37:00 -0000 [thread overview]
Message-ID: <20101102163706.300142461AE@ruffy.mtv.corp.google.com> (raw)
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
next reply other threads:[~2010-11-02 16:37 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-02 16:37 Doug Evans [this message]
2010-11-02 17:04 ` Mark Kettenis
2010-11-02 17:06 ` Doug Evans
2010-11-02 18:49 ` Eli Zaretskii
2010-11-03 0:04 ` Stan Shebs
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20101102163706.300142461AE@ruffy.mtv.corp.google.com \
--to=dje@google.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox