diff --git a/README.md b/README.md index 866f217..11d6875 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ To get up-and-running and to learn more about PPS, please read its documentation > [!NOTE] > Contributions are always welcome! -> Before starting PPS development, please read the [PPS Developer Guide](plugins/nl.esi.pps.doc.developer/adoc/index.adoc). +> Before starting PPS development, please read the [PPS Developer Guide](https://tno.github.io/PPS/develpperguide/). Follow these instructions to set up a PPS development environment. diff --git a/features/nl.esi.pps.tmsc.reconstruct.feature/.project b/features/nl.esi.pps.tmsc.reconstruct.feature/.project new file mode 100644 index 0000000..bf8cde1 --- /dev/null +++ b/features/nl.esi.pps.tmsc.reconstruct.feature/.project @@ -0,0 +1,17 @@ + + + nl.esi.pps.tmsc.reconstruct.feature + + + + + + org.eclipse.pde.FeatureBuilder + + + + + + org.eclipse.pde.FeatureNature + + diff --git a/features/nl.esi.pps.tmsc.reconstruct.feature/.settings/org.eclipse.core.resources.prefs b/features/nl.esi.pps.tmsc.reconstruct.feature/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 0000000..99f26c0 --- /dev/null +++ b/features/nl.esi.pps.tmsc.reconstruct.feature/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,2 @@ +eclipse.preferences.version=1 +encoding/=UTF-8 diff --git a/features/nl.esi.pps.tmsc.reconstruct.feature/build.properties b/features/nl.esi.pps.tmsc.reconstruct.feature/build.properties new file mode 100644 index 0000000..09b9d21 --- /dev/null +++ b/features/nl.esi.pps.tmsc.reconstruct.feature/build.properties @@ -0,0 +1,11 @@ +# +# Copyright (c) 2018-2025 TNO and Contributors to the GitHub community +# +# This program and the accompanying materials are made available +# under the terms of the MIT License which is available at +# https://opensource.org/licenses/MIT +# +# SPDX-License-Identifier: MIT +# + +bin.includes = feature.xml diff --git a/features/nl.esi.pps.tmsc.reconstruct.feature/feature.xml b/features/nl.esi.pps.tmsc.reconstruct.feature/feature.xml new file mode 100644 index 0000000..518480d --- /dev/null +++ b/features/nl.esi.pps.tmsc.reconstruct.feature/feature.xml @@ -0,0 +1,39 @@ + + + + + + [Enter Feature Description here.] + + + + [Enter Copyright Description here.] + + + + [Enter License Description here.] + + + + + + + diff --git a/plugins/nl.esi.pps.doc.developer/adoc/_section_reconstructor.adoc b/plugins/nl.esi.pps.doc.developer/adoc/_section_reconstructor.adoc index 160cb32..036990e 100644 --- a/plugins/nl.esi.pps.doc.developer/adoc/_section_reconstructor.adoc +++ b/plugins/nl.esi.pps.doc.developer/adoc/_section_reconstructor.adoc @@ -16,15 +16,21 @@ include::_initCommon.adoc[] The TMSC textual syntax allows you to create small example traces, to explore the PPS features. The textual syntax is not developed for large traces as it will suffer from scalability issues. Besides that, it is assumed that when using PPS in another domain, traces in another format are already available. -In both cases it is advised to write your own _reconstructor_ that converts these trace directly into a <> instance. +In both cases it is advised to write your own _reconstructor_ that converts these trace directly into a <> instance. This section gives an example on how to create such a custom reconstructor. -The custom TMSC reconstructor example is included in the PPS distribution, in the `examples` directory. -The example can be easily imported into your development environment by using the menu:File[Import...] menu and then choose to import menu:General[Existing Projects into Workspace] from the tree. -Now continue the wizard and select all the projects from the `examples` directory to be imported. +The custom TMSC reconstructor example is included in the PPS distribution. +The example can be easily imported into your development environment by: + +. Use the menu:File[Import...] menu and then choose to import menu:Plug-in Development[Plug-ins and Fragments] from the tree. +. On the next wizard page, select the `Projects with source folders` in the `Import As` section. +. On the next wizard page filter the available plug-ins and fragments by `nl.esi.pps.tmsc.reconstruct` and click the btn:[Add All ->] button. +- Now btn:[Finish] the wizard to import the projects. TIP: For more information on creating custom EMF resources or using extension points, please read the Eclipse and EMF documentation. +TIP: You can test the example by creating a `*.tmsctrace` file in a project within the Eclipse runtime instance and then use its menu:Reconstruct TMSC[] context menu to create a TMSC for the trace. + First choose a syntax for your trace (e.g., `tmsctrace` in our example) and register it by means of the `org.eclipse.emf.ecore.extension_parser` extension point in the <> of your plugin. [[plugin-xml-nl.esi.pps.tmsc.reconstruct]] diff --git a/plugins/nl.esi.pps.doc.developer/adoc/index.adoc b/plugins/nl.esi.pps.doc.developer/adoc/index.adoc index ed836c8..ec3297f 100644 --- a/plugins/nl.esi.pps.doc.developer/adoc/index.adoc +++ b/plugins/nl.esi.pps.doc.developer/adoc/index.adoc @@ -38,22 +38,22 @@ This section describes how to convert your PPS to an Eclipse PDE to customize PP . First extract the PPS distribution, choose a PPS version (i.e., windows or linux), extract it and start it, e.g. `pps.exe`. . Now use the menu:Help[Install New Software...] menu to install the `Eclipse Plugin Development Tools` from the Eclipse 2024-09 (i.e., 4.33) update site: https://download.eclipse.org/eclipse/updates/4.33/[] + + -image::{imgsdir}/install-pde.png[width=869,height=705] +image::{imgsdir}/install-pde.png[width=869,height=638] . Continue the wizard using the btn:[Next] button and finally the btn:[Finish] button. When asked, choose to restart the Eclipse IDE. -. (The next steps are optional, yet advised) Install the PPS sources by again using the menu:Help[Install New Software...] menu. - Now choose to add an update site by clicking the btn:[Add..] button. -. In the `Add Repository` dialog, choose to add an archived update site by clicking the btn:[Archive...] button. - Navigate to the directory where the PPS distribution is extracted and select the `nl.esi.pps.product-____.zip` archive. - Finally click the btn:[Add] button in the dialog to add the repository. -. Now select the `PPS` category in the wizard and continue the wizard using the btn:[Next] button and finally the btn:[Finish] button. +. After restart install the PPS sources by using the menu:Help[Install New Software...] menu. + Select the `PPS` category from the PPS (e.g., v0.30.0) update site: https://tno.github.io/PPS/update-site/v0.30.0/[] + ++ +IMPORTANT: Please make sure to select the right update site version for your installation. +You can see your installed PPS version from the menu:Help[About PPS vX.X] menu. +. Continue the wizard using the btn:[Next] button and finally the btn:[Finish] button. When asked, choose to restart the Eclipse IDE. - + Your environment is now ready for extending PPS, e.g., <> or <>. TIP: To start a PPS including your extensions, simply select one of your projects in the project/package explorer view and use its context menu (i.e., right mouse click) to menu:Run As[Eclipse Application]. -A new Eclipse instance will be executed containing all PPS features including your own features. +A new Eclipse instance (i.e. an Eclipse runtime instance) will be executed containing all PPS features including your own features. <<< diff --git a/plugins/nl.esi.pps.doc.developer/assembly.xml b/plugins/nl.esi.pps.doc.developer/assembly.xml new file mode 100644 index 0000000..65ba4fd --- /dev/null +++ b/plugins/nl.esi.pps.doc.developer/assembly.xml @@ -0,0 +1,24 @@ + + + website + + zip + + false + + + ${project.build.directory}/website + + + + \ No newline at end of file diff --git a/plugins/nl.esi.pps.doc.developer/images/install-pde.png b/plugins/nl.esi.pps.doc.developer/images/install-pde.png index e80a551..160726d 100644 Binary files a/plugins/nl.esi.pps.doc.developer/images/install-pde.png and b/plugins/nl.esi.pps.doc.developer/images/install-pde.png differ diff --git a/plugins/nl.esi.pps.doc.developer/pom.xml b/plugins/nl.esi.pps.doc.developer/pom.xml index 416a669..7bba4a3 100644 --- a/plugins/nl.esi.pps.doc.developer/pom.xml +++ b/plugins/nl.esi.pps.doc.developer/pom.xml @@ -22,6 +22,7 @@ nl.esi.pps.doc.developer eclipse-plugin + PPS Developer Guide @@ -128,6 +129,58 @@ + + + + generate-website + prepare-package + + process-asciidoc + + + ${project.build.directory}/website + html5 + + + images + + true + left + + + + + + ${basedir}/images + images + + + + + + + + generate-pdf + prepare-package + + process-asciidoc + + + index.adoc + ${project.build.directory}/website/pps-developer-guide.pdf + pdf + + + ${basedir}/images + + + + + + + + + @@ -176,6 +229,24 @@ + + + maven-assembly-plugin + + + package-website + package + + single + + + + ${basedir}/assembly.xml + + + + + \ No newline at end of file diff --git a/plugins/nl.esi.pps.tmsc.reconstruct.ui/src/nl/esi/pps/tmsc/reconstruct/ui/handlers/ReconstructHandler.java b/plugins/nl.esi.pps.tmsc.reconstruct.ui/src/nl/esi/pps/tmsc/reconstruct/ui/handlers/ReconstructHandler.java index 4ccf5d7..7e18cbb 100644 --- a/plugins/nl.esi.pps.tmsc.reconstruct.ui/src/nl/esi/pps/tmsc/reconstruct/ui/handlers/ReconstructHandler.java +++ b/plugins/nl.esi.pps.tmsc.reconstruct.ui/src/nl/esi/pps/tmsc/reconstruct/ui/handlers/ReconstructHandler.java @@ -65,7 +65,7 @@ private void reconstruct(IFile traceIFile) throws IOException, CoreException { // Saving models to file URI traceURI = URI.createPlatformResourceURI(traceIFile.getFullPath().toString(), true); - URI tmscURI = traceURI.trimFileExtension().appendFileExtension("tmscz"); + URI tmscURI = traceURI.trimFileExtension().appendFileExtension("tmsc"); ResourceSet resourceSet = new ResourceSetImpl(); Resource tmscResource = resourceSet.createResource(tmscURI); tmscResource.getContents().add(reconstructor.getTmsc()); diff --git a/products/nl.esi.pps.product/category.xml b/products/nl.esi.pps.product/category.xml index 1231205..13d6db2 100644 --- a/products/nl.esi.pps.product/category.xml +++ b/products/nl.esi.pps.product/category.xml @@ -35,6 +35,12 @@ + + + + + + @@ -43,8 +49,8 @@ The Platform Performance Suite, by ESI (TNO) - - - - + + + + diff --git a/products/nl.esi.pps.product/eclipse.product b/products/nl.esi.pps.product/eclipse.product index 1c6014f..d16e54c 100644 --- a/products/nl.esi.pps.product/eclipse.product +++ b/products/nl.esi.pps.product/eclipse.product @@ -27,7 +27,7 @@ --launcher.defaultAction openFile --launcher.appendVmargs - -Dosgi.requiredJavaVersion=11 + -Dosgi.requiredJavaVersion=21 -Declipse.p2.unsignedPolicy=allow -Djava.net.preferIPv4Stack=true -Dfile.encoding=UTF-8 diff --git a/releng/launches/Check License Headers.launch b/releng/launches/Check License Headers.launch new file mode 100644 index 0000000..73d197a --- /dev/null +++ b/releng/launches/Check License Headers.launch @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/releng/launches/PPS Product.launch b/releng/launches/PPS Product.launch index 7e3860d..2885c5d 100644 --- a/releng/launches/PPS Product.launch +++ b/releng/launches/PPS Product.launch @@ -17,15 +17,17 @@ + + - + diff --git a/releng/launches/Update License Headers.launch b/releng/launches/Update License Headers.launch new file mode 100644 index 0000000..f4cca5a --- /dev/null +++ b/releng/launches/Update License Headers.launch @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/releng/nl.esi.pps.website/pom.xml b/releng/nl.esi.pps.website/pom.xml index 26c5714..bffc99c 100644 --- a/releng/nl.esi.pps.website/pom.xml +++ b/releng/nl.esi.pps.website/pom.xml @@ -38,6 +38,14 @@ zip + + ${project.groupId} + nl.esi.pps.doc.developer + ${project.version} + website + zip + + ${project.groupId} nl.esi.pps.product @@ -100,6 +108,25 @@ ${project.build.directory}/website/userguide + + unpack-developer-guide + prepare-package + + unpack + + + + + ${project.groupId} + nl.esi.pps.doc.developer + ${project.version} + website + zip + + + ${project.build.directory}/website/developerguide + + unpack-update-site prepare-package