Skip to content

Commit bce358d

Browse files
docs(archetype): corrections to archetype docs (#6199)
Signed-off-by: Marcello Rinaldo Martina <martina.marcello.rinaldo@outlook.com>
1 parent 37f7cfa commit bce358d

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

docs/java-application-development/kura-addon-archetype.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Don't forget to update the version in the various `MANIFEST.MF` of the bundles a
159159

160160
### Deploy artifacts
161161

162-
As default, the `distrib` project and the projects under `parent` are not deployed (they are configured to skip the execution of the `maven-deploy-plugin`). Only the BOM POM (the root `pom.xml`) and the single OSGi bundles are meant to be deployed.
162+
As default, the projects are not deployed (they are configured to skip the execution of the `maven-deploy-plugin`). Only the BOM POM (the root `pom.xml`) and the single OSGi bundles are meant to be deployed.
163163

164164
Please add the proper `maven-deploy-plugin` configuration for the bundles that need to be deployed. See the archetype's generated bundle for details.
165165

@@ -262,23 +262,21 @@ In the following sections we will see how this can be accomplished for the DEB p
262262

263263
```
264264
org.eclipse.kura.myartifact
265-
├── bundles
266-
│ ├── org.eclipse.kura.myartifact.bundle
267-
│ ├── org.eclipse.kura.myartifact.bundle.aarch64
268-
│ ├── org.eclipse.kura.myartifact.bundle.x86_64
265+
org.eclipse.kura.myartifact.aarch64
266+
org.eclipse.kura.myartifact.x86_64
269267
....
270268
```
271269

272-
The `org.eclipse.kura.myartifact.bundle` folder contains the agnostic code, while the `org.eclipse.kura.myartifact.bundle.aarch64` and `org.eclipse.kura.myartifact.bundle.x86_64` fragments contain the architecture-specific code.
270+
The `org.eclipse.kura.myartifact.bundle` contains the agnostic code, while the `org.eclipse.kura.myartifact.aarch64` and `org.eclipse.kura.myartifact.x86_64` fragments contain the architecture-specific code.
273271

274272
The objective is to produce two debian packages, one for each of the supported architectures. It is possible to modify the `pom.xml` in `distrib` to produce the correct metadata for the installers (see section below). Each debian package will install the main bundle and the relative fragment that matches the target environment. For example, the *aarch64* deb package will install:
275273

276274
```
277-
/opt/eclipse/kura/plugins/<start-level>s/org.eclipse.kura.myartifact.bundle-<version>.jar
278-
/opt/eclipse/kura/plugins/<start-level>/org.eclipse.kura.myartifact.bundle.aarch64-<version>.jar
275+
/opt/eclipse/kura/plugins/<start-level>s/org.eclipse.kura.myartifact-<version>.jar
276+
/opt/eclipse/kura/plugins/<start-level>/org.eclipse.kura.myartifact.aarch64-<version>.jar
279277
```
280278

281-
Note that the fragment `org.eclipse.kura.myartifact.bundle.aarch64-<version>.jar` is put in a plugins folder that is not ending with `s` since fragments can never be started as they don't have their own lifecycle.
279+
Note that the fragment `org.eclipse.kura.myartifact.aarch64-<version>.jar` is put in a plugins folder that is not ending with `s` since fragments can never be started as they don't have their own lifecycle.
282280

283281
### Create architecture dependant installers
284282

@@ -291,10 +289,10 @@ Section: admin
291289
Priority: optional
292290
Depends: kura
293291
Architecture: [[deb.architecture]]
294-
Maintainer: Eclipse Kura Developers <kura-dev@eclipse.org>
292+
Maintainer: [[deb.maintainer]]
295293
Description: [[summary]]
296294
[[long.description]]
297-
Homepage: https://eclipse-kura.github.io/kura/ (add correct link to documentation here)
295+
Homepage: [[deb.docs]]
298296
```
299297

300298
The Architecture field is the one responsible to specify the architecture of the package. The value is set in the `/distrib/pom.xml` file, by the property `<deb.architecture>all</deb.architecture>`. The value `all` means that the package can be installed on any architecture. This is the recommended value for packages that do not contain architecture-specific files.
@@ -318,10 +316,10 @@ Section: admin
318316
Priority: optional
319317
Depends: kura
320318
Architecture: [[deb.arm64.architecture]]
321-
Maintainer: Eclipse Kura Developers <kura-dev@eclipse.org>
319+
Maintainer: [[deb.maintainer]]
322320
Description: [[summary]]
323321
[[long.description]]
324-
Homepage: https://eclipse-kura.github.io/kura/
322+
Homepage: [[deb.docs]]
325323
```
326324

327325
The same file for the `amd64` architecture will just change the `Architecture` field to `[[deb.amd64.architecture]]`.

0 commit comments

Comments
 (0)