jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pmoua...@apache.org
Subject svn commit: r1769526 - in /jmeter/trunk: build.xml eclipse.md eclipse.readme xdocs/building.xml
Date Sun, 13 Nov 2016 17:37:07 GMT
Author: pmouawad
Date: Sun Nov 13 17:37:07 2016
New Revision: 1769526

URL: http://svn.apache.org/viewvc?rev=1769526&view=rev
Log:
Move eclipse.readme to eclipse.md and update docs and building.xml

Added:
    jmeter/trunk/eclipse.md
      - copied, changed from r1769515, jmeter/trunk/eclipse.readme
Removed:
    jmeter/trunk/eclipse.readme
Modified:
    jmeter/trunk/build.xml
    jmeter/trunk/xdocs/building.xml

Modified: jmeter/trunk/build.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/build.xml?rev=1769526&r1=1769525&r2=1769526&view=diff
==============================================================================
--- jmeter/trunk/build.xml (original)
+++ jmeter/trunk/build.xml Sun Nov 13 17:37:07 2016
@@ -1420,7 +1420,7 @@ run JMeter unless all the JMeter jars ar
     <exclude name="${dest.jar.jmeter}/testfiles/Sample_*.png"/>
     <include name="eclipse.classpath"/>
     <include name="eclipse.project"/>
-    <include name="eclipse.readme"/>
+    <include name="eclipse.md"/>
     <include name=".gitignore"/>
     <include name=".travis.yml"/>
     <include name="checkstyle.xml"/>

Copied: jmeter/trunk/eclipse.md (from r1769515, jmeter/trunk/eclipse.readme)
URL: http://svn.apache.org/viewvc/jmeter/trunk/eclipse.md?p2=jmeter/trunk/eclipse.md&p1=jmeter/trunk/eclipse.readme&r1=1769515&r2=1769526&rev=1769526&view=diff
==============================================================================
--- jmeter/trunk/eclipse.readme (original)
+++ jmeter/trunk/eclipse.md Sun Nov 13 17:37:07 2016
@@ -1,35 +1,25 @@
-   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
+![Apache JMeter logo](https://jmeter.apache.org/images/logo.svg)
+# Eclipse Configuration for JMeter project
 
-       http://www.apache.org/licenses/LICENSE-2.0
+## Eclipse settings
 
-   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.
+The following files should be excluded from build output:
 
+> `*.metaprops`
+ 
+See `Project Preferences/Java Compiler/Building/Output Folder/Filtered Resources`
 
 
-Eclipse settings
-----------------
-The following files should be excluded from build output:
-*.metaprops
-See Preferences/Java/Building/Output Folder/Filtered Resources
+## Eclipse.classpath
 
+** This has been tested with Eclipse 3.2 up to 4.6.1. It may not work with other versions.
**
 
-Eclipse.classpath
------------------
-[This has been tested with Eclipse 3.2 up to 4.3.2. It may not work with other versions.]
+The file `eclipse.classpath` is intended as a starter `.classpath` file 
+for building JMeter using Eclipse version 3 to 4.6.  
 
-The file eclipse.classpath is intended as a starter .classpath file 
-for building JMeter using Eclipse version 3 to 4.3.  Make sure to execute
-the "ant download_jars" task to download and install the jars referred
+Make sure to execute the `ant download_jars` task to download and install the jars referred
 to in the classpath before creating the Eclipse project. 
+
 If you do after creating project, then don't forget to refresh Eclipse project. 
 
 Note that Eclipse is not easy to use for creating jar files.
@@ -37,68 +27,70 @@ However, it is easy to use Eclipse to ru
 
 The following targets may prove useful:
 
-  clean - Clean up to force a build from source
-  package-only - creates the jars
-  package - compiles everything and then packages it
-  run_gui - compiles, packages, and then start the JMeter GUI from the jars
-
-Invoking Ant targets inside Eclipse
-----------------------------------
-You can use the "Run As --> Ant Build" and select target, or you can use
-the "Windows->Show View->Ant View". Then select the "build.xml" file and
-drag and drop to the "Ant View".
+  - `clean` - Clean up to force a build from source
+  - `package-only` - creates the jars
+  - `package` - compiles everything and then packages it
+  - `run_gui` - compiles, packages, and then start the JMeter GUI from the jars
+
+## Invoking Ant targets inside Eclipse
+
+You can use the `Run As --> Ant Build` and select target, or you can use
+the `Windows->Show View->Ant View`. Then select the `build.xml` file and
+drag and drop to the `Ant View`.
 Now you can invoke targets by clicking on them.
-Note that if you invoke for example the "compile" target, and get error
+Note that if you invoke for example the `compile` target, and get error
 messages about 
-"
-Unable to find a javac compiler;
-com.sun.tools.javac.Main is not on the classpath.
-Perhaps JAVA_HOME does not point to the JDK
-"
+
+
+> Unable to find a javac compiler;
+  com.sun.tools.javac.Main is not on the classpath.
+  Perhaps JAVA_HOME does not point to the JDK
+
+
 it just means that your Eclipse project is set up with JRE libraries instead of JDK libraries.
-The suggested fix is to add a JDK in "Window->Preferences->Java->Installed JREs".
-Then do a "Project->Properties" and select "Java Build Path" in the left pane, and then
-select the "Libraries" tab in the right pane. Scroll to the bottom, select the "JRE System
Library",
-and click "Remove". Then click "Add library..." , select "JRE System Library", and then select
-the JDK. Now it should work when you invoke the "compile" target.
+The suggested fix is to add a JDK in `Window->Preferences->Java->Installed JREs`.
+
+Then do a `Project->Properties` and select `Java Build Path` in the left pane, and then
+select the `Libraries` tab in the right pane. Scroll to the bottom, select the `JRE System
Library`,
+and click `Remove`. Then click `Add library...` , select `JRE System Library`, and then select
+the JDK. 
+
+Now it should work when you invoke the `compile` target.
 
 
-Finishing the build using Ant
------------------------------
+## Finishing the build using Ant
 
-Find the build.xml file in the project, 
-right click on it, and click "Run As --> Ant Build".
+Find the `build.xml` file in the project, 
+right click on it, and click `Run As --> Ant Build`.
 
-Make sure you select the "package" target.
+Make sure you select the `package` target.
 
 This will compile any remaining classes,
 and then create all the jars.
 
 Now refresh the project (you should add this to the Ant build properties)
 
-Launching from Eclipse
-----------------------
+## Launching from Eclipse
 
-You can use the Ant target run_gui to run the JMeter GUI, or you can follow the instructions
+You can use the Ant target `run_gui` to run the JMeter GUI, or you can follow the instructions
 below to add a Java Application launch, which will for example, allow you to use the debugger
to
 run JMeter.
 
 These instructions assume you have configured Eclipse to use the classpath
-as suggested in eclipse.classpath, and have run "ant package" to compile
+as suggested in eclipse.classpath, and have run `ant package` to compile
 the RMI classes and build the jars.
 
 Create a new Java Application launch configuration.
 
 On the Main tab, enter the following as the main class:
 
-  org.apache.jmeter.NewDriver
+> `org.apache.jmeter.NewDriver`
   
 On the Arguments tab, in the Working Directory area, pick the radio
-button next to "Other" and enter the following in the text box:
+button next to `Other` and enter the following in the text box:
 
-  ${workspace_loc}/jmeterproject/bin
+> `${workspace_loc}/jmeter/bin`
   
- where "jmeterproject" is the name of the JMeter project.
+ where `jmeter` is the name of the JMeter project.
  
- [It would be nicer to use ${project_loc}/bin 
- but unfortunately the Eclipse Debug view does not seem to preserve any of the project variables]
+ **It would be nicer to use `${project_loc}/bin` but unfortunately the Eclipse Debug view
does not seem to preserve any of the project variables **

Modified: jmeter/trunk/xdocs/building.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/building.xml?rev=1769526&r1=1769525&r2=1769526&view=diff
==============================================================================
--- jmeter/trunk/xdocs/building.xml (original)
+++ jmeter/trunk/xdocs/building.xml Sun Nov 13 17:37:07 2016
@@ -65,7 +65,7 @@ install the dependent jars, you can conf
 file with the <code>eclipse.classpath</code> file provided with JMeter. This
will set up the source-paths and most of the libraries.
 </p>
 <p>
-Ensure you read <code>eclipse.readme</code> for project configuration.
+Ensure you read <code>eclipse.md</code> for project configuration.
 </p>
 
 



Mime
View raw message