From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 17268 invoked by alias); 2 Nov 2010 17:06:52 -0000 Received: (qmail 17256 invoked by uid 22791); 2 Nov 2010 17:06:51 -0000 X-SWARE-Spam-Status: No, hits=-1.9 required=5.0 tests=AWL,BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,SPF_HELO_PASS,T_RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from smtp-out.google.com (HELO smtp-out.google.com) (216.239.44.51) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 02 Nov 2010 17:06:46 +0000 Received: from hpaq5.eem.corp.google.com (hpaq5.eem.corp.google.com [172.25.149.5]) by smtp-out.google.com with ESMTP id oA2H6hX6017773 for ; Tue, 2 Nov 2010 10:06:44 -0700 Received: from gyb11 (gyb11.prod.google.com [10.243.49.75]) by hpaq5.eem.corp.google.com with ESMTP id oA2H39ds017191 for ; Tue, 2 Nov 2010 10:06:42 -0700 Received: by gyb11 with SMTP id 11so4850361gyb.22 for ; Tue, 02 Nov 2010 10:06:42 -0700 (PDT) MIME-Version: 1.0 Received: by 10.42.183.200 with SMTP id ch8mr12765601icb.245.1288717601836; Tue, 02 Nov 2010 10:06:41 -0700 (PDT) Received: by 10.220.192.73 with HTTP; Tue, 2 Nov 2010 10:06:41 -0700 (PDT) In-Reply-To: <201011021704.oA2H4gCc024129@glazunov.sibelius.xs4all.nl> References: <20101102163706.300142461AE@ruffy.mtv.corp.google.com> <201011021704.oA2H4gCc024129@glazunov.sibelius.xs4all.nl> Date: Tue, 02 Nov 2010 17:06:00 -0000 Message-ID: Subject: Re: [doc RFA] Use of FIXME, TODO, etc. in new code is prohibited. From: Doug Evans To: Mark Kettenis Cc: gdb-patches@sourceware.org Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable 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/msg00024.txt.bz2 On Tue, Nov 2, 2010 at 10:04 AM, Mark Kettenis wr= ote: >> Date: Tue, =A02 Nov 2010 09:37:06 -0700 (PDT) >> From: dje@google.com (Doug Evans) >> >> Ok to check in? > > I think this is absolutely silly. =A0If you really require all code to > be perfect and 100% complete, you'll never make progress. =A0It is much > better to make small incremental changes. =A0And if the author of such a > change realizes some of its deficiencies and bothers to document them > with a FIXME or a TODO, I consider that to be a good thing. fwiw, I agree. But I want to document what the rule(/convention) *is*, and the text as written is my current understanding of it. >> 2010-11-02 =A0Doug Evans =A0 >> >> =A0 =A0 =A0 * gdbint.texinfo (Coding Standards): Use of FIXME, TODO, etc. >> =A0 =A0 =A0 in new code is prohibited. >> >> Index: gdbint.texinfo >> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >> RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v >> retrieving revision 1.327 >> diff -u -p -r1.327 gdbint.texinfo >> --- gdbint.texinfo =A0 =A020 Oct 2010 22:53:36 -0000 =A0 =A0 =A01.327 >> +++ gdbint.texinfo =A0 =A02 Nov 2010 16:34:03 -0000 >> @@ -5855,6 +5855,9 @@ than trying to fit them into the 20 char >> =A0line, since either the comment or the code will inevitably get longer >> =A0than will fit, and then somebody will have to move it anyhow. >> >> +The use of @code{FIXME} and all similar comments in new code is prohibi= ted. >> +The rule is to not write code that requires them. >> + >> =A0@subsection C Usage >> >> =A0@cindex C data types >> @@ -5980,7 +5983,9 @@ They exist mainly for consistency with t >> =A0@itemize @bullet >> >> =A0@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. >> >> =A0@end itemize >> >> >