Author: baerrach
Date: Tue Mar 31 01:03:35 2009
New Revision: 760283

URL: http://svn.apache.org/viewvc?rev=760283&view=rev
Log:
[MECLIPSE-104]
Added site documentation and updated the parameter documentation.

Added:
    
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt
   (with props)
Modified:
    
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
    maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml

Modified: 
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java?rev=760283&r1=760282&r2=760283&view=diff
==============================================================================
--- 
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
 (original)
+++ 
maven/plugins/trunk/maven-eclipse-plugin/src/main/java/org/apache/maven/plugin/eclipse/EclipsePlugin.java
 Tue Mar 31 01:03:35 2009
@@ -524,7 +524,11 @@
     /**
      * List of inclusions to add to the source directories on the classpath.
      * Adds including="" to the classpathentry of the eclipse .classpath file.
-     * Defaults to "**\/*.java"
+     * <p>
+     * Java projects will always include "**&#47;*.java"
+     * <p>
+     * Ajdt projects will always include "**&#47;*.aj"
+     * <p>
      * [MECLIPSE-104]
      * 
      * @since 2.6.1

Added: 
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt?rev=760283&view=auto
==============================================================================
--- 
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt
 (added)
+++ 
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt
 Tue Mar 31 01:03:35 2009
@@ -0,0 +1,62 @@
+ ------
+ Specifying source path inclusions and exclusions
+ ------
+ Barrie Treloar
+ ------
+ 31 March 2009
+ ------
+
+Overview
+
+       With the change done as part of 
{{{http://jira.codehaus.org/browse/MECLIPSE-443}MECLIPSE-443 "Only include 
**/*.java in Java source directories"}} 
+       the .classpath entries for classpathentry kind="src" now specify an 
<<<including>>> attribute with a value of <<<"**/*.java">>>.
+       Previously this attribute was not specified     which meant that 
eclipse would include any file in this src directory as being on the classpath 
and hence compiled.
+       
+       This broke Ajdt support as <<<"**/*.aj">>> files were no longer 
included on the classpath and 
{{{http://jira.codehaus.org/browse/MECLIPSE-538}MECLIPSE-538}} fixed this.
+       
+       {{{http://jira.codehaus.org/browse/MECLIPSE-104}MECLIPSE-104 "Add the 
ability to specify source inclusions/exclusions"}} was added put back this 
flexibility.
+       
+       In summary:
+       
+         * If your project is a java project then "**/*.java" will always be 
added to the including attribute of source directories.
+         
+         * If your project is an ajdt project then "**/*.aj" will always be 
added to the including attribute of source directories.
+         
+         * If you need any additional includes or excludes for source 
directories then use the configuration elements sourceIncludes/sourceExcludes
+         
+         []
+         
+Example - Specifying sourceIncludes/sourceExcludes
+
++-----
+<project>
+  [...]
+  <build>
+    [...]
+    <plugins>
+      [...]
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-eclipse-plugin</artifactId>
+        <configuration>
+          <sourceExcludes>
+            <sourceExclude>**/.svn/**</sourceExclude>
+          </sourceExcludes>
+          <sourceIncludes>
+            <sourceInclude>**/*.myExtension</sourceInclude>
+          </sourceIncludes>
+        </configuration>
+      </plugin>
+      [...]
+    </plugins>
+    [...]
+  </build>
+  [...]
+</project>
++-----
+
+       This will result in the <<<.classpath>>> file having source directory 
entries similar to this:
+       
++-----
+  <classpathentry kind="src" path="src/main/java" 
including="**/*.myExtension|**/*.java" excluding="**/.svn/**"/>
++-----
\ No newline at end of file

Propchange: 
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: 
maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/examples/specifying-source-path-inclusions-and-exclusions.apt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt?rev=760283&r1=760282&r2=760283&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/apt/index.apt Tue Mar 31 
01:03:35 2009
@@ -102,4 +102,6 @@
   
   * {{{examples/multi-module-projects.html}Multi-module projects with WTP}}
       
-  * {{{examples/ajdt-projects.html}AJDT projects}}  
\ No newline at end of file
+  * {{{examples/ajdt-projects.html}AJDT projects}}  
+  
+  * 
{{{examples/specifying-source-path-inclusions-and-exclusions.html}Specifying 
source path inclusions and exclusions}}
\ No newline at end of file

Modified: maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml
URL: 
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml?rev=760283&r1=760282&r2=760283&view=diff
==============================================================================
--- maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-eclipse-plugin/src/site/site.xml Tue Mar 31 
01:03:35 2009
@@ -41,6 +41,7 @@
       <item name="Load Code Style file" href="examples/load-code-styles.html"/>
       <item name="Configure Checkstyle" 
href="examples/configure-checkstyle.html"/>
       <item name="Multi-module projects with WTP" 
href="examples/multi-module-projects.html"/>
+      <item name="Specifying source path inclusions and exclusions" 
href="examples/specifying-source-path-inclusions-and-exclusions.html"/>
     </menu>
   </body>
 </project>


Reply via email to