From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 10911 invoked by alias); 2 Nov 2010 16:37:17 -0000 Received: (qmail 10730 invoked by uid 22791); 2 Nov 2010 16:37:15 -0000 X-SWARE-Spam-Status: No, hits=-4.4 required=5.0 tests=AWL,BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,RCVD_IN_DNSWL_HI,SPF_HELO_PASS,T_RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from smtp-out.google.com (HELO smtp-out.google.com) (74.125.121.35) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 02 Nov 2010 16:37:11 +0000 Received: from kpbe15.cbf.corp.google.com (kpbe15.cbf.corp.google.com [172.25.105.79]) by smtp-out.google.com with ESMTP id oA2Gb7At015940 for ; Tue, 2 Nov 2010 09:37:08 -0700 Received: from ruffy.mtv.corp.google.com (ruffy.mtv.corp.google.com [172.18.118.116]) by kpbe15.cbf.corp.google.com with ESMTP id oA2Gb6x0013776 for ; Tue, 2 Nov 2010 09:37:06 -0700 Received: by ruffy.mtv.corp.google.com (Postfix, from userid 67641) id 300142461AE; Tue, 2 Nov 2010 09:37:06 -0700 (PDT) To: gdb-patches@sourceware.org Subject: [doc RFA] Use of FIXME, TODO, etc. in new code is prohibited. Message-Id: <20101102163706.300142461AE@ruffy.mtv.corp.google.com> Date: Tue, 02 Nov 2010 16:37:00 -0000 From: dje@google.com (Doug Evans) X-System-Of-Record: true X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2010-11/txt/msg00020.txt.bz2 Ok to check in? 2010-11-02 Doug Evans * 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