SF.net SVN: geany: [2408] trunk/HACKING

[ntrel at users.sourceforge.net]

Revision: 2408
          http://geany.svn.sourceforge.net/geany/?rev=2408&view=rev
Author:   ntrel
Date:     2008-03-26 06:35:34 -0700 (Wed, 26 Mar 2008)

Log Message:
-----------
Add note about not appending to structs like KeyBindingGroup and
GeanyCallback.

Modified Paths:
--------------
    trunk/HACKING

Modified: trunk/HACKING
===================================================================
--- trunk/HACKING	2008-03-26 13:29:43 UTC (rev 2407)
+++ trunk/HACKING	2008-03-26 13:35:34 UTC (rev 2408)
@@ -19,8 +19,6 @@
 tool. Run 'make api-doc' in the doc subdirectory. The documentation will
 be output to doc/reference/index.html.
 
-See the Related Pages section for a link to the plugin howto.
-
 Patches
 -------
 We are happy to receive patches, but it's best to check with us by email
@@ -49,9 +47,14 @@
 -----------------------------
 Please be aware that anything with a doc-comment (a comment with an
 extra asterix: '/**') is something in the plugin API. Things like enums
-and structs can still be appended to, ensuring that all the existing
-elements stay in place - this will keep the ABI stable.
+and structs can usually still be appended to, ensuring that all the
+existing elements stay in place - this will keep the ABI stable.
 
+Note: Some structs like KeyBindingGroup and GeanyCallback cannot be
+appended to without breaking the ABI because they are used to declare
+structs by plugins, not just for accessing struct members through
+a pointer.
+
 Before the 1.0 release series, the ABI can change when necessary, and
 even the API can change. An ABI change just means that all plugins will
 not load and they must be rebuilt.  An API change means that some plugins


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.