Skip to content

Commit

Permalink
Enhance native build documentation and adjust CONTRIBUTING section
Browse files Browse the repository at this point in the history
  • Loading branch information
HannesWell committed Jun 9, 2024
1 parent 6eeb449 commit 33d0ef9
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 8 deletions.
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand All @@ -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
Expand Down
23 changes: 20 additions & 3 deletions features/org.eclipse.equinox.executable.feature/README.md
Original file line number Diff line number Diff line change
@@ -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/<window-system>` 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/<window-system>` sub-directory of interest and run
- `./build.sh` for Linux or MacOS
- `.\build.bat` for Windows.

Expand Down

0 comments on commit 33d0ef9

Please sign in to comment.