Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

improve documentation to switch to Sisu #121

Merged
merged 1 commit into from
May 28, 2023
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Plexus IoC Container core with companion tools.

## Deprecated

Plexus IoC Container is replaced by [Eclipse Sisu](https://www.eclipse.org/sisu/).
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/).

## Attention

Expand Down
5 changes: 5 additions & 0 deletions plexus-component-metadata/src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,8 @@ ${project.name}
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Deprecated

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}},
use {{{https://github.com/eclipse/sisu.mojos/} <<<sisu-maven-plugin>>>}} instead of Plexus Component Metadata Maven Plugin.
9 changes: 6 additions & 3 deletions plexus-container-default/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ Overview

* Deprecated

<<<plexus-default-container>>> is replaced by {{{https://github.com/eclipse/sisu.inject}Sisu container}}
and its {{{https://github.com/eclipse/sisu.plexus}Plexus shim <<<org.eclipse.sisu.plexus>>>}}
({{{https://eclipse.github.io/sisu.plexus/apidocs/reference/packages.html}javadoc}}).
<<<plexus-default-container>>> is replaced by:

* {{{https://github.com/eclipse/sisu.inject}Sisu container}}, reading <<<META-INF/sisu/javax.inject.Named>>> index files,

* and optional {{{https://github.com/eclipse/sisu.plexus}Plexus shim <<<org.eclipse.sisu.plexus>>>}} for compatibility with legacy Plexus <<<META-INF/plexus/components.xml>>>.
See also Plexus shim {{{https://eclipse.github.io/sisu.plexus/apidocs/reference/packages.html}javadoc}}.
8 changes: 5 additions & 3 deletions src/site/apt/index.apt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
-----
plexus-containers
plexus-containers (deprecated)
-----
Hervé Boutemy
-----
Expand All @@ -16,7 +16,7 @@ Overview

and companion tools:

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

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

* Deprecated

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