Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix documentation for Metatype annotation processing instructions #5380

Merged
merged 1 commit into from Sep 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion biz.aQute.bndlib/src/aQute/bnd/osgi/Constants.java
Expand Up @@ -168,7 +168,6 @@ public interface Constants {
String JAVA = "java";
String JAVA_DEBUG = "java.debug";
String MAKE = "-make";
String METATYPE = "-metatype";
String METATYPE_ANNOTATIONS = "-metatypeannotations";
String METATYPE_ANNOTATIONS_OPTIONS = "-metatypeannotations-options";
String MANIFEST = "-manifest";
Expand Down Expand Up @@ -555,4 +554,7 @@ public interface Constants {
/*
* Deprecated Section
*/
@Deprecated
String METATYPE = "-metatype";

}
4 changes: 2 additions & 2 deletions docs/_instructions/dsannotations-options.md
@@ -1,6 +1,6 @@
---
layout: default
class: Project
class: Builder
title: -dsannotations-options SELECTORS
summary: Options for controlling DS annotation processing.
---
Expand All @@ -12,7 +12,7 @@ The `-dsannotations-options` instruction configures how DS component annotations
-dsannotations-options: version;minimum=1.2.0;maximum=1.3.0
```

The example above, will restrict the use of OSGi DS annotations to minimum 1.2.0 and maximum 1.3.0 version. The version number denotes that the users are free to use any version equal to or higher than 1.2.0 but less than or equal to 1.3.0, provided that the users have the SCR annotations included in the workspace.
The example above, will restrict the use of OSGi DS annotations to minimum 1.2.0 and maximum 1.3.0 version. The version number denotes that the users are free to use any version equal to or higher than 1.2.0 but less than or equal to 1.3.0, provided that the users have the DS annotations included on the build path.

The following options are supported:

Expand Down
4 changes: 2 additions & 2 deletions docs/_instructions/dsannotations.md
@@ -1,8 +1,8 @@
---
layout: default
class: Project
class: Builder
title: -dsannotations SELECTORS
summary: Selects the packages that need processing for standard OSGi DS annotations.
summary: Selects the packages that need processing for standard OSGi DS annotations.
---

The `-dsannotations` instruction tells **bnd** which bundle classes, if any, to search for [Declarative Services (DS)](https://osgi.org/specification/osgi.cmpn/7.0.0/service.component.html) annotations. **bnd** will then process those classes into DS XML descriptors.
Expand Down
10 changes: 0 additions & 10 deletions docs/_instructions/metatype-options.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/_instructions/metatype.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/_instructions/metatypeannotations-options.md
@@ -0,0 +1,12 @@
---
layout: default
class: Builder
title: -metatypeannotations-options SELECTORS
summary: Restricts the use of Metatype Annotation to a minimum version.
---

```properties
-metatypeannotations-options: version;minimum=1.2.0
```

Analogous to `-dsannotations-options`, this will also restrict the use of OSGi Metatype annotations to minimum 1.2.0 version. The version number denotes that the users can use any version equal to or higher than 1.2.0, provided that the users have the Metatype annotations included on the build path.
16 changes: 16 additions & 0 deletions docs/_instructions/metatypeannotations.md
@@ -0,0 +1,16 @@
---
layout: default
class: Builder
title: -metatypeannotations SELECTORS
summary: Selects the packages that need processing for standard OSGi Metatype annotations.
---

The `-metatypeannotations` instruction tells **bnd** which bundle classes, if any, to search for [Metatype Service](https://osgi.org/specification/osgi.cmpn/7.0.0/service.metatype.html) annotations. **bnd** will then process those classes into Metatype XML resources.

The value of this instruction is a comma delimited list of fully qualified class names.

The default value of this instruction is `*`, which means that by default **bnd** will process all bundle classes looking for Metatype annotations.

The behavior of Metatype annotation processing can be further configured using the [-metatypeannotations-options](metatypeannotations-options.html) instruction.

[source](https://github.com/bndtools/bnd/blob/master/biz.aQute.bndlib/src/aQute/bnd/metatype/MetatypeAnnotations.java)