You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2019/12/27 10:11:53 UTC

[camel] branch master updated: CAMEL-14320: Remove old cruft from build instructions, and remove section about eclipse as its outdated. Also remove experimental profile ekstazi in pom.xml

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new eb60743  CAMEL-14320: Remove old cruft from build instructions, and remove section about eclipse as its outdated. Also remove experimental profile ekstazi in pom.xml
eb60743 is described below

commit eb60743f22c2e442d69c8ad4ab37160304acd6db
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Fri Dec 27 11:11:36 2019 +0100

    CAMEL-14320: Remove old cruft from build instructions, and remove section about eclipse as its outdated. Also remove experimental profile ekstazi in pom.xml
---
 .../images/camel-eclipse-m2e-import-completed.png  | Bin 73775 -> 0 bytes
 .../assets/images/camel-eclipse-m2e-import.png     | Bin 39095 -> 0 bytes
 docs/user-manual/modules/ROOT/pages/building.adoc  | 169 +--------------------
 parent/pom.xml                                     |  51 -------
 4 files changed, 7 insertions(+), 213 deletions(-)

diff --git a/docs/user-manual/modules/ROOT/assets/images/camel-eclipse-m2e-import-completed.png b/docs/user-manual/modules/ROOT/assets/images/camel-eclipse-m2e-import-completed.png
deleted file mode 100644
index 27ace56..0000000
Binary files a/docs/user-manual/modules/ROOT/assets/images/camel-eclipse-m2e-import-completed.png and /dev/null differ
diff --git a/docs/user-manual/modules/ROOT/assets/images/camel-eclipse-m2e-import.png b/docs/user-manual/modules/ROOT/assets/images/camel-eclipse-m2e-import.png
deleted file mode 100644
index db54355..0000000
Binary files a/docs/user-manual/modules/ROOT/assets/images/camel-eclipse-m2e-import.png and /dev/null differ
diff --git a/docs/user-manual/modules/ROOT/pages/building.adoc b/docs/user-manual/modules/ROOT/pages/building.adoc
index 89e32b9..c6921a4 100644
--- a/docs/user-manual/modules/ROOT/pages/building.adoc
+++ b/docs/user-manual/modules/ROOT/pages/building.adoc
@@ -11,23 +11,15 @@ Download a distribution or JAR.
 *Required:*
 
 * Java
-** 1.7 or 1.8 to build Camel 2.14 onwards
-** 1.8 to build Camel 2.18 onwards
+** 1.8 or 1.11
 
-* https://github.com/takari/maven-wrapper[Maven Wrapper] is used and bundled with Camel 2.21 onwards.
+* https://github.com/takari/maven-wrapper[Maven Wrapper] is used and bundled.
 
 * Otherwise, http://maven.apache.org/download.html[download and install Maven]
-** Maven 3.1.1 or newer is required to build Camel 2.14 onwards
-** Maven 3.2.5 or newer is required to build Camel 2.18 onwards
-** Maven 3.3.3 or newer is required to build Camel 2.20 onwards
+** Maven 3.6.x or newer is required to build Camel 3 onwards
 
 * Get the latest source from https://github.com/apache/camel/[Github]
 
-*Optional:*
-
-* http://www.princexml.com/download/[Prince] should be in the executable
-PATH to generate the PDF documentation
-
 [[Building-Mavenoptions]]
 == Maven options
 
@@ -53,6 +45,8 @@ set MAVEN_OPTS="-Xms2048m -Xmx3584m"
 [[Building-Anormalbuild]]
 == A normal build
 
+Beware this runs all the unit tests which takes a couple of hours.
+
 [source,text]
 -----------------
 mvn clean install
@@ -62,7 +56,7 @@ mvn clean install
 == A quick build without running tests
 
 The following skips building the manual, the distro and does not execute
-the unit tests.
+the unit tests, which can complete in 15-20 minutes.
 
 [source,text]
 -------------------------------
@@ -77,135 +71,6 @@ mvn clean install -Pfastinstall
 mvn clean install -Pfastinstall,sourcecheck
 -------------------------------------------
 
-[[Building-UsinganIDE]]
-== Using an IDE
-
-If you prefer to use an IDE then you can auto-generate the IDE's project
-files using maven plugins. e.g.
-
-[[Building-IntelliJ]]
-=== IntelliJ
-
-[source,text]
--------------
-mvn idea:idea
--------------
-
-[[Building-Eclipse]]
-=== Eclipse
-
-There are several ways to import the projects into Eclipse.
-
-[[Building-m2e]]
-m2e
-
-Starting with Camel 2.14.0, Camel can be imported into Eclipse using m2e
-Maven integration.
-
-Before you start: It is important to run Eclipse with at least 4 GB of
-heap memory, otherwise the import process will fail. To increase the
-heap size, edit the "eclipse.ini" file and set the -Xmx parameter as
-follows:
-
-*eclipse.ini*
-
-[source,java]
----------
-[...]
--Xms4G
--Xmx4G
----------
-
-TIP: For a better experience some users set 8 GB when all projects are loaded and opened.
-
-[[Building-CloningtheGitRepository]]
-Cloning the Git Repository 
-
-Either follow instructions about getting the latest
-source, or clone the Git repository with Eclipse by
-selecting *File -> Import -> Git / Projects from Git* and *Clone URI*.
-Provide all repository details in the import wizard and clone the
-repository into a directory outside of the Eclipse workspace. Once
-cloning has completed, exit the import project wizard (i.e. simply
-select cancel when asked to select "Wizard for project import").
-
-[[Building-ImportMavenProjects]]
-Import Maven Projects
-
-Import Camel projects as Maven projects using m2e by selecting *File ->
-Import -> Maven -> Existing Maven Projects*. Point the wizard to the
-root directory of the cloned repository. Eclipse will analyze all Camel
-projects and eventually present the following summary:
-
-image::camel-eclipse-m2e-import.png[image]
-
-Simply confirm the import of all projects by clicking *Finish*. The
-import process will create Eclipse projects and automatically set up
-build paths using dependency details provided by the pom.xml files. Once
-completed, all Camel projects will be available in your workspace:
-
-image::camel-eclipse-m2e-import-completed.png[image]
-
-NOTE: As you can see main project is combined with multiple sub projects/modules (e.g. components, archetypes, tooling etc.). Many sub projects/modules are again categorized or packaged with another layer of sub modules and so on. Developers can import project/module which is relevant to them and work on it instead importing entire project which will consume memory and eventually slow down Eclipse. This approach is not only easy to import and work in eclipse as well as easy to test. Lets [...]
-
-[[Building-maven-eclipse-plugin]]
-maven-eclipse-plugin
-
-The maven-eclipse-plugin can be used to generate the
-.classpath/.project/.settings file that Eclipse need. To do this, run:
-
-[source,text]
-----------------------------------------
-mvn process-test-sources eclipse:eclipse
-----------------------------------------
-
-or
-
-[source,text]
--------------------------------------------------------------------
-mvn -Psetup.eclipse -Declipse.workspace.dir=/path/to/your/workspace
--------------------------------------------------------------------
-
-The latter is recommended as it would completely setup the workspace for
-you as well as provide options to wire in other projects also found in
-your workspace.
-
-After running the above command, from within Eclipse, do *File -> Import
--> Existing Projects into Workspace*, select the root camel checkout
-location and Eclipse should find all the projects.
-
-[[Building-AddingCamelEclipsetemplatestoyourworkspace]]
-Adding Camel Eclipse templates to your workspace
-
-The above mentioned setup.eclipse profile does a few additional things
-to your workspace:
-
-1.  Adds the Camel code templates (see
-http://janstey.blogspot.com/2008/08/eclipse-templates-for-apache-camel.html[here])
-2.  Sets the M2_REPO variable in the workspace that points to your local
-Maven repository (i.e., `~/.m2/repository` on Unix and
-`c:\Documents and Settings\<user>\.m2\repository` on Windows) which
-allows the jars to be resolved.
-
-[[Building-Hint:specifytheworkspacelocationinyour.m2/settings.xml]]
-Hint: specify the workspace location in your .m2/settings.xml
-
-You can add a profile to your .m2/settings.xml to specify your eclipse
-workspace location so you can avoid having to type that each time you
-need to update the projects.
-
-[source,xml]
---------------------------------------------------------------------------
-<profiles>
-    <profile>
-        <id>setup.eclipse</id>
-        <properties>
-            <eclipse.workspace>/path/to/your/workspace</eclipse.workspace>
-        </properties>
-    </profile>
-</profiles>
---------------------------------------------------------------------------
-
 [[Building-Buildingwithcheckstyle]]
 == Building with checkstyle
 
@@ -214,7 +79,7 @@ To enable source style checking with checkstyle, build Camel with the
 
 [source,text]
 -------------------------------
-mvn -Psourcecheck clean install
+mvn clean install -Psourcecheck 
 -------------------------------
 
 [[Building-Buildingsourcejars]]
@@ -242,23 +107,3 @@ correct. You can do this running the following maven goal from the
 mvn clean install -Pvalidate
 ----------------------------
 
-[[Building-ExecutingunittestsusingEkstazi]]
-== Executing unit tests using Ekstazi
-
-Normally, when you execute the unit tests during your development cycle
-for a particular component, you are executing all the tests each time.
-This may become inefficient, when you are changing one class and the
-effect of this change is limited within the component having many unit
-tests. Ekstazi is a regression testing tool that can keep track of the
-test results and the changed classes so that unaffected tests can be
-skipped during the subsequent testing. For more details of Ekstazi,
-please refer to the Ekstazi page
-at http://www.ekstazi.org[http://www.ekstazi.org].
-
-To use Ekstazi, you can run the tests with the maven profile ekstazi.
-
-[source,text]
-------------------
-mvn test -Pekstazi
-------------------
-
diff --git a/parent/pom.xml b/parent/pom.xml
index 6003e51..6478716 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -177,7 +177,6 @@
         <egit-github-core-bundle-version>2.1.5_1</egit-github-core-bundle-version>
         <ehcache-version>2.10.6</ehcache-version>
         <ehcache3-version>3.8.1</ehcache3-version>
-        <ekstazi-maven-plugin-version>5.3.0</ekstazi-maven-plugin-version>
         <elasticsearch-rest-sniffer-version>7.3.2</elasticsearch-rest-sniffer-version>
         <elasticsearch-rest-cluster-runner-version>7.3.2.0</elasticsearch-rest-cluster-runner-version>
         <elasticsearch-rest-version>7.3.2</elasticsearch-rest-version>
@@ -4591,56 +4590,6 @@
             </build>
         </profile>
 
-        <!-- experimental profile to activate ekstazi http://www.ekstazi.org -->
-        <profile>
-            <id>ekstazi</id>
-            <activation>
-                <property>
-                    <name>ekstazi</name>
-                </property>
-            </activation>
-
-            <dependencies>
-                <dependency>
-                    <groupId>org.codehaus.woodstox</groupId>
-                    <artifactId>woodstox-core-asl</artifactId>
-                    <version>${woodstox-version}</version>
-                    <scope>test</scope>
-                </dependency>
-            </dependencies>
-
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.ekstazi</groupId>
-                        <artifactId>ekstazi-maven-plugin</artifactId>
-                        <version>${ekstazi-maven-plugin-version}</version>
-                        <configuration>
-                            <!-- always run tests that failed in prevoius run -->
-                            <forcefailing>true</forcefailing>
-                        </configuration>
-                        <executions>
-                            <execution>
-                                <id>doit</id>
-                                <goals>
-                                    <goal>select</goal>
-                                    <goal>restore</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
-
-                    <plugin>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <version>${maven-surefire-plugin-version}</version>
-                        <configuration>
-                            <excludesFile>${java.io.tmpdir}/${user.name}EkstaziExcludes</excludesFile>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-
         <profile>
             <id>partial-build</id>
             <activation>