describe optional dependency on plexus-xml

codehaus-plexus · Sep 9, 2023 · b2cf572 · b2cf572
1 parent 26f683a
commit b2cf572
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,4 +14,6 @@ For publishing [the site](https://codehaus-plexus.github.io/plexus-utils/) do th
 mvn -Preporting verify site site:stage scm-publish:publish-scm
 ```
 
-Starting with version 4, XML classes (in `org.codehaus.plexus.util.xml` and `org.codehaus.plexus.util.xml.pull`) have been extracted to a separate [`plexus-xml`](https://github.com/codehaus-plexus/plexus-xml/) 4: if you need them, just use this new artifact.
+Starting with version 4, XML classes (in `org.codehaus.plexus.util.xml` and `org.codehaus.plexus.util.xml.pull`) have been extracted to a separate [`plexus-xml`](https://github.com/codehaus-plexus/plexus-xml/) library: if you need them, just use this new artifact.
+
+`plexus-utils` 4 keeps an optional dependency on `plexus-xml` to keep compatibility with the few XML-oriented methods of `ReaderFactory` and `WriterFactory`: these classes are deprecated, you should migrate as explained in javadoc.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
@@ -0,0 +1,7 @@
+## Plexus Common Utilities
+
+A collection of various utility classes to ease working with strings, files, command lines and more.
+
+Starting with version 4, XML classes (in `org.codehaus.plexus.util.xml` and `org.codehaus.plexus.util.xml.pull`) have been extracted to a separate [`plexus-xml`](../plexus-xml/) library: if you need them, just use this new artifact.
+
+`plexus-utils` 4 keeps an optional dependency on `plexus-xml` to keep compatibility with the few XML-oriented methods of [`ReaderFactory`](./apidocs/org/codehaus/plexus/util/ReaderFactory.html) and [`WriterFactory`](./apidocs/org/codehaus/plexus/util/WriterFactory.html): these classes are deprecated, you should migrate as explained in javadoc.
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -4,6 +4,9 @@
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
   <body>
+    <links>
+      <item name="Plexus XML" href="../plexus-xml/" />
+    </links>
     <breadcrumbs>
       <item name="Plexus" href="https://codehaus-plexus.github.io/"/>
       <item name="Plexus Utils" href="https://codehaus-plexus.github.io/plexus-utils/"/>