This is the mail archive of the
gdb-patches@sources.redhat.com
mailing list for the GDB project.
Re: [RFA/doco] Add documentation for observer.[hc] (gdbint.texinfo)
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