Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Joel Brobecker <brobecker@gnat.com>
To: Eli Zaretskii <eliz@elta.co.il>
Cc: gdb-patches@sources.redhat.com
Subject: Re: [RFA/doco] Add documentation for observer.[hc] (gdbint.texinfo)
Date: Mon, 10 Mar 2003 19:01:00 -0000	[thread overview]
Message-ID: <20030310190118.GE967@gnat.com> (raw)
In-Reply-To: <3942-Sun09Mar2003180333+0200-eliz@elta.co.il>

Thanks, Eli and Daniel, for reviewing this patch.

I will make the recommended changes shortly, and send a followup patch.

There is one change that I am reluctant to make:
> > + The rationale for the current implementation of the Observer pattern
> > + is described in @file{observer.c}.
> 
> I'd suggest to copy that rationale from observer.c into the manual.

In my past experience, the only cases when any document describing a
piece of code remained up-to-date was when the document was embedded
with the source. So if we want this description to be in the manual, and
stay up-to-date, it needs to be automatically generated from the code.

In the long term, the plan is to automatically generate observer.texi.
How about placing a copy of the rationale in this appendix then?

-- 
Joel


  reply	other threads:[~2003-03-10 19:01 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-03-09  6:51 Joel Brobecker
2003-03-09 15:36 ` Daniel Jacobowitz
2003-03-10 14:41   ` Andrew Cagney
2003-03-10 18:46     ` Joel Brobecker
2003-03-09 16:10 ` Eli Zaretskii
2003-03-10 19:01   ` Joel Brobecker [this message]
2003-03-10 20:04     ` 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=20030310190118.GE967@gnat.com \
    --to=brobecker@gnat.com \
    --cc=eliz@elta.co.il \
    --cc=gdb-patches@sources.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