From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 14818 invoked by alias); 2 Nov 2010 17:04:59 -0000 Received: (qmail 14534 invoked by uid 22791); 2 Nov 2010 17:04:57 -0000 X-SWARE-Spam-Status: No, hits=-2.1 required=5.0 tests=AWL,BAYES_00,T_RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from sibelius.xs4all.nl (HELO glazunov.sibelius.xs4all.nl) (83.163.83.176) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 02 Nov 2010 17:04:52 +0000 Received: from glazunov.sibelius.xs4all.nl (kettenis@localhost [127.0.0.1]) by glazunov.sibelius.xs4all.nl (8.14.3/8.14.3) with ESMTP id oA2H4hld012578; Tue, 2 Nov 2010 18:04:43 +0100 (CET) Received: (from kettenis@localhost) by glazunov.sibelius.xs4all.nl (8.14.3/8.14.3/Submit) id oA2H4gCc024129; Tue, 2 Nov 2010 18:04:42 +0100 (CET) Date: Tue, 02 Nov 2010 17:04:00 -0000 Message-Id: <201011021704.oA2H4gCc024129@glazunov.sibelius.xs4all.nl> From: Mark Kettenis To: dje@google.com CC: gdb-patches@sourceware.org In-reply-to: <20101102163706.300142461AE@ruffy.mtv.corp.google.com> (dje@google.com) Subject: Re: [doc RFA] Use of FIXME, TODO, etc. in new code is prohibited. References: <20101102163706.300142461AE@ruffy.mtv.corp.google.com> 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/msg00023.txt.bz2 > Date: Tue, 2 Nov 2010 09:37:06 -0700 (PDT) > From: dje@google.com (Doug Evans) > > Ok to check in? I think this is absolutely silly. If you really require all code to be perfect and 100% complete, you'll never make progress. It is much better to make small incremental changes. And 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. > 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 > >