summaryrefslogtreecommitdiff
path: root/src/site/apt/examples.apt
diff options
context:
space:
mode:
authorMark Donszelmann <Mark.Donszelmann@gmail.com>2009-10-29 11:38:17 +0100
committerMark Donszelmann <Mark.Donszelmann@gmail.com>2009-10-29 11:38:17 +0100
commitb36dbcf19e08413b888e5a2d49dc9db44557624e (patch)
tree196757eec0917adbeee2a75c649042bbed6fe5d1 /src/site/apt/examples.apt
parentd439a5103e8e9fe529ed20961967ee02b7386379 (diff)
downloadmaven-nar-plugin-b36dbcf19e08413b888e5a2d49dc9db44557624e.tar.gz
maven-nar-plugin-b36dbcf19e08413b888e5a2d49dc9db44557624e.tar.bz2
maven-nar-plugin-b36dbcf19e08413b888e5a2d49dc9db44557624e.tar.xz
maven-nar-plugin-b36dbcf19e08413b888e5a2d49dc9db44557624e.zip
Fixed NAR-95
Diffstat (limited to 'src/site/apt/examples.apt')
-rw-r--r--src/site/apt/examples.apt64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/site/apt/examples.apt b/src/site/apt/examples.apt
new file mode 100644
index 0000000..2ce7120
--- /dev/null
+++ b/src/site/apt/examples.apt
@@ -0,0 +1,64 @@
+ ---
+Maven NAR Plugin
+ ---
+ ---
+Mark Donszelmann
+ ---
+
+Examples
+
+ These example contain a simple C method "sayHello". This method can be called from a C program, a Java program, put into
+a static library, put into a shared library, use as a third party library, ...
+There are also some unit test which are run and call the same method. All examples are available in the src/it
+directory.
+
+ The following examples are available:
+
+ [it0001-executable] A C routine.
+
+ [it0002-executable-static] A C routine statically linked with the C-runtime library.
+
+ []
+
+ [it0003-jni] A C routine called from Java.
+
+ [it0004-java-dep-jni] A java project which depends on "jni".
+
+ [it0005-jni-static] A C routine called from Java statically linked with the C-runtime library.
+
+ [it0006-jni-3rdparty] A third party JNI library called from Java.
+ The third party library is the "jni" from the example above and is added as resource to the project in the
+ form of a JNI library and a corresponding jar file. The "jni" lib is currently provided for the following
+ platforms:
+
+ * x86_64-MacOSX-g++
+
+ []
+
+ []
+
+ [it0007-lib-shared] A C routine which gets archived into a shared library. A C test executable
+ is created.
+
+ [it0008-executable-dep-lib-shared] A C executable which depends on "lib-shared" and links dynamically
+ with it. The executable is created and run.
+
+ [it0009-jni-dep-lib-shared] A C routine called from Java, which depends on
+ "lib-shared" and links dynamically with it.
+
+ []
+
+ [it0010-lib-static] A C routine which gets archived into a static library. A C test executable
+ is created.
+
+ [it0011-executable-dep-lib-static] A C executable which depends on "lib-static" and links statically
+ with it. The executabe is created and run.
+
+ [it0012-jni-dep-lib-static] A C routine called from Java, which depends on
+ "lib-static" and links statically with it.
+
+ []
+
+ These examples are now all run as integration tests by running maven on the maven-nar-plugin from its top-level directory with the profile "run-its".
+
+