From: Robert Dewar <dewar@adacore.com>
To: Markus Deuling <deuling@de.ibm.com>
Cc: Eli Zaretskii <eliz@gnu.org>,
pkoning@equallogic.com, jimb@codesourcery.com,
eager@eagercon.com, stanshebs@earthlink.net,
gdb@sources.redhat.com
Subject: Re: What's an annex? stratum?
Date: Tue, 26 Jun 2007 18:36:00 -0000 [thread overview]
Message-ID: <46815C98.5080208@adacore.com> (raw)
In-Reply-To: <46815BC2.9070204@de.ibm.com>
Markus Deuling wrote:
> Eli Zaretskii wrote:
>
>> That's not surprising: programmers don't like writing documentation as
>> much as they like writing code. That is one reason why gdbint.texinfo
>> is in such poor shape.
>>
>> In any case, if people here believe comments are a reasonable
>> substitute for documentation, perhaps I should from now on reject code
>> patches that do not explain themselves clearly, and do not contain
>> enough references to other related portions of GDB.
>>
>
> Maybe the process of getting a patch into mainline should be changed. Currently a patch without a proper
> Changelog has no chance. Maybe we should extend that and say a patch must have Changelog and one or two
> lines (or even moren) in documentation whenever reasonable.
It's a very important principle that stuff in the changelog is *not* a
substitute for proper documentation in the source. That's a common
mistake (I catch it all the time in the GNAT sources, where all
checkins get reviewed by me with this in mind :-))
>
> For example the guy that wrote the part for inferior function calls definitely wrote no doc :-)
>
> For my opinion GDB's Internal Manual is very important and should be cultivated much more.
>
next prev parent reply other threads:[~2007-06-26 18:36 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-06-23 18:01 Michael Eager
2007-06-23 18:57 ` Stan Shebs
2007-06-23 19:08 ` Michael Eager
2007-06-23 19:47 ` Eli Zaretskii
2007-06-23 20:51 ` Michael Eager
2007-06-23 21:23 ` Daniel Jacobowitz
2007-06-23 21:40 ` Michael Eager
2007-06-24 2:58 ` Eli Zaretskii
2007-06-24 4:32 ` Michael Eager
2007-06-25 18:03 ` Jim Blandy
2007-06-25 18:39 ` Michael Eager
2007-06-25 19:10 ` Jim Blandy
2007-06-25 19:26 ` Paul Koning
2007-06-25 19:32 ` Daniel Jacobowitz
2007-06-25 19:38 ` Robert Dewar
2007-06-25 19:48 ` Paul Koning
2007-06-25 20:09 ` Michael Eager
2007-06-25 20:40 ` Robert Dewar
2007-06-25 20:47 ` Robert Dewar
2007-06-25 20:31 ` Eli Zaretskii
2007-06-25 20:44 ` Robert Dewar
2007-06-25 21:00 ` Eli Zaretskii
2007-06-25 21:03 ` Robert Dewar
2007-06-25 21:06 ` Robert Dewar
2007-06-26 18:34 ` Markus Deuling
2007-06-26 18:36 ` Robert Dewar [this message]
2007-06-26 21:55 ` Jim Blandy
2007-06-26 22:14 ` Nick Roberts
2007-06-26 23:26 ` Robert Dewar
2007-06-26 23:39 ` Joel Brobecker
2007-06-26 23:43 ` Robert Dewar
2007-06-27 0:32 ` Jim Blandy
2007-06-27 0:42 ` Robert Dewar
2007-06-27 3:22 ` Eli Zaretskii
2007-06-27 0:23 ` Michael Eager
2007-06-25 20:42 ` Eli Zaretskii
2007-06-25 20:23 ` Eli Zaretskii
2007-06-25 21:52 ` Jim Blandy
2007-06-26 1:04 ` Paul Koning
2007-06-25 20:37 ` Eli Zaretskii
2007-06-25 20:15 ` Eli Zaretskii
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=46815C98.5080208@adacore.com \
--to=dewar@adacore.com \
--cc=deuling@de.ibm.com \
--cc=eager@eagercon.com \
--cc=eliz@gnu.org \
--cc=gdb@sources.redhat.com \
--cc=jimb@codesourcery.com \
--cc=pkoning@equallogic.com \
--cc=stanshebs@earthlink.net \
/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