diff --git a/doc/developer/interface.xml b/doc/developer/interface.xml index f2c9f22ded..7fd671a947 100644 --- a/doc/developer/interface.xml +++ b/doc/developer/interface.xml @@ -293,36 +293,40 @@ a Modules.am file in it. In this file, put something like : SOURCES_yourmodule = myfile1.c myfile2.c -Then, go to the main configure.ac file, and -at the end, in the AC_CONFIG_FILES section, add a -line similar to the others. +Then go to the main configure.ac file, and +add in the AC_CONFIG_FILES section (towards the +end of the file) a line similar to the others. -If you don't create a directory for your plugin (just put it in -an existing one), you only have to add the two SOURCES_... lines to -the existing Modules.am file +If you don't create a directory for your plugin (but instead +just put it in an existing directory), you only have to add the two +SOURCES_... lines to the existing Modules.am +file -By doing this, your module is declared, but it will never automatically -compile. +This declares your module; it does not arrange for it to be +automatically compiled; automatic compilatoin is described further +below. + +You do not write a Makefile for your +module. Instead this is done via the bootstrap and configuration +process. So now run: + -You then have to restart from the beginning the build sequence, so: ./bootstrap -./configure... +./configure configure-options make -To build the module, you have to do it manually, by going to its -directory, and typing -make libyourmodule_plugin.so (or .dll, ora +To build the module manually, go to the +directory it resides and type +make libyourmodule_plugin.so (or .dll, or whatever the file type for a shared library is on your Operating System.) -To automatize the build of your module, you must ask this in the -configure.ac file. - -If you want it to be always built, add it to -the default modules section -in configure.ac, in one -AX_ADD_PLUGINS directive. +To automatically have your module get +built, you also set this in the configure.ac +file; add your module name to the default modules +section in one of the +AX_ADD_PLUGINS directives.