Re: [doc RFA] Use of FIXME, TODO, etc. in new code is prohibited.

[Doug Evans <dje@google.com>]

On Tue, Nov 2, 2010 at 10:04 AM, Mark Kettenis <mark.kettenis@xs4all.nl> wrote:
>> 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.

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  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
>>
>>
>