aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-11-16 09:36:49 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-11-16 09:36:49 +0000
commit95086f46d8f5b76f5ea14511e5bede3c27d57b3e (patch)
tree3e81f65d7796d427b1a5081d53363443bbce5f17
parentb2d18ffacfb041b7c91c0533cb226606625569f2 (diff)
downloadpaludis-95086f46d8f5b76f5ea14511e5bede3c27d57b3e.tar.gz
paludis-95086f46d8f5b76f5ea14511e5bede3c27d57b3e.tar.xz
Include note on compiling c++ code. Fixes: ticket:441
-rw-r--r--doc/api/index.html.part14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/index.html.part b/doc/api/index.html.part
index 3a10cea..2089186 100644
--- a/doc/api/index.html.part
+++ b/doc/api/index.html.part
@@ -14,6 +14,20 @@
</li>
</ul>
+<h2 id="compiling">Compiling C++ Code</h2>
+
+<p>You will need to specify various compiler flags when compiling C++ code. The usual way to do this is via
+<code>pkg-config</code>:</p>
+
+<pre>
+$ g++ -c `pkg-config --cflags paludis` -o example_command_line.o example_command_line.cc
+$ g++ -c `pkg-config --cflags paludis` -o example_action.o example_action.cc
+$ g++ `pkg-config --libs paludis` -o example_action example_command_line.o example_action.o
+</pre>
+
+<p>If you are using autotools, consider using <code>PKG_CHECK_MODULES</code> rather than calling <code>pkg-config</code>
+by hand.</p>
+
<h2 id="examples">Examples</h2>
<p>There are examples showing how to use various classes. Many examples are available in more than one language, showing