Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

Commit 781a490

Browse files
committed
improve documentation to switch to Sisu
1 parent 063e416 commit 781a490

File tree

4 files changed

+17
-7
lines changed

4 files changed

+17
-7
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Plexus IoC Container core with companion tools.
77

88
## Deprecated
99

10-
Plexus IoC Container is replaced by [Eclipse Sisu](https://www.eclipse.org/sisu/).
10+
Plexus IoC Container is replaced by [Eclipse Sisu](https://www.eclipse.org/sisu/): [sisu.inject](https://github.com/eclipse/sisu.inject), [sisu.plexus](https://github.com/eclipse/sisu.plexus), [sisu.mojos](https://github.com/eclipse/sisu.mojos/).
1111

1212
## Attention
1313

plexus-component-metadata/src/site/apt/index.apt.vm

+5
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,8 @@ ${project.name}
6464
Of course, patches are welcome, too. Contributors can check out the project from our
6565
{{{./source-repository.html}source repository}} and will find supplementary information in the
6666
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
67+
68+
* Deprecated
69+
70+
When using {{{https://www.eclipse.org/sisu/}Eclipse Sisu}} with {{{https://github.com/eclipse/sisu.plexus/wiki/Plexus-to-JSR330}JSR-330 <<<javax.inject>>> annotations}},
71+
use {{{https://github.com/eclipse/sisu.mojos/} <<<sisu-maven-plugin>>>}} instead of Plexus Component Metadata Maven Plugin.

plexus-container-default/src/site/apt/index.apt

+6-3
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ Overview
3535

3636
* Deprecated
3737

38-
<<<plexus-default-container>>> is replaced by {{{https://github.com/eclipse/sisu.inject}Sisu container}}
39-
and its {{{https://github.com/eclipse/sisu.plexus}Plexus shim <<<org.eclipse.sisu.plexus>>>}}
40-
({{{https://eclipse.github.io/sisu.plexus/apidocs/reference/packages.html}javadoc}}).
38+
<<<plexus-default-container>>> is replaced by:
39+
40+
* {{{https://github.com/eclipse/sisu.inject}Sisu container}}, reading <<<META-INF/sisu/javax.inject.Named>>> index files,
41+
42+
* and optional {{{https://github.com/eclipse/sisu.plexus}Plexus shim <<<org.eclipse.sisu.plexus>>>}} for compatibility with legacy Plexus <<<META-INF/plexus/components.xml>>>.
43+
See also Plexus shim {{{https://eclipse.github.io/sisu.plexus/apidocs/reference/packages.html}javadoc}}.

src/site/apt/index.apt

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
-----
2-
plexus-containers
2+
plexus-containers (deprecated)
33
-----
44
Hervé Boutemy
55
-----
@@ -16,7 +16,7 @@ Overview
1616

1717
and companion tools:
1818

19-
* {{{./plexus-component-metadata}plexus-component-metadata}}(-maven-plugin) is a Maven plugin to generate plexus <<<{{{./plexus-container-default/plexus-components.html}component.xml}}>>> from
19+
* {{{./plexus-component-metadata}plexus-component-metadata}}(-maven-plugin) is a Maven plugin to generate Plexus' <<<{{{./plexus-container-default/plexus-components.html}component.xml}}>>> from
2020
source javadoc tags and Java 5 class annotations,
2121

2222
* {{{./plexus-component-annotations}plexus-component-annotations}} provides the Java 5 annotations for plexus components,
@@ -30,4 +30,6 @@ Overview
3030

3131
* Deprecated
3232

33-
Plexus Containers is deprecated, replaced by {{{https://www.eclipse.org/sisu/}Eclipse Sisu}}: see each component documentation for more details.
33+
Plexus Containers is deprecated, replaced by {{{https://www.eclipse.org/sisu/}Eclipse Sisu}}
34+
({{{https://github.com/eclipse/sisu.inject}sisu.inject}}, {{{https://github.com/eclipse/sisu.plexus}sisu.plexus}}, {{{https://github.com/eclipse/sisu.mojos}sisu.mojos}}):
35+
see each Plexus Containers component (container, Maven plugin and annotations) documentation for more details on how to replace each one.

0 commit comments

Comments
 (0)