You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by pa...@apache.org on 2020/09/27 20:27:35 UTC
[felix-atomos] branch master updated: Update documentation after
equionx and felix substrate example merge
This is an automated email from the ASF dual-hosted git repository.
pauls pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/felix-atomos.git
The following commit(s) were added to refs/heads/master by this push:
new 895fe24 Update documentation after equionx and felix substrate example merge
895fe24 is described below
commit 895fe24755c42032a875e15d5b05d457a406d0cb
Author: Karl Pauls <ka...@gmail.com>
AuthorDate: Sun Sep 27 22:27:24 2020 +0200
Update documentation after equionx and felix substrate example merge
---
atomos.examples/README.md | 4 ++--
atomos.examples/SUBSTRATE.md | 4 +++-
atomos.examples/atomos.examples.substrate.lib/README.md | 4 ++--
3 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/atomos.examples/README.md b/atomos.examples/README.md
index 8d27687..285f643 100644
--- a/atomos.examples/README.md
+++ b/atomos.examples/README.md
@@ -4,7 +4,7 @@ The following examples are available:
1. [Atomos Index example](atomos.examples.index/README.md) - Assembles an executable JAR which uses an Atomos index for bundle entry content.
1. [Atomos jlink example](atomos.examples.jlink/README.md) - Assembles a jlink image that loads the framework and a set of bundles as modules included in a fit for purpose JVM image
1. [Atomos Spring Loader example](atomos.examples.springloader/README.md) - Assembles an executable JAR that uses the Spring Jar loader to load bundle content from embedded JAR files.
-1. Atomos native-image example ([Equinox](atomos.examples.substrate.equinox/README.md) and [Felix](atomos.examples.substrate.felix/README.md)) - Assembles a native image using Graal Substrate to load the framework and a set of bundles
+1. [Atomos native-image example](atomos.examples.substrate.lib/README.md) - Assembles a native image using Graal Substrate to load the framework and a set of bundles
1. Atomos native-image example ([atomos-maven-plugin](atomos.examples.substrate.maven.equinox/README.md)) - Assembles a native image using Graal Substrate with the atomos-maven-plugin
1. [Atomos Android example](atomos.examples.android/README.md) - Uses the result of the [Atomos index example](atomos.examples.index/README.md) to build an Android application
-1. [Atomos JAX-RS example](atomos.examples.jaxrs/README.md) - Uses Aries JAX-RS [whiteboard](https://github.com/apache/aries-jax-rs-whiteboard) implementation for a simple JAX-RS resource example.
\ No newline at end of file
+1. [Atomos JAX-RS example](atomos.examples.jaxrs/README.md) - Uses Aries JAX-RS [whiteboard](https://github.com/apache/aries-jax-rs-whiteboard) implementation for a simple JAX-RS resource example.
diff --git a/atomos.examples/SUBSTRATE.md b/atomos.examples/SUBSTRATE.md
index a8dfa10..f745ee6 100644
--- a/atomos.examples/SUBSTRATE.md
+++ b/atomos.examples/SUBSTRATE.md
@@ -14,11 +14,13 @@ If using GraalVM CE 20.2.0 Java 8 then you must first use Java 11 for the main A
`./mvnw clean install -Pjava8 -Pequinox`
+To use the Felix Framework use `-Pfelix` instead of `-Pequinox`
+
Note that `install` target must be used so that Atomos is installed into your local m2 repository. This still requires Java 11 to be used to build but the result allows the `atomos.framework` JAR to be used on Java 8. Next you must switch to a Java installation of Graal with the Substrate native-image tools installed and then run the maven builds for the substrate example projects:
This will create a `target/atomos` executable in each substrate example project. If you launch `atomos` it will give you a gogo `g!` prompt to run gogo commands. Also included in this example is a version of the Felix web console. The web console can be access with http://localhost:8080/system/console/bundles and the id/password is admin/admin.
-For the Felix and Equinox example a directory `target/atomos_lib/` is created. This contains all the original bundle JARs that got compiled into the native image `atomos`. In order to launch the native `atomos` you must be in the directory containing both `atomos` and the `atomos_lib/` folder. This is a simple way for Atomos to discover the available bundles and load additional bundle entries at runtime.
+For the lib example a directory `target/atomos_lib/` is created. This contains all the original bundle JARs that got compiled into the native image `atomos`. In order to launch the native `atomos` you must be in the directory containing both `atomos` and the `atomos_lib/` folder. This is a simple way for Atomos to discover the available bundles and load additional bundle entries at runtime.
Alternatively a substrate image can be created that does not rely on the directory `target/atomos_lib/` to discover the bundles. Instead the bundle entry resources can be placed in an `atomos/` folder which is placed on the classpath during native image compilation. The resources from the `atomos/` folder can then be included in the native image. The `atomos/` folder has a file `bundles.index` that contains information for Atomos to discover the bundles and their entries that are inclu [...]
diff --git a/atomos.examples/atomos.examples.substrate.lib/README.md b/atomos.examples/atomos.examples.substrate.lib/README.md
index 8cf6c81..8d76a5a 100644
--- a/atomos.examples/atomos.examples.substrate.lib/README.md
+++ b/atomos.examples/atomos.examples.substrate.lib/README.md
@@ -1,6 +1,6 @@
-# Atomos Substrate Equinox Example
+# Atomos Substrate Example
-This example builds a native image that includes the Equinox Framework implementation with a set of bundles using Graal Substrate. See the substrate [README](../SUBSTRATE.md) for instructions on building the Substrate examples.
+This example builds a native image that includes the framework implementation with a set of bundles using Graal Substrate. See the substrate [README](../SUBSTRATE.md) for instructions on building the Substrate examples.
Buiding this example will create a `target/atomos` executable. If you launch `atomos` it will give you a gogo `g!` prompt to run gogo commands. Also included in this example is a version of the Felix web console. The web console can be access with http://localhost:8080/system/console/bundles and the id/password is admin/admin.