plugins.texi (Building GCC plugins): Added new section.

2009-06-17  Basile Starynkevitch  <basile@starynkevitch.net>

	* gcc/doc/plugins.texi (Building GCC plugins): Added new section.

From-SVN: r148612

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 2291ec21836ae5bc7457ec3865268a7bb27f7fe5..7c20d41fb35c802949ed32ef661b0dabf6180b06 100644 (file)
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,7 @@
+2009-06-17  Basile Starynkevitch  <basile@starynkevitch.net>
+
+       * doc/plugins.texi (Building GCC plugins): Added new section. 
+
 2009-06-17  Ian Lance Taylor  <iant@google.com>
 
        * c-pch.c (get_ident): Don't set size of templ array.

diff --git a/gcc/doc/plugins.texi b/gcc/doc/plugins.texi
index f02f931b102608656b64837ec7ff898651ddb054..9ae0a185f69fe2255b41516c4c4ed2596994d8e5 100644 (file)
--- a/gcc/doc/plugins.texi
+++ b/gcc/doc/plugins.texi
@@ -262,3 +262,37 @@ register_attributes (void *event_data, void *data)
 @}
 
 @end smallexample
+
+
+@section Building GCC plugins
+
+If plugins are enabled, GCC installs the headers needed to build a
+plugin (somehwere in the installation tree, e.g. under
+@file{/usr/local}).  In particular a @file{plugin/include} directory
+is installed, containing all the header files needed to build plugins.
+
+On most systems, you can query this @code{plugin} directory by
+invoking @command{gcc -print-file-name=plugin} (replace if needed
+@command{gcc} with the appropriate program path).
+
+The following GNU Makefile excerpt shows how to build a simple plugin:
+
+@smallexample
+GCC=gcc
+PLUGIN_SOURCE_FILES= plugin1.c plugin2.c
+PLUGIN_OBJECT_FILES= $(patsubst %.c,%.o,$(PLUGIN_SOURCE_FILES))
+GCCPLUGINS_DIR:= $(shell $(GCC) -print-file-name=plugin)
+CFLAGS+= -I$(GCCPLUGINS_DIR)/include -fPIC -O2
+
+plugin.so: $(PLUGIN_OBJECT_FILES)
+   $(GCC) -shared $^ -o $@
+@end smallexample
+
+A single source file plugin may be built with @code{gcc -I`gcc
+-print-file-name=plugin`/include -fPIC -shared -O2 plugin.c -o
+plugin.so}, using backquote shell syntax to query the @file{plugin}
+directory.
+
+Plugins needing to use @command{gengtype} require a GCC build
+directory for the same version of GCC that they will be linked
+against.