After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 5746 - need docs on module system
need docs on module system
Status: RESOLVED FIXED
Product: GIMP
Classification: Other
Component: libgimp
git master
Other All
: High enhancement
: ---
Assigned To: GIMP Bugs
Daniel Egger
Depends on:
Blocks: 76955
 
 
Reported: 2000-01-31 21:05 UTC by Austin Donnelly
Modified: 2004-12-22 21:47 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Austin Donnelly 2001-01-28 15:48:31 UTC
Package: gimp
Severity: wishlist

Someone needs to document the module system.   The gtk colour selector
was intended to be that, but I think a bit more is needed.

Unfortunately, the best person to do this is probably me, but I
(almost certainly) don't have the time.  Someone else should look into
it - I'm willing to check stuff over for accuracy.

Austin




------- Additional Comments From neumanns@uni-duesseldorf.de 2000-02-10 14:21:31 ----

Subject: From: Sven Neumann <neumanns@uni-duesseldorf.de>
To: 5746@bugs.gnome.org
Cc: Austin Donnelly <austin@gimp.org>
Message-Id: <E12Iz8W-0001kQ-00@mail.ochsenblut.de>
Date: Thu, 10 Feb 2000 20:21:31 +0100


Hi Austin,

I talked to Mitch yesterady and we both don't seem to understand the 
module stuff good enough to do the documentation. BTW, shouldn't 
modregister.[ch] which is in the modules dir be part of libgimp? If
I understand this correctly you can't write a module without it.

Oh well, yes we need documentation. That's why I've now set up the
whole framework for documenting libgimp using gtk-doc. This makes 
writing documentation very easy. Don't you think you could find the 
time to go through the code and document the public C functions?
There is a README in the devel-docs directory describing what you'll
have to do and you can have a look at other files in libgimp that 
are already documented. If you don't want to set up gtk-doc and
the other stuff required to build the documentation, you could at
least add the necessary comments into the C files and check them 
in or send me patches. That could be done in an hour or two...


Salut, Sven




------- Bug moved to this database by debbugs-export@bugzilla.gnome.org 2001-01-28 10:48 -------
This bug was previously known as bug 5746 at http://bugs.gnome.org/
http://bugs.gnome.org/show_bug.cgi?id=5746
Originally filed under the gimp product and general component.

The original reporter (austin@gimp.org) of this bug does not have an account here.
Reassigning to the exporter, debbugs-export@bugzilla.gnome.org.
Reassigning to the default owner of the component, egger@suse.de.

Comment 1 Raphaël Quinet 2001-04-26 18:14:35 UTC
Re-assigning all Gimp bugs to default component owner (Gimp bugs list)
Comment 2 Daniel Egger 2001-10-03 14:19:52 UTC
Adding people to this bug and flipping some switches; sorry for the noise.
Comment 3 Leonard Evens 2002-08-11 02:04:35 UTC
I've now increased the tile cache size to 512 Mb, and at least with a
gray scale image, it seems to work much better, although it is still a
bit slow for some things.  Foolish me for believing what the GUM says.
 I'm still not sure I understand what is going on since 256 Mb is much
more memory than any single gray scale image.   From previous
experimentation with medium format when I had less memory, it was my
impression that I ran into trouble by making the tile cache size too
large, but perhaps that was wrong.   Some expert guidance would be
useful before I start experimenting with color.
Comment 4 Sven Neumann 2002-08-11 13:19:55 UTC
The comment above should probably have been added to bug #90421.
No idea why it was added here.
Comment 5 Michael Natterer 2003-01-02 21:36:36 UTC
Fixed in CVS. Could need more documentation but that's rather
a general problem than a module system bug.

2003-01-02  Michael Natterer  <mitch@gimp.org>

  * libgimpmodule/gimpmodule.[ch]
  * libgimpmodule/gimpmoduledb.[ch]: added API docs, removed cruft.
  Fixes bug #5746.

2003-01-02  Michael Natterer  <mitch@gimp.org>

  * libgimpmodule/libgimpmodule-sections.txt
  * libgimpmodule/tmpl/gimpmodule.sgml
  * libgimpmodule/tmpl/gimpmoduledb.sgml: updated. Documented
  enums and structs. Fixes bug #5746.