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 e600b09ea5 [MNG-8382] Docgen: remove property numbering, they are
misleading and properties are "floating" anyway (alphabetically) (#1979)
e600b09ea5 is described below
commit e600b09ea50d2588fb64743c6b3e5fb5b3713252
Author: Guillaume Nodet <gno...@gmail.com>
AuthorDate: Sat Dec 14 00:09:33 2024 +0100
[MNG-8382] Docgen: remove property numbering, they are misleading and
properties are "floating" anyway (alphabetically) (#1979)
---
.../src/test/resources/maven-configuration.md.vm | 6 +-
src/site/markdown/maven-configuration.md | 92 +++++++++++-----------
2 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/apache-maven/src/test/resources/maven-configuration.md.vm
b/apache-maven/src/test/resources/maven-configuration.md.vm
index 8cd78064ac..05c3815c18 100644
--- a/apache-maven/src/test/resources/maven-configuration.md.vm
+++ b/apache-maven/src/test/resources/maven-configuration.md.vm
@@ -47,9 +47,9 @@ under the License.
#if ($val) `$val` #else - #end
#end
-| No | Key | Type | Description | Default Value | Since | Source |
-| --- | --- | --- | --- | --- | --- | --- |
+| Key | Type | Description | Default Value | Since | Source |
+| --- | --- | --- | --- | --- | --- |
#foreach($key in $keys)
-| $foreach.count. | `$key.key` | `$key.configurationType` | $key.description |
#value( $key.defaultValue ) | $key.since | $key.configurationSource |
+| `$key.key` | `$key.configurationType` | $key.description | #value(
$key.defaultValue ) | $key.since | $key.configurationSource |
#end
diff --git a/src/site/markdown/maven-configuration.md
b/src/site/markdown/maven-configuration.md
index 459c51cec8..cdb99995b1 100644
--- a/src/site/markdown/maven-configuration.md
+++ b/src/site/markdown/maven-configuration.md
@@ -23,50 +23,50 @@ under the License.
-| No | Key | Type | Description | Default Value | Since | Source |
-| --- | --- | --- | --- | --- | --- | --- |
-| 1. | `maven.build.timestamp.format` | `String` | Build timestamp format. |
`yyyy-MM-dd'T'HH:mm:ssXXX` | 3.0.0 | Model properties |
-| 2. | `maven.consumer.pom` | `Boolean` | User property for enabling/disabling
the consumer POM feature. | `true` | 4.0.0 | User properties |
-| 3. | `maven.deploy.snapshot.buildNumber` | `Integer` | User property for
overriding calculated "build number" for snapshot deploys. Caution: this
property should be RARELY used (if used at all). It may help in special cases
like "aligning" a reactor build subprojects build numbers to perform a
"snapshot lock down". Value given here must be <code>maxRemoteBuildNumber +
1</code> or greater, otherwise build will fail. How the number to be obtained
is left to user (ie by inspecting snapsho [...]
-| 4. | `maven.ext.class.path` | `String` | Extensions class path. | - | |
User properties |
-| 5. | `maven.home` | `String` | Maven home. | - | 3.0.0 | User properties |
-| 6. | `maven.installation.conf` | `String` | Maven installation configuration
directory. | `${maven.home}/conf` | 4.0.0 | User properties |
-| 7. | `maven.installation.extensions` | `String` | Maven installation
extensions. | `${maven.installation.conf}/extensions.xml` | 4.0.0 | User
properties |
-| 8. | `maven.installation.settings` | `String` | Maven installation settings.
| `${maven.installation.conf}/settings.xml` | 4.0.0 | User properties |
-| 9. | `maven.installation.toolchains` | `String` | Maven installation
toolchains. | `${maven.installation.conf}/toolchains.xml` | 4.0.0 | User
properties |
-| 10. | `maven.modelBuilder.parallelism` | `Integer` | ProjectBuilder
parallelism. | `cores/2 + 1` | 4.0.0 | User properties |
-| 11. | `maven.plugin.validation` | `String` | Plugin validation level. |
`inline` | 3.9.2 | User properties |
-| 12. | `maven.plugin.validation.excludes` | `String` | Plugin validation
exclusions. | - | 3.9.6 | User properties |
-| 13. | `maven.project.conf` | `String` | Maven project configuration
directory. | `${session.rootDirectory}/.mvn` | 4.0.0 | User properties |
-| 14. | `maven.project.extensions` | `String` | Maven project extensions. |
`${maven.project.conf}/extensions.xml` | 4.0.0 | User properties |
-| 15. | `maven.project.settings` | `String` | Maven project settings. |
`${maven.project.conf}/settings.xml` | 4.0.0 | User properties |
-| 16. | `maven.relocations.entries` | `String` | User controlled relocations.
This property is a comma separated list of entries with the syntax
<code>GAV>GAV</code>. The first <code>GAV</code> can contain <code>\*</code>
for any elem (so <code>\*:\*:\*</code> would mean ALL, something you don't
want). The second <code>GAV</code> is either fully specified, or also can
contain <code>\*</code>, then it behaves as "ordinary relocation": the
coordinate is preserved from relocated artifact [...]
-| 17. | `maven.repo.central` | `String` | Maven central repository URL. The
property will have the value of the <code>MAVEN_REPO_CENTRAL</code> environment
variable if it is defined. | `https://repo.maven.apache.org/maven2` | 4.0.0 |
User properties |
-| 18. | `maven.repo.local` | `String` | Maven local repository. |
`${maven.user.conf}/repository` | 3.0.0 | User properties |
-| 19. | `maven.repo.local.head` | `String` | User property for chained LRM:
the new "head" local repository to use, and "push" the existing into tail.
Similar to <code>maven.repo.local.tail</code>, this property may contain comma
separated list of paths to be used as local repositories (combine with chained
local repository), but while latter is "appending" this one is "prepending". |
- | 4.0.0 | User properties |
-| 20. | `maven.repo.local.recordReverseTree` | `String` | User property for
reverse dependency tree. If enabled, Maven will record ".tracking" directory
into local repository with "reverse dependency tree", essentially explaining
WHY given artifact is present in local repository. Default: <code>false</code>,
will not record anything. | `false` | 3.9.0 | User properties |
-| 21. | `maven.repo.local.tail` | `String` | User property for chained LRM:
list of "tail" local repository paths (separated by comma), to be used with
<code>org.eclipse.aether.util.repository.ChainedLocalRepositoryManager</code>.
Default value: <code>null</code>, no chained LRM is used. | - | 3.9.0 | User
properties |
-| 22. | `maven.repo.local.tail.ignoreAvailability` | `String` | User property
for chained LRM: whether to ignore "availability check" in tail or not. Usually
you do want to ignore it. This property is mapped onto corresponding Resolver
2.x property, is like a synonym for it. Default value: <code>true</code>. | -
| 3.9.0 | User properties |
-| 23. | `maven.resolver.dependencyManagerTransitivity` | `String` | User
property for selecting dependency manager behaviour regarding transitive
dependencies and dependency management entries in their POMs. Maven 3 targeted
full backward compatibility with Maven2, hence it ignored dependency management
entries in transitive dependency POMs. Maven 4 enables "transitivity" by
default, hence unlike Maven2, obeys dependency management entries deep in
dependency graph as well. <br/> Default: [...]
-| 24. | `maven.resolver.transport` | `String` | Resolver transport to use. Can
be <code>default</code>, <code>wagon</code>, <code>apache</code>,
<code>jdk</code> or <code>auto</code>. | `default` | 4.0.0 | User properties |
-| 25. | `maven.session.versionFilter` | `String` | User property for version
filter expression used in session, applied to resolving ranges: a semicolon
separated list of filters to apply. By default, no version filter is applied
(like in Maven 3). <br/> Supported filters: <ul> <li>"h" or "h(num)" - highest
version or top list of highest ones filter</li> <li>"l" or "l(num)" - lowest
version or bottom list of lowest ones filter</li> <li>"s" - contextual snapshot
filter</li> <li>"e(G:A:V)" [...]
-| 26. | `maven.settings.security` | `String` | |
`${maven.user.conf}/settings-security4.xml` | | User properties |
-| 27. | `maven.startInstant` | `java.time.Instant` | User property used to
store the build timestamp. | - | 4.0.0 | User properties |
-| 28. | `maven.style.color` | `String` | Maven output color mode. Allowed
values are <code>auto</code>, <code>always</code>, <code>never</code>. |
`auto` | 4.0.0 | User properties |
-| 29. | `maven.style.debug` | `String` | Color style for debug messages. |
`bold,f:cyan` | 4.0.0 | User properties |
-| 30. | `maven.style.error` | `String` | Color style for error messages. |
`bold,f:red` | 4.0.0 | User properties |
-| 31. | `maven.style.failure` | `String` | Color style for failure messages. |
`bold,f:red` | 4.0.0 | User properties |
-| 32. | `maven.style.info` | `String` | Color style for info messages. |
`bold,f:blue` | 4.0.0 | User properties |
-| 33. | `maven.style.mojo` | `String` | Color style for mojo messages. |
`f:green` | 4.0.0 | User properties |
-| 34. | `maven.style.project` | `String` | Color style for project messages. |
`f:cyan` | 4.0.0 | User properties |
-| 35. | `maven.style.strong` | `String` | Color style for strong messages. |
`bold` | 4.0.0 | User properties |
-| 36. | `maven.style.success` | `String` | Color style for success messages. |
`bold,f:green` | 4.0.0 | User properties |
-| 37. | `maven.style.trace` | `String` | Color style for trace messages. |
`bold,f:magenta` | 4.0.0 | User properties |
-| 38. | `maven.style.transfer` | `String` | Color style for transfer messages.
| `f:bright-black` | 4.0.0 | User properties |
-| 39. | `maven.style.warning` | `String` | Color style for warning messages. |
`bold,f:yellow` | 4.0.0 | User properties |
-| 40. | `maven.user.conf` | `String` | Maven user configuration directory. |
`${user.home}/.m2` | 4.0.0 | User properties |
-| 41. | `maven.user.extensions` | `String` | Maven user extensions. |
`${maven.user.conf}/extensions.xml` | 4.0.0 | User properties |
-| 42. | `maven.user.settings` | `String` | Maven user settings. |
`${maven.user.conf}/settings.xml` | 4.0.0 | User properties |
-| 43. | `maven.user.toolchains` | `String` | Maven user toolchains. |
`${maven.user.conf}/toolchains.xml` | 4.0.0 | User properties |
-| 44. | `maven.versionResolver.noCache` | `Boolean` | User property for
disabling version resolver cache. | `false` | 3.0.0 | User properties |
+| Key | Type | Description | Default Value | Since | Source |
+| --- | --- | --- | --- | --- | --- |
+| `maven.build.timestamp.format` | `String` | Build timestamp format. |
`yyyy-MM-dd'T'HH:mm:ssXXX` | 3.0.0 | Model properties |
+| `maven.consumer.pom` | `Boolean` | User property for enabling/disabling the
consumer POM feature. | `true` | 4.0.0 | User properties |
+| `maven.deploy.snapshot.buildNumber` | `Integer` | User property for
overriding calculated "build number" for snapshot deploys. Caution: this
property should be RARELY used (if used at all). It may help in special cases
like "aligning" a reactor build subprojects build numbers to perform a
"snapshot lock down". Value given here must be <code>maxRemoteBuildNumber +
1</code> or greater, otherwise build will fail. How the number to be obtained
is left to user (ie by inspecting snapshot rep [...]
+| `maven.ext.class.path` | `String` | Extensions class path. | - | | User
properties |
+| `maven.home` | `String` | Maven home. | - | 3.0.0 | User properties |
+| `maven.installation.conf` | `String` | Maven installation configuration
directory. | `${maven.home}/conf` | 4.0.0 | User properties |
+| `maven.installation.extensions` | `String` | Maven installation extensions.
| `${maven.installation.conf}/extensions.xml` | 4.0.0 | User properties |
+| `maven.installation.settings` | `String` | Maven installation settings. |
`${maven.installation.conf}/settings.xml` | 4.0.0 | User properties |
+| `maven.installation.toolchains` | `String` | Maven installation toolchains.
| `${maven.installation.conf}/toolchains.xml` | 4.0.0 | User properties |
+| `maven.modelBuilder.parallelism` | `Integer` | ProjectBuilder parallelism. |
`cores/2 + 1` | 4.0.0 | User properties |
+| `maven.plugin.validation` | `String` | Plugin validation level. | `inline`
| 3.9.2 | User properties |
+| `maven.plugin.validation.excludes` | `String` | Plugin validation
exclusions. | - | 3.9.6 | User properties |
+| `maven.project.conf` | `String` | Maven project configuration directory. |
`${session.rootDirectory}/.mvn` | 4.0.0 | User properties |
+| `maven.project.extensions` | `String` | Maven project extensions. |
`${maven.project.conf}/extensions.xml` | 4.0.0 | User properties |
+| `maven.project.settings` | `String` | Maven project settings. |
`${maven.project.conf}/settings.xml` | 4.0.0 | User properties |
+| `maven.relocations.entries` | `String` | User controlled relocations. This
property is a comma separated list of entries with the syntax
<code>GAV>GAV</code>. The first <code>GAV</code> can contain <code>\*</code>
for any elem (so <code>\*:\*:\*</code> would mean ALL, something you don't
want). The second <code>GAV</code> is either fully specified, or also can
contain <code>\*</code>, then it behaves as "ordinary relocation": the
coordinate is preserved from relocated artifact. Fina [...]
+| `maven.repo.central` | `String` | Maven central repository URL. The property
will have the value of the <code>MAVEN_REPO_CENTRAL</code> environment variable
if it is defined. | `https://repo.maven.apache.org/maven2` | 4.0.0 | User
properties |
+| `maven.repo.local` | `String` | Maven local repository. |
`${maven.user.conf}/repository` | 3.0.0 | User properties |
+| `maven.repo.local.head` | `String` | User property for chained LRM: the new
"head" local repository to use, and "push" the existing into tail. Similar to
<code>maven.repo.local.tail</code>, this property may contain comma separated
list of paths to be used as local repositories (combine with chained local
repository), but while latter is "appending" this one is "prepending". | - |
4.0.0 | User properties |
+| `maven.repo.local.recordReverseTree` | `String` | User property for reverse
dependency tree. If enabled, Maven will record ".tracking" directory into local
repository with "reverse dependency tree", essentially explaining WHY given
artifact is present in local repository. Default: <code>false</code>, will not
record anything. | `false` | 3.9.0 | User properties |
+| `maven.repo.local.tail` | `String` | User property for chained LRM: list of
"tail" local repository paths (separated by comma), to be used with
<code>org.eclipse.aether.util.repository.ChainedLocalRepositoryManager</code>.
Default value: <code>null</code>, no chained LRM is used. | - | 3.9.0 | User
properties |
+| `maven.repo.local.tail.ignoreAvailability` | `String` | User property for
chained LRM: whether to ignore "availability check" in tail or not. Usually you
do want to ignore it. This property is mapped onto corresponding Resolver 2.x
property, is like a synonym for it. Default value: <code>true</code>. | - |
3.9.0 | User properties |
+| `maven.resolver.dependencyManagerTransitivity` | `String` | User property
for selecting dependency manager behaviour regarding transitive dependencies
and dependency management entries in their POMs. Maven 3 targeted full backward
compatibility with Maven2, hence it ignored dependency management entries in
transitive dependency POMs. Maven 4 enables "transitivity" by default, hence
unlike Maven2, obeys dependency management entries deep in dependency graph as
well. <br/> Default: <code [...]
+| `maven.resolver.transport` | `String` | Resolver transport to use. Can be
<code>default</code>, <code>wagon</code>, <code>apache</code>, <code>jdk</code>
or <code>auto</code>. | `default` | 4.0.0 | User properties |
+| `maven.session.versionFilter` | `String` | User property for version filter
expression used in session, applied to resolving ranges: a semicolon separated
list of filters to apply. By default, no version filter is applied (like in
Maven 3). <br/> Supported filters: <ul> <li>"h" or "h(num)" - highest version
or top list of highest ones filter</li> <li>"l" or "l(num)" - lowest version or
bottom list of lowest ones filter</li> <li>"s" - contextual snapshot
filter</li> <li>"e(G:A:V)" - pre [...]
+| `maven.settings.security` | `String` | |
`${maven.user.conf}/settings-security4.xml` | | User properties |
+| `maven.startInstant` | `java.time.Instant` | User property used to store the
build timestamp. | - | 4.0.0 | User properties |
+| `maven.style.color` | `String` | Maven output color mode. Allowed values are
<code>auto</code>, <code>always</code>, <code>never</code>. | `auto` | 4.0.0
| User properties |
+| `maven.style.debug` | `String` | Color style for debug messages. |
`bold,f:cyan` | 4.0.0 | User properties |
+| `maven.style.error` | `String` | Color style for error messages. |
`bold,f:red` | 4.0.0 | User properties |
+| `maven.style.failure` | `String` | Color style for failure messages. |
`bold,f:red` | 4.0.0 | User properties |
+| `maven.style.info` | `String` | Color style for info messages. |
`bold,f:blue` | 4.0.0 | User properties |
+| `maven.style.mojo` | `String` | Color style for mojo messages. | `f:green`
| 4.0.0 | User properties |
+| `maven.style.project` | `String` | Color style for project messages. |
`f:cyan` | 4.0.0 | User properties |
+| `maven.style.strong` | `String` | Color style for strong messages. | `bold`
| 4.0.0 | User properties |
+| `maven.style.success` | `String` | Color style for success messages. |
`bold,f:green` | 4.0.0 | User properties |
+| `maven.style.trace` | `String` | Color style for trace messages. |
`bold,f:magenta` | 4.0.0 | User properties |
+| `maven.style.transfer` | `String` | Color style for transfer messages. |
`f:bright-black` | 4.0.0 | User properties |
+| `maven.style.warning` | `String` | Color style for warning messages. |
`bold,f:yellow` | 4.0.0 | User properties |
+| `maven.user.conf` | `String` | Maven user configuration directory. |
`${user.home}/.m2` | 4.0.0 | User properties |
+| `maven.user.extensions` | `String` | Maven user extensions. |
`${maven.user.conf}/extensions.xml` | 4.0.0 | User properties |
+| `maven.user.settings` | `String` | Maven user settings. |
`${maven.user.conf}/settings.xml` | 4.0.0 | User properties |
+| `maven.user.toolchains` | `String` | Maven user toolchains. |
`${maven.user.conf}/toolchains.xml` | 4.0.0 | User properties |
+| `maven.versionResolver.noCache` | `Boolean` | User property for disabling
version resolver cache. | `false` | 3.0.0 | User properties |
