From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6380 invoked by alias); 9 Mar 2010 05:25:08 -0000 Received: (qmail 6358 invoked by uid 22791); 9 Mar 2010 05:25:06 -0000 X-SWARE-Spam-Status: No, hits=-2.5 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 09 Mar 2010 05:25:02 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 37CF92BAB6C; Tue, 9 Mar 2010 00:25:01 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id QwsXCO6EC+U9; Tue, 9 Mar 2010 00:25:01 -0500 (EST) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id AC5342BAB69; Tue, 9 Mar 2010 00:25:00 -0500 (EST) Received: by joel.gnat.com (Postfix, from userid 1000) id 156E0F5894; Tue, 9 Mar 2010 09:24:45 +0400 (RET) Date: Tue, 09 Mar 2010 05:25:00 -0000 From: Joel Brobecker To: Kevin Buettner Cc: gdb-patches@sourceware.org Subject: Re: [RFC] remote-mips.c: Make sure that each function has an introductory comment Message-ID: <20100309052445.GA28410@adacore.com> References: <20100308151822.2adfab51@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20100308151822.2adfab51@redhat.com> User-Agent: Mutt/1.5.20 (2009-06-14) 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-03/txt/msg00350.txt.bz2 > * remote-mips.c (close_ports, mips_initialize_cleanups) > (mips_exit_cleanups, mips_send_command, mips_open, pmon_open) > (ddb_open, lsi_open, mips_remove_breakpoint, mips_remove_watchpoint) > (mips_stopped_by_watchpoint, send_srec, pmon_checkset) > (pmon_make_fastrec, pmon_check_ack, mips_expect_download) > (pmon_check_entry_address, pmon_check_total, pmon_end_download) > (pmon_download, pmon_load_fast, _initialize_remote_mips): Add > comments describing each of these functions. > (mips_enter_debug, mips_exit_debug, common_open) > (mips_signal_from_protocol, pmon_makeb64, pmon_zeroset): Add > blank line after the comment describing the function. This has to be one of the most clearly written documentation I've seen in a while. Jim Blandy also produces very good docs... I think you know the code better than most, so you should trust yourself. And it's not biggie if you're off a bit on one of the comments. FWIW, I had a quick look, and I couldn't spot any discrepancy. -- Joel