From: Alexandre Montplaisir Date: Wed, 21 Jan 2015 20:42:41 +0000 (-0500) Subject: Convert the top-level Readme to markdown + small updates X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=4c7ca017816f7ebda4983a2549219d53bfdd17ec;p=deliverable%2Ftracecompass.git Convert the top-level Readme to markdown + small updates Also updated the plugins.svg diagram. Change-Id: Ibb9cdcc7afee56cb728b75bab58de06737a2d2bc Signed-off-by: Alexandre Montplaisir Reviewed-on: https://git.eclipse.org/r/40068 Reviewed-by: Marc-Andre Laperle Tested-by: Marc-Andre Laperle --- diff --git a/README b/README deleted file mode 100644 index 0a786ea558..0000000000 --- a/README +++ /dev/null @@ -1,53 +0,0 @@ -This source tree contains the source code for the Trace Compass plugins for -Eclipse. - -The plugins are categorized as follows: -org.eclipse.tracecompass.ctf.* Common Trace Format (CTF) reader library -org.eclipse.tracecompass.gdbtrace.* Support for reading and viewing GDB traces -org.eclipse.tracecompass.lttng2.* LTTng 2.x integration -org.eclipse.tracecompass.tmf.* Core framework -org.eclipse.tracecompass.statesystem.* State System library -org.eclipse.tracecompass.rcp.* Code specific to the RCP version - -See the plugins.svg file for a diagram showing the dependencies between the -different plugins. - - -To set up the environment to build Trace Compass from within Eclipse, see this -wiki page: -http://wiki.eclipse.org/Trace_Compass/Development_Environment_Setup - - - - -To build the plugins manually using Maven, simply run the following command from -the top-level directory: -$ mvn clean install - - -The default command will compile and run the unit tests. Running the tests can -take some time, to skip them you can append "-Dmaven.test.skip=true" to the -'mvn' command: -$ mvn clean install -Dmaven.test.skip=true - - -The RCP is not built by default, to build it you need to add "-Pbuild-rcp" to -the 'mvn' command: -$ mvn clean install -Pbuild-rcp -Dmaven.test.skip=true - -This will build the RCP for all supported architectures. The resulting archives -will be placed in org.eclipse.tracecompass.rcp.product/target/products - - -To build a local p2 update site -$ mvn clean install -Pbuild-update-site - -This will place the p2 update site under the default location -/var/www/tools/tracecompass/nightly/ - -To change the package location, use: -$ mvn clean install -Pbuild-update-site "-DsiteDestination=" - -where is the absolute path to destination directory on -your disk. - diff --git a/README.md b/README.md new file mode 100644 index 0000000000..a7ac7c7c87 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +Eclipse Trace Compass +===================== + +This source tree contains the source code for the Trace Compass plugins for +Eclipse. + +The plugins are categorized as follows: + + org.eclipse.tracecompass.analysis.* | Generic extensions to the base framework + org.eclipse.tracecompass.btf.* | Best Trace Format (BTF) integration + org.eclipse.tracecompass.ctf.* | Common Trace Format (CTF) reader library + org.eclipse.tracecompass.gdbtrace.* | Support for reading and viewing GDB traces + org.eclipse.tracecompass.lttng2.* | LTTng 2.x integration + org.eclipse.tracecompass.pcap.* | libpcap integration + org.eclipse.tracecompass.rcp.* | Code specific to the RCP version + org.eclipse.tracecompass.statesystem.* | State System library + org.eclipse.tracecompass.tmf.* | Core framework + +See the `plugins.svg` file for a diagram showing the dependencies between the +different plugins. + + +Setting up the development environment +-------------------------------------- + +To set up the environment to build Trace Compass from within Eclipse, see this +wiki page: + + + +Compiling manually +------------------ + +To build the plugins manually using Maven, simply run the following command from +the top-level directory: + + mvn clean install + +The default command will compile and run the unit tests. Running the tests can +take some time, to skip them you can append `-Dmaven.test.skip=true` to the +`mvn` command: + + mvn clean install -Dmaven.test.skip=true + + +The RCP is not built by default, to build it you need to add `-Pbuild-rcp` to +the `mvn` command: + + mvn clean install -Pbuild-rcp -Dmaven.test.skip=true + +This will build the RCP for all supported architectures. The resulting archives +will be placed in `org.eclipse.tracecompass.rcp.product/target/products`. + + +To build a local p2 update site: + + mvn clean install -Pbuild-update-site "-DsiteDestination=/path/to/destination" + +where `/path/to/destination` is the **absolute** path to destination directory +on your disk. + diff --git a/plugins.dia b/plugins.dia index 08a37c5728..2fe040bbd7 100644 Binary files a/plugins.dia and b/plugins.dia differ diff --git a/plugins.svg b/plugins.svg index da9e97e25b..046121f9e9 100644 --- a/plugins.svg +++ b/plugins.svg @@ -1,109 +1,140 @@ - - - - - - - tmf.core - tmf.ui - - + - - - - tmf.ctf.* + + + + tmf.core + tmf.ui - - - - tmf.analysis.* + + + + tmf.ctf.* - - - - lttng2.kernel - lttng2.ust + + + + analysis.os.linux - - - - statesystem + + + + lttng2.kernel + lttng2.ust - - - - ctf.* + + + + statesystem - - - - - - - - + + + + ctf.* + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - TMF Framework - - - - - - - - + + - - - + + + - - Depends on + + Dependency + + + + + + + + + + + + pcap.* + + + + + + + tmf.pcap + + + + + + + + + + + + + + + + + btf.* - - Dependency to be removed + + + + + + gdbtrace.* + + + + + + + + + +