From 33d0ef9596b53bc40cf3243e9c184eb58142765e Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Sun, 9 Jun 2024 15:46:47 +0200 Subject: [PATCH] Enhance native build documentation and adjust CONTRIBUTING section --- CONTRIBUTING.md | 13 +++++++---- .../README.md | 23 ++++++++++++++++--- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49003431373..b03b29660f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,19 +15,17 @@ and other infrastructure for running OSGi-based systems. Information regarding source code management, builds, coding standards, and more. -* https://projects.eclipse.org/projects/eclipse.equinox/developer - The project maintains the following source code repositories -* https://github.com/eclipse-equinox/equinox.binaries * https://github.com/eclipse-equinox/equinox +* https://github.com/eclipse-equinox/equinox.binaries * https://github.com/eclipse-equinox/p2 This project uses GitHub to track ongoing development and issues. -* Search for issues: https://github.com/eclipse-equinox/equinox.binaries/issues +* Search for issues: https://github.com/eclipse-equinox/equinox/issues * Search for historical issues: https://eclipse.org/bugs/buglist.cgi?product=Equinox -* Create a new report: https://github.com/eclipse-equinox/equinox.binaries/issues/new +* Create a new report: https://github.com/eclipse-equinox/equinox/issues/new Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome! @@ -39,6 +37,11 @@ and run: `mvn clean verify -Pbuild-individual-bundles -Pbree-libs -Ptck` +### Building the native executable and launcher library binaries + +The source code to build the platform specific executables and launcher libraries for Equinox is located in [org.eclipse.equinox.executable.feature](features/org.eclipse.equinox.executable.feature). +For details see its [README.md](features/org.eclipse.equinox.executable.feature/README.md). + ## Eclipse Contributor Agreement Before your contribution can be accepted by the project team contributors must diff --git a/features/org.eclipse.equinox.executable.feature/README.md b/features/org.eclipse.equinox.executable.feature/README.md index e450974cdad..8ed284456a4 100644 --- a/features/org.eclipse.equinox.executable.feature/README.md +++ b/features/org.eclipse.equinox.executable.feature/README.md @@ -1,9 +1,26 @@ This feature contains the eclipse executables and includes the equinox launcher bundle and its fragments. -It also host the native C source files to build the executable and launcher binaries for all supported platforms. +It also hosts the native C source files to build the executable and launcher library binaries for all supported platforms. -## Building the native executable and launcher binaries +# Building the native executable and launcher binaries -To just build the native binaries navigate to the `library/` sub-directory of interest and run +## Required software + +The software listed below is required to build the Equinox native binaries on the current platform targeting the same OS and processor arch. + +- Windows: + - Microsoft Visual C Compiler 2019 or later (earlier version can also work), the 'Visual Studio Community Edition' is sufficient. +- Linux: + - GTK development files. The Package `libgtk-3-dev` is sufficient. +- MacOS: + - TBD + +## Running the build + +The simplest way to build and install the native binaries for the running platform is to launch the Maven launch-configuration +named `Build-Equinox-native-binaries-for-running-platform` from this project (requires Eclipse M2E being installed). +It assumes the [`equinox.binaries`](https://github.com/eclipse-equinox/equinox.binaries.git) repository is checked out located next to this repository and is named `equinox.binaries`. + +To just build the native binaries for a specific platform navigate to the `library/` sub-directory of interest and run - `./build.sh` for Linux or MacOS - `.\build.bat` for Windows.