This is an automated email from the ASF dual-hosted git repository. desruisseaux pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/maven-compiler-plugin.git
commit 937b0f94ba6eec85eaa4f16d40202543d5e3bdf8 Author: Martin Desruisseaux <martin.desruisse...@geomatys.com> AuthorDate: Tue Jul 1 11:36:47 2025 +0200 Port the "Compile Using Memory Allocation Enhancements" page with the following changes: * Version 4 of the Maven compiler plugin additionally accepts the 'k', 'M' and 'G' suffixes. --- .../compile-with-memory-enhancements.apt.vm | 56 ---------------------- .../examples/compile-with-memory-enhancements.md | 51 ++++++++++++++++++++ 2 files changed, 51 insertions(+), 56 deletions(-) diff --git a/src/site/apt/examples/compile-with-memory-enhancements.apt.vm b/src/site/apt/examples/compile-with-memory-enhancements.apt.vm deleted file mode 100644 index a4e6986..0000000 --- a/src/site/apt/examples/compile-with-memory-enhancements.apt.vm +++ /dev/null @@ -1,56 +0,0 @@ - ------ - Compile Using Memory Allocation Enhancements - ------ - Edwin Punzalan - ------ - 2006-07-05 - ------ - -~~ 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. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/doxia/references/apt-format.html - -Compile Using Memory Allocation Enhancements - - The Compiler Plugin accepts configurations for <<<meminitial>>> and - <<<maxmem>>>. You can follow the example below to set the initial memory - size to 128MB and the maximum memory usage to 512MB: - -+----- -<project> - [...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-compiler-plugin</artifactId> - <version>${project.version}</version> - <configuration> - <fork>true</fork> - <meminitial>128m</meminitial> - <maxmem>512m</maxmem> - </configuration> - </plugin> - </plugins> - [...] - </build> - [...] -</project> -+----- \ No newline at end of file diff --git a/src/site/markdown/examples/compile-with-memory-enhancements.md b/src/site/markdown/examples/compile-with-memory-enhancements.md new file mode 100644 index 0000000..c9c2bc7 --- /dev/null +++ b/src/site/markdown/examples/compile-with-memory-enhancements.md @@ -0,0 +1,51 @@ +<!-- +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. +--> + +# Compile Using Memory Allocation Enhancements + +The Compiler Plugin accepts configurations for initial memory (`meminitial`) +and maximum memory (`maxmem`). +You can follow the example below to set the initial memory size to 128MB +and the maximum memory usage to 512MB: + +```xml +<project> + [...] + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-compiler-plugin</artifactId> + <version>...</version> + <configuration> + <fork>true</fork> + <meminitial>128m</meminitial> + <maxmem>512m</maxmem> + </configuration> + </plugin> + </plugins> + [...] + </build> + [...] +</project> +``` + +Version 4 of the Maven compiler plugin additionally accepts the 'k', 'M' (upper-case) +and 'G' suffixes for kilobytes, megabytes and gigabytes respectively.