From: Joel Brobecker <brobecker@adacore.com>
To: Kevin Buettner <kevinb@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFC] remote-mips.c: Make sure that each function has an introductory comment
Date: Tue, 09 Mar 2010 05:25:00 -0000 [thread overview]
Message-ID: <20100309052445.GA28410@adacore.com> (raw)
In-Reply-To: <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
next prev parent reply other threads:[~2010-03-09 5:25 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-03-08 22:18 Kevin Buettner
2010-03-09 5:25 ` Joel Brobecker [this message]
2010-03-09 17:50 ` Eli Zaretskii
2010-03-10 5:37 ` Kevin Buettner
2010-03-10 17:08 ` Eli Zaretskii
2010-03-11 3:48 ` Kevin Buettner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100309052445.GA28410@adacore.com \
--to=brobecker@adacore.com \
--cc=gdb-patches@sourceware.org \
--cc=kevinb@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox