From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-47920-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 22495 invoked by alias); 5 Mar 2007 22:01:29 -0000
Received: (qmail 22487 invoked by uid 22791); 5 Mar 2007 22:01:29 -0000
X-Spam-Check-By: sourceware.org
Received: from mail.codesourcery.com (HELO mail.codesourcery.com) (65.74.133.4)     by sourceware.org (qpsmtpd/0.31) with ESMTP; Mon, 05 Mar 2007 22:01:21 +0000
Received: (qmail 3840 invoked from network); 5 Mar 2007 22:01:19 -0000
Received: from unknown (HELO localhost) (jimb@127.0.0.2)   by mail.codesourcery.com with ESMTPA; 5 Mar 2007 22:01:19 -0000
To: Eli Zaretskii <eliz@gnu.org>
Cc: Mark Kettenis <mark.kettenis@xs4all.nl>,  deuling@de.ibm.com, 	  pedro_alves@portugalmail.pt,  gdb-patches@sourceware.org
Subject: Re: [Patch]: Little Cleanup
References: <45E7CC17.5040304@de.ibm.com> <45E93AE5.5050704@portugalmail.pt> 	<ulkie62od.fsf@gnu.org> <45EBB15E.4000602@de.ibm.com> 	<uvehfmmfj.fsf@gnu.org> 	<200703052119.l25LJKVw021917@brahms.sibelius.xs4all.nl> 	<utzwzmlk7.fsf@gnu.org>
From: Jim Blandy <jimb@codesourcery.com>
Date: Mon, 05 Mar 2007 22:01:00 -0000
In-Reply-To: <utzwzmlk7.fsf@gnu.org> (Eli Zaretskii's message of "Mon, 05 Mar 2007 23:23:36 +0200")
Message-ID: <m3odn7gxjl.fsf@codesourcery.com>
User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2007-03/txt/msg00051.txt.bz2


Eli Zaretskii <eliz@gnu.org> writes:
>> Date: Mon, 5 Mar 2007 22:19:20 +0100 (CET)
>> From: Mark Kettenis <mark.kettenis@xs4all.nl>
>> CC: deuling@de.ibm.com, pedro_alves@portugalmail.pt,
>>         gdb-patches@sourceware.org
>> > 
>> > I thought we agreed about adding a comment here, something like:
>> > 
>> >   /* insert_breakpoints returns non-zero if it fails to insert the
>> >      breakpoints.  */
>> 
>> Adding this sort of comments at all call sites of such functions is
>> really silly.
>
> I don't see anything silly about making the code clearer.

I'm confident Mark believes clarifying code is not silly.  I think
Mark disagrees that the comment you requested is, in fact, a
clarification.

I tend to agree with Mark, here.  The place to document the meaning of
a function's return value is at the function, not at each of its call
sites.