diff --git a/src/site/apt/advanced-descriptor-topics.apt.vm b/src/site/apt/advanced-descriptor-topics.apt.vm index 8eb25a25..8b096c00 100644 --- a/src/site/apt/advanced-descriptor-topics.apt.vm +++ b/src/site/apt/advanced-descriptor-topics.apt.vm @@ -229,7 +229,7 @@ Advanced Assembly-Descriptor Topics [...] - ${project.basedir} + \${project.basedir} %regex[(?!.*src/).*target.*] @@ -252,44 +252,38 @@ Advanced Assembly-Descriptor Topics At times, you want to build in a set of sanity checks when creating your assembly, to ensure that what goes into the assembly artifact is what you intended. One way you can do this is by enabling <<>> on - your <<>>, <<>>, and <<>>. + your <<>>. <<>> is a flag that tells the assembly plugin to track each include/exclude pattern to make sure it's used during creation of the assembly. This way, if the assembly-descriptor author intended for a particular - file or artifact to be present, he can add an include/exclude pattern to the - descriptor to ensure that file/artifact is present, and then set the + artifact to be present, he can add an include/exclude pattern to the + descriptor to ensure that artifact is present, and then set the <<>> flag. If the pattern isn't used to match at least one - file during assembly creation, the build will fail and the user will receive a + artifact during assembly creation, the build will fail and the user will receive a message notifying him of the unused patterns. -** Example: Ensuring the LICENSE.txt file is included in a jar - - In this example, we want to make sure that our project jar contains the - project's open source license language, in order to be compliant with our - software foundation's policies. +** Example: +--- [...] - - - true - META-INF + + - LICENSE.txt + commons-logging:commons-logging - - [...] - + true + + [...] +--- - If a developer inadvertently removes the LICENSE.txt from the project - directory, the assembly plugin should refuse to build this assembly. + If <> artifact will not present on the project dependencies list, + the assembly plugin should refuse to build this assembly. * Using an Alternative Assembly Base Directory