This is an automated email from the ASF dual-hosted git repository. hboutemy 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 860310b692 [MNG-8043] document new default types, replacing artifact handlers 860310b692 is described below commit 860310b692e2a46eb5326638104f2d9e9d8e6707 Author: Hervé Boutemy <hbout...@apache.org> AuthorDate: Mon Apr 1 17:45:51 2024 +0200 [MNG-8043] document new default types, replacing artifact handlers --- maven-core/src/site/apt/artifact-handlers.apt | 12 ++-- .../src/site/apt/dependency-types.apt | 74 ++++++++++++++++++++++ maven-resolver-provider/src/site/apt/index.apt | 2 + 3 files changed, 83 insertions(+), 5 deletions(-) diff --git a/maven-core/src/site/apt/artifact-handlers.apt b/maven-core/src/site/apt/artifact-handlers.apt index 5e3be0430b..b1b1bce156 100644 --- a/maven-core/src/site/apt/artifact-handlers.apt +++ b/maven-core/src/site/apt/artifact-handlers.apt @@ -16,21 +16,23 @@ ~~ under the License. --- - Default Artifact Handlers Reference + Legacy Artifact Handlers Reference --- Hervé Boutemy --- 2013-08-02 --- -Default Artifact Handlers Reference +Legacy Artifact Handlers Reference - Artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}}) + Maven 3 artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}}) define for each {{{../maven-model/maven.html#class_dependency}dependency type}} information on the artifact (classifier, extension, language) and how to manage it as dependency (add to classpath, include dependencies). - Some artifact handlers - are configured by default in {{{./apidocs/org/apache/maven/artifact/handler/providers/package-summary.html}<<<org.apache.maven.artifact.handler.providers>>>}} package: + They are replaced in Maven 4 with Maven 4 API Core's {{{../api/maven-api-core/apidocs/org/apache/maven/api/Type.html}Dependency Types}}, + with default values defined in {{{../maven-resolver-provider/apidocs/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}DefaultTypeProvider}}. + + For compatibility, legacy Maven 3 artifact handlers are still provided: *--------------------+---------------+------------+------------+-----------+---------------------+-----------------------+ || type || classifier || extension || packaging || language || added to classpath || includesDependencies || diff --git a/maven-resolver-provider/src/site/apt/dependency-types.apt b/maven-resolver-provider/src/site/apt/dependency-types.apt new file mode 100644 index 0000000000..a059faaae0 --- /dev/null +++ b/maven-resolver-provider/src/site/apt/dependency-types.apt @@ -0,0 +1,74 @@ +~~ 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. + + --- + Default Dependency Types + --- + Hervé Boutemy + --- + 2024-04-02 + --- + +Default Dependency Types Reference + + Defined in <<<DefaultTypeProvider>>> + ({{{./apidocs/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}javadoc}}, + {{{./xref/org/apache/maven/repository/internal/type/DefaultTypeProvider.html}source}}): + +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +|| type || classifier || extension || language || path types || includesDependencies || +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +|| Maven || || || || || || +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<pom>>> | | <= type> | none | | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<bom>>> * | | <<<pom>>> | none | | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<maven-plugin>>> | | <<<jar>>> | java | classes | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +|| Java || || || || || || +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<jar>>> | | <= type> | java | classes, modules | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<java-source>>> | <<<sources>>> | <<<jar>>> | java | | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<javadoc>>> | <<<javadoc>>> | <<<jar>>> | java | classes | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<test-jar>>> | <<<tests>>> | <<<jar>>> | java | classes, patch module | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<modular-jar>>> * | <<<tests>>> | <<<jar>>> | java | modules | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<classpath-jar>>> * | <<<tests>>> | <<<jar>>> | java | classes | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<fatjar>>> * | <<<tests>>> | <<<jar>>> | java | classes | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +|| Java/Jakarta EE || || || || || || +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<ejb>>> | | <<<jar>>> | java | classes | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<ejb-client>>> | <<<client>>> | <<<jar>>> | java | classes | | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<war>>> | | <= type> | java | | <<<true>>> | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<ear>>> | | <= type> | java | | <<<true>>> | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<rar>>> | | <= type> | java | | <<<true>>> | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ +| <<<par>>> * | | <= type> | java | | <<<true>>> | +*-----------------------+---------------+------------+-----------+-----------------------+-----------------------+ + + * = new in Maven 4 \ No newline at end of file diff --git a/maven-resolver-provider/src/site/apt/index.apt b/maven-resolver-provider/src/site/apt/index.apt index b50ea1dbf6..3008d093f3 100644 --- a/maven-resolver-provider/src/site/apt/index.apt +++ b/maven-resolver-provider/src/site/apt/index.apt @@ -31,3 +31,5 @@ Maven Artifact Resolver Provider Main component is <<<MavenRepositorySystemUtils>>> ({{{./apidocs/org/apache/maven/repository/internal/MavenRepositorySystemUtils.html}javadoc}}, {{{./xref/org/apache/maven/repository/internal/MavenRepositorySystemUtils.html}source}}). + + See also {{{./dependency-types.html}dependency types}}. \ No newline at end of file