This is an automated email from the ASF dual-hosted git repository.
gnodet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/master by this push:
new 9beb2ed45 Add a README for plexus-utils (#847)
9beb2ed45 is described below
commit 9beb2ed45dbd1e3a50ab5a068df4b298165abd6c
Author: Guillaume Nodet <gno...@gmail.com>
AuthorDate: Sat Oct 29 09:06:24 2022 +0200
Add a README for plexus-utils (#847)
---
maven-xml-impl/README.md | 23 +++++++++++++++++
.../apache/maven/internal/xml/package-info.java | 24 ++++++++++++++++++
.../org/codehaus/plexus/util/xml/package-info.java | 29 ++++++++++++++++++++++
plexus-utils/README.md | 26 +++++++++++++++++++
4 files changed, 102 insertions(+)
diff --git a/maven-xml-impl/README.md b/maven-xml-impl/README.md
new file mode 100644
index 000000000..b2a7ad544
--- /dev/null
+++ b/maven-xml-impl/README.md
@@ -0,0 +1,23 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+Apache Maven XML Impl
+=========================
+
+This module contains the implementation of the `org.apache.maven.api.xml.Dom`
interface used to convey XML snippets in the object model, and also the
modified `org.codehaus.plexus.util.xml` package which wraps the immutable
objects from `org.apache.maven.api.xml.Dom` in order to provide compatibility
and interoperability between the API v3.x and v4.x.
+
+See [plexus-utils](../plexus-utils/README.md) for more information.
+
diff --git
a/maven-xml-impl/src/main/java/org/apache/maven/internal/xml/package-info.java
b/maven-xml-impl/src/main/java/org/apache/maven/internal/xml/package-info.java
new file mode 100644
index 000000000..95ed7c897
--- /dev/null
+++
b/maven-xml-impl/src/main/java/org/apache/maven/internal/xml/package-info.java
@@ -0,0 +1,24 @@
+// CHECKSTYLE_OFF: RegexpHeader
+/**
+ * Contains implementation of the {@link org.apache.maven.api.xml.Dom}
interface and related classes.
+ */
+package org.apache.maven.internal.xml;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
diff --git
a/maven-xml-impl/src/main/java/org/codehaus/plexus/util/xml/package-info.java
b/maven-xml-impl/src/main/java/org/codehaus/plexus/util/xml/package-info.java
new file mode 100644
index 000000000..7f4b536b7
--- /dev/null
+++
b/maven-xml-impl/src/main/java/org/codehaus/plexus/util/xml/package-info.java
@@ -0,0 +1,29 @@
+// CHECKSTYLE_OFF: RegexpHeader
+/**
+ * Contains modified versions of the
+ * {@link org.codehaus.plexus.util.xml.Xpp3Dom} and
+ * {@link org.codehaus.plexus.util.xml.Xpp3DomBuilder}
+ * classes.
+ * The modified {@link org.codehaus.plexus.util.xml.Xpp3Dom} wraps
+ * an immutable {@link org.apache.maven.api.xml.Dom} instance.
+ */
+package org.codehaus.plexus.util.xml;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
diff --git a/plexus-utils/README.md b/plexus-utils/README.md
new file mode 100644
index 000000000..c23a3000a
--- /dev/null
+++ b/plexus-utils/README.md
@@ -0,0 +1,26 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+Apache Maven Plexus Utils
+=========================
+
+This module is a repackaging of the `org.codehaus.plexus:plexus-utils` jar,
which contains a few modified classes to allow a seamless transition between
the maven 3.x and 4.x apis.
+
+The maven 4.x api is based on immutable data objects. The maven model contains
a few classes that contain some open xml data (`Plugin`, `PluginExecution`,
`ReportPlugin` and `ReportSet`). So the v3 API which was using the
`org.codehaus.plexus.utils.xml.Xpp3Dom` class now wraps the
`org.apache.maven.api.Dom` node. This is completely transparent for existing
plugins, but the correct (new) classes have to be used.
+
+Given the new implementation of `org.codehaus.plexus.utils.xml.Xpp3Dom` now
relies on `org.apache.maven.api.Dom`, the modifications can't be made inside
the `plexus-utils` project, because maven itself depends on it.
+
+This is drop-in replacement for `plexus-utils` 3.4.2.
