This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch maven-clean-plugin-4.x
in repository https://gitbox.apache.org/repos/asf/maven-clean-plugin.git
The following commit(s) were added to refs/heads/maven-clean-plugin-4.x by this
push:
new 6b76313 Rewrite site documentation in ASD-STE100 Simplified Technical
English (#368)
6b76313 is described below
commit 6b7631314647f2b114f3aa45189b21b1db27599c
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Tue Nov 10 15:20:16 2026 +0000
Rewrite site documentation in ASD-STE100 Simplified Technical English (#368)
* Rewrite site documentation in ASD-STE100 Simplified Technical English
Use short active sentences, approved verb forms, and one term per concept.
Remove banned modals and filler words. Split long lists and sentences.
* Update wording for clarity in delete_additional_files.md.vm
* Clarify instruction on ignoring errors during cleanup
* Rename 'Skip Clean' to 'Skipping Clean'
* Update src/site/markdown/examples/skipping-clean.md.vm
Co-authored-by: Guillaume Nodet - AI Bot <[email protected]>
* Update src/site/markdown/index.md
Co-authored-by: Guillaume Nodet - AI Bot <[email protected]>
---------
Co-authored-by: Guillaume Nodet - AI Bot <[email protected]>
---
.../examples/delete_additional_files.md.vm | 18 ++++++++------
src/site/markdown/examples/ignoring-errors.md.vm | 8 +++----
src/site/markdown/examples/skipping-clean.md.vm | 6 ++---
src/site/markdown/faq.md | 28 +++++++---------------
src/site/markdown/index.md | 14 ++++++-----
src/site/markdown/usage.md.vm | 16 ++++++-------
src/site/site.xml | 4 ++--
src/site/xdoc/download.xml.vm | 16 ++++++-------
8 files changed, 53 insertions(+), 57 deletions(-)
diff --git a/src/site/markdown/examples/delete_additional_files.md.vm
b/src/site/markdown/examples/delete_additional_files.md.vm
index eca45ce..1e46c3e 100644
--- a/src/site/markdown/examples/delete_additional_files.md.vm
+++ b/src/site/markdown/examples/delete_additional_files.md.vm
@@ -1,5 +1,5 @@
---
-title: Delete Additional Files Not Exposed to Maven
+title: Delete Additional Files
author:
- Mike Perham
- [email protected]
@@ -25,9 +25,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Delete Additional Files Not Exposed to Maven
+# Delete Additional Files
-The Maven Clean Plugin will delete the `target` directory by default. You may
configure it to delete additional directories and files. The following example
shows how:
+By default, the Maven Clean Plugin deletes the `target` directory. You can
configure it to delete other directories and files too. The example below shows
how:
```xml
<build>
@@ -56,18 +56,22 @@ The Maven Clean Plugin will delete the `target` directory
by default. You may co
</build>
```
-**Note:** The `directory` in the `fileset` is a relative path inside a
project, in other words,
+**Note:** The `directory` in the `fileset` is a relative path in a project.
That is,
```xml
<directory>some/relative/path</directory>
```
-is equivalent to:
+is the same as:
```xml
<directory>${esc.d}{basedir}/some/relative/path</directory>
```
-You could also define file set rules in a parent POM. In this case, the clean
plugin adds the subproject basedir to the defined relative path.
+You can also define fileset rules in a parent POM. In this case, the Clean
Plugin adds the basedir of the subproject to the relative path that you define.
-**Note:** The `fast` delete method will not work for any `fileset` which
defines any `includes` or `excludes`, or sets `followSymlinks` to `false`, or
sets `useDefaultExcludes` to `true`.
+**Note:** The `fast` delete method does not work for a `fileset` in these
conditions:
+
+- The `fileset` defines `includes` or `excludes`.
+- The `fileset` sets `followSymlinks` to `false`.
+- The `fileset` sets `useDefaultExcludes` to `true`.
diff --git a/src/site/markdown/examples/ignoring-errors.md.vm
b/src/site/markdown/examples/ignoring-errors.md.vm
index 0208187..159caa4 100644
--- a/src/site/markdown/examples/ignoring-errors.md.vm
+++ b/src/site/markdown/examples/ignoring-errors.md.vm
@@ -1,5 +1,5 @@
---
-title: Ignoring Clean Errors
+title: Ignore Errors
author:
- Vincent Siveton
date: 2007-11-13
@@ -24,9 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Ignoring Clean Errors
+# Ignore Errors
-To ignore errors when running the cleanup for a particular project, set the
`failOnError` property to `false`.
+To ignore errors during project cleanup, set the `failOnError` property to
`false`.
```xml
<build>
@@ -42,7 +42,7 @@ To ignore errors when running the cleanup for a particular
project, set the `fai
</build>
```
-You can also ignore them via command line by executing the following command:
+You can also ignore the errors from the command line. Run this command:
```shell
mvn clean -Dmaven.clean.failOnError=false
diff --git a/src/site/markdown/examples/skipping-clean.md.vm
b/src/site/markdown/examples/skipping-clean.md.vm
index 5c4c400..450234a 100644
--- a/src/site/markdown/examples/skipping-clean.md.vm
+++ b/src/site/markdown/examples/skipping-clean.md.vm
@@ -24,9 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-# Skipping Clean
+# Skip Clean
-To skip running the cleanup for a particular project, set the `skip` property
to `true`.
+To skip cleanup for a project, set the `skip` property to `true`.
```xml
<build>
@@ -42,7 +42,7 @@ To skip running the cleanup for a particular project, set the
`skip` property to
</build>
```
-You can also skip the cleaning via command line by executing the following
command:
+You can also skip the cleanup from the command line. Run this command:
```shell
mvn clean -Dmaven.clean.skip=true
diff --git a/src/site/markdown/faq.md b/src/site/markdown/faq.md
index 691f62f..dad04cc 100644
--- a/src/site/markdown/faq.md
+++ b/src/site/markdown/faq.md
@@ -25,29 +25,19 @@ under the License.
# Frequently Asked Questions
-1. [I already ran *mvn clean* but the directory (*put dir name here*) is still
there. What should I
do?](#I_already_ran_mvn_clean_but_the_directory_.28put_dir_name_here.29_is_still_there._What_should_I_do.3F)
-2. [On Windows, I got *"Unable to delete directory"*. What's
wrong?](#On_Windows.2C_I_got_Unable_to_delete_directory._What_s_wrong.3F)
+1. [I already ran *mvn clean* but the directory (*put dir name here*) is still
there. What can I
do?](#I_already_ran_mvn_clean_but_the_directory_.28put_dir_name_here.29_is_still_there._What_should_I_do.3F)
+2. [On Windows, I got *"Unable to delete directory"*. What is
wrong?](#On_Windows.2C_I_got_Unable_to_delete_directory._What_s_wrong.3F)
-### I already ran *mvn clean* but the directory (*put dir name here*) is still
there. What should I do?
+<a
id="I_already_ran_mvn_clean_but_the_directory_.28put_dir_name_here.29_is_still_there._What_should_I_do.3F"></a>
-Some files-generating plugins can generate their files outside of the
-default directories being deleted by the clean plugin. You should add
-the location of such files in the clean plugin configuration or change
-the configuration of those plugins to put their files inside the
-*project.build.directory* which is by default, the *target*
-directory.
+### I already ran *mvn clean* but the directory (*put dir name here*) is still
there. What can I do?
+
+Some plugins generate their files outside the default directories that the
Clean Plugin deletes. Add the location of these files to the configuration of
the Clean Plugin. You can also change the configuration of those plugins. Then
those plugins put their files in *project.build.directory*, which is the
*target* directory by default.
<a id="On_Windows.2C_I_got_Unable_to_delete_directory._What_s_wrong.3F"></a>
-### On Windows, I got *"Unable to delete directory"*. What's wrong?
+### On Windows, I got *"Unable to delete directory"*. What is wrong?
-For instance, *clean* could fail if you already have opened a command
-line with target as the current dir. Windows locks some ressources and you need
-to close the handles on these ressources.
-To skip these errors, you could call *clean* with the command line parameter
*-Dmaven.clean.failOnError=false*.
-For more information, refer to [Ignoring
Errors](./examples/ignoring-errors.html) page.
+For example, *clean* can fail if you opened a command line with *target* as
the current directory. Windows locks some resources. You must close the handles
on these resources. To skip these errors, call *clean* with the command-line
parameter *-Dmaven.clean.failOnError=false*. For more information, see the
[Ignore Errors](./examples/ignoring-errors.html) page.
-[Sysinternals](http://www.microsoft.com/technet/sysinternals/default.mspx)
produced
-a number of utilities, like [Process
Explorer](http://www.microsoft.com/technet/sysinternals/Utilities/ProcessExplorer.mspx)
-or
[Handle](http://www.microsoft.com/technet/sysinternals/utilities/handle.mspx)
-that help you to deal with Windows handles.
+[Sysinternals](http://www.microsoft.com/technet/sysinternals/default.mspx) has
several utilities, for example [Process
Explorer](http://www.microsoft.com/technet/sysinternals/Utilities/ProcessExplorer.mspx)
and
[Handle](http://www.microsoft.com/technet/sysinternals/utilities/handle.mspx),
that can help you to manage Windows handles.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index a84cf70..aa5bd69 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -25,24 +25,26 @@ under the License.
-->
# Apache Maven Clean Plugin
-The Clean Plugin is used when you want to remove files generated at build-time
in a project's directory.
+
+The Clean Plugin removes the files that Maven generates in the directory of a
project during a build.
## Goals Overview
-The Clean Plugin only has one goal.
+The Clean Plugin has one goal.
+
+- [clean:clean](./clean-mojo.html) removes the files that Maven generates in
the working directory of a project. By default, it finds and deletes the
directories in `project.build.directory`, `project.build.outputDirectory`,
`project.build.testOutputDirectory`, and `project.reporting.outputDirectory`.
-- [clean:clean](./clean-mojo.html) attempts to clean a project's working
directory of the files that were generated at build-time. By default, it
discovers and deletes the directories configured in `project.build.directory`,
`project.build.outputDirectory`, `project.build.testOutputDirectory`, and
`project.reporting.outputDirectory`.
## Usage
General instructions for using the Clean Plugin can be found on the [usage
page](./usage.html). Some more specific use cases are described in the examples
given below.
-If you still have questions about the plugin's usage, see the
[FAQ](./faq.html) and feel free to contact the [user mailing
list](./mailing-lists.html). The posts to the mailing list are archived and
could already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching the [mail
archive](./mailing-lists.html).
+If you have more questions about the plugin, see the [FAQ](./faq.html) or
contact the [user mailing list](./mailing-lists.html). The mailing list is
archived — it may already have an answer to your question. You can also search
the [mail archive](./mailing-lists.html).
-If you feel the plugin is missing a feature or has a defect, you can submit a
feature request or bug report in our [issue tracker](./issue-management.html).
When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can
reproduce your problem. For this reason, entire debug logs, POMs or most
preferably little demo projects attached to the issue are very much
appreciated. Of course, patches are welcom [...]
+If you think the plugin is missing a feature or has a defect, submit a feature
request or bug report in our [issue tracker](./issue-management.html). When
creating a new issue, give a clear description of your concern. Especially for
fixing bugs, the developers must reproduce your problem. For this reason,
entire debug logs, POMs, or preferably small demo projects attached to the
issue are very much appreciated. Patches are also welcome. Contributors can
check out the project from our [s [...]
## Examples
-To better understand some usages of the Clean Plugin, see the following
examples:
+To better understand some uses of the Clean Plugin, see the following examples:
- [How to delete additional files outside of the default
directories?](./examples/delete_additional_files.html)
- [How to ignore clean errors?](./examples/ignoring-errors.html)
diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index d895b21..38861ee 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -26,35 +26,35 @@ under the License.
# Usage
-The Maven Clean Plugin, as the name implies, attempts to clean the files and
directories generated by Maven during its build. While there are plugins that
generate additional files, the Clean Plugin assumes that these files are
generated inside the `target` directory.
+The Maven Clean Plugin removes the files and directories that Maven generates
during a build. Other plugins can generate more files. The Clean Plugin assumes
that these files are in the `target` directory.
-Cleaning a Maven project using the command-line
+Clean a Maven project from the command line
-----------------------------------------------
-The Clean Plugin can be called to execute in the command-line without any
additional configurations. Like the other plugins, to run the Clean Plugin, you
use:
+You can run the Clean Plugin from the command line. You do not need more
configuration. To run the Clean Plugin, use this command:
```shell
mvn clean:clean
```
-where the first `clean` refers to the plugin's alias, and the second `clean`
refers to the plugin goal.
+The first `clean` is the alias of the plugin. The second `clean` is the goal.
-However, the Clean Plugin is a special plugin and is bound to its own special
lifecycyle phase called `clean`. Thus, for simplicity, it can also be executed
by using:
+The Clean Plugin is bound to a lifecycle phase called `clean`. Thus, you can
also run it with this command:
```shell
mvn clean
```
-or with other phases/goals like:
+You can also add other phases or goals:
```shell
mvn clean package site
```
-Running the Clean Plugin automatically during a build
+Run the Clean Plugin automatically during a build
-----------------------------------------------------
-If for some reason, adding `clean` to the command-line is not option, the
Clean Plugin can be put into a project's `pom.xml` so that it gets executed
everytime the project is built. Below is a sample `pom.xml` for running the
Clean Plugin in the `initialize` phase everytime the project is built:
+If you cannot add `clean` to the command line, put the Clean Plugin in the
`pom.xml` of a project. Then it runs each time that the project builds. The
sample `pom.xml` below runs the Clean Plugin in the `initialize` phase each
time that the project builds:
```xml
<project>
diff --git a/src/site/site.xml b/src/site/site.xml
index dde3d3f..885bb8c 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -33,8 +33,8 @@ under the License.
</menu>
<menu name="Examples">
<item name="Delete Additional Files"
href="examples/delete_additional_files.html"/>
- <item name="Skipping Clean" href="examples/skipping-clean.html"/>
- <item name="Ignoring Errors" href="examples/ignoring-errors.html"/>
+ <item name="Skip Clean" href="examples/skipping-clean.html"/>
+ <item name="Ignore Errors" href="examples/ignoring-errors.html"/>
</menu>
</body>
</site>
diff --git a/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm
index 8f28f05..ac42c12 100644
--- a/src/site/xdoc/download.xml.vm
+++ b/src/site/xdoc/download.xml.vm
@@ -27,11 +27,11 @@ under the License.
<body>
<section name="Download ${project.name} ${project.version} Source">
- <p><strong>${project.name} ${project.version}</strong> is distributed in
source format.</p>
+ <p><strong>${project.name} ${project.version}</strong> is available in
source format.</p>
- <p>Use a source archive if you intend to build
<strong>${project.name}</strong> yourself.</p>
+ <p>If you want to build <strong>${project.name}</strong> yourself, use a
source archive.</p>
- <p>Otherwise, simply use the ready-made binary artifacts from
<strong>central repository</strong>.</p>
+ <p>Otherwise, use the binary artifacts from the <strong>central
repository</strong>.</p>
<p><strong>${project.name}</strong> is distributed under the <a
href="https://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
@@ -58,16 +58,16 @@ under the License.
</tbody>
</table>
- <p>It is essential that you <a
href="https://www.apache.org/info/verification.html">verify the integrity</a>
of the downloaded file
- using the checksum (.sha512 file)
- or using the signature (.asc file) against the public <a
href="https://downloads.apache.org/maven/KEYS">KEYS</a> used by the Apache
Maven developers.
+ <p>You must <a
href="https://www.apache.org/info/verification.html">verify the integrity</a>
of the downloaded file.
+ Use the checksum (.sha512 file) or the signature (.asc file) with
the public
+ <a href="https://downloads.apache.org/maven/KEYS">KEYS</a> of the
Apache Maven developers.
</p>
</subsection>
<subsection name="Previous Versions">
- <p>It is strongly recommended to use the latest release version of
<strong>${project.name}</strong> to take advantage of the newest features and
bug fixes.</p>
- <p>Older non-recommended releases can be found on our <a
href="https://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
+ <p>Use the latest release version of <strong>${project.name}</strong>
to get the newest features and bug fixes.</p>
+ <p>You can find older releases on the <a
href="https://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
</subsection>
</section>
</body>