This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFC] remote-mips.c: Make sure that each function has an introductory comment
- From: Joel Brobecker <brobecker at adacore dot com>
- To: Kevin Buettner <kevinb at redhat dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Tue, 9 Mar 2010 09:24:45 +0400
- Subject: Re: [RFC] remote-mips.c: Make sure that each function has an introductory comment
- References: <20100308151822.2adfab51@redhat.com>
> * 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