From 032879627037f0e102629882e92b9b3a3be7aa37 Mon Sep 17 00:00:00 2001 From: nickboldt Date: Wed, 29 Aug 2018 12:46:19 -0400 Subject: [PATCH] add readme about how to build, why repos were merged, and TM-RSE cross-dependencies Change-Id: I62554303f32c1d844949fbcd9ccb58729ce2a41e Signed-off-by: nickboldt --- README.adoc | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 00000000000..2b6e7d3e1b7 --- /dev/null +++ b/README.adoc @@ -0,0 +1,36 @@ +== Building + +`mvn clean install` + +Or, enable jar signing with `-P eclipse-sign`. + +There is only one test plugin, and it currently has one failing test. So you will likely want to add the `-DskipTests` flag to avoid that. + +An update site and zip will be produced in the `site/target/` folder, which contains features and plugins from both RSE and Terminal. + +== Circular Dependencies + +In theory, the Remote System Explorer (RSE) and Terminal are independent projects. + +In practice, they each depend on each other, which is why we've now merged the RSE (org.eclipse.tm) and Terminal (org.eclipse.tm.terminal) repos into a single gerrit repo to resolve this cycle and make building easier. + +=== In RSE + +* rse/plugins/org.eclipse.rse.terminals.ui/META-INF/MANIFEST.MF +depends on + *org.eclipse.tm.terminal.control* + +* rse/features/org.eclipse.rse.terminals-feature/feature.xml +depends on + *org.eclipse.tm.terminal.control.feature* + +=== In TM.terminal: + +* plugins/org.eclipse.tm.terminal.view.ui.rse/META-INF/MANIFEST.MF +depends on + *org.eclipse.rse.core, org.eclipse.rse.subsystems.files.core, org.eclipse.rse.ui* + +* features/org.eclipse.tm.terminal.view.rse.feature/feature.xml +depends on + *org.eclipse.rse.core, org.eclipse.rse.subsystems.files.core, org.eclipse.rse.ui* +