annotate PLUGIN_HOWTO @ 15784:eed84b59c252

There were a few problems here 1. Raw gnutls error codes were being printed in debug messages. This isn't necessarily bad, but it's much less useful than the text returned from gnutls_strerror(). Never underestimate the value of good error handling. 2. ssl_gnutls_read() and ssl_gnutls_write() were returning 0 when there was an error reading from or writing to the ssl connection. They should return -1 to indicate failure (0 normally indicates that the server closed the connection) 3. ssl_gnutls_read() and ssl_gnutls_write() weren't setting errno when they failed. errno would be set to something random, which seemed to frequently be EAGAIN for me when reading, which causes Gaim to keep trying to read from the connection even though it's closed. Ideally ssl-gnutls.c would have a function equivalent to set_errno() in ssl-nss.c, but the gnutls documentation does a poor job of telling you what possible error codes could be returned from gnutls_record_recv() and gnutls_record_send() Even better would be if we allowed the ssl plugins to keep track of the error message themselves, then added a new ssl ops function to fetch the message from the plugin.

For information on writing a plugin for Gaim, go
http://gaim.sourceforge.net/api/ and see the HOWTOs in the
"Related Pages" section.

You can also generate this documentation locally by installing
doxygen and graphviz dot, then running "make docs" in the Gaim
source tree.  The documentation will be in the docs/html directory.

This next paragraph is old and possibly out of date:
Compilation of the plugins is fairly straight-forward; there is a
Makefile in this directory that has a rule for making the .so file
from a .c file. No modification of the Makefile should be necessary,
unless if you simply want to type 'make' to have it made; otherwise,
'make filename.so' will take filename.c and make the .so plugin from
it. If you need to link in with extra libraries, you can set the
environment variable PLUGIN_LIBS to be the libraries you want to link
with.

It should be possible to compile plugins outside of the Gaim source
tree, which is a much cleaner solution.