Skip to content

Updated Linux building instructions.#1624

Open
bkaradzic-microsoft wants to merge 4 commits intomasterfrom
update-docs
Open

Updated Linux building instructions.#1624
bkaradzic-microsoft wants to merge 4 commits intomasterfrom
update-docs

Conversation

@bkaradzic-microsoft
Copy link
Contributor

No description provided.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Ubuntu/Linux build documentation to reflect a new set of required system packages and an updated CMake configuration example for selecting the JavaScript engine.

Changes:

  • Replaces the example Ubuntu dependency installation command with a new apt install package list.
  • Updates the JavaScriptCore CMake configuration example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copy link

Copilot AI commented Mar 10, 2026

@bkaradzic-microsoft I've opened a new pull request, #1625, to work on those changes. Once the pull request is ready, I'll request review from you.

Copy link

Copilot AI commented Mar 10, 2026

@bkaradzic-microsoft I've opened a new pull request, #1626, to work on those changes. Once the pull request is ready, I'll request review from you.

Copy link

Copilot AI commented Mar 10, 2026

@bkaradzic-microsoft I've opened a new pull request, #1627, to work on those changes. Once the pull request is ready, I'll request review from you.

BUILDING.md Outdated

```
cmake -G Ninja -D JAVASCRIPTCORE_LIBRARY=/usr/lib/x86_64-linux-gnu/libjavascriptcoregtk-4.1.so -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore
cmake -G Ninja -D -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Path to JSC .so is not needed anymore here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bghgary Said it's default now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so this must be updated as well ?

cmake -G Ninja -B build/Linux -D JAVASCRIPTCORE_LIBRARY=/usr/lib/x86_64-linux-gnu/libjavascriptcoregtk-4.1.so -D NAPI_JAVASCRIPT_ENGINE=${{parameters.JSEngine}} -D CMAKE_BUILD_TYPE=RelWithDebInfo -D BX_CONFIG_DEBUG=ON -D CMAKE_UNITY_BUILD=$(UNITY_BUILD) -D OpenGL_GL_PREFERENCE=GLVND -D BABYLON_DEBUG_TRACE=ON -D ENABLE_SANITIZERS=$(SANITIZER_FLAG) .

Copy link
Contributor

@bghgary bghgary Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot AI and others added 3 commits March 10, 2026 07:05
…1626)

The Linux build instructions referenced a "Clang-9 toolchain" for a
package install command that actually installs `g++` (GCC), not Clang.

## Change
- Updated the description label from "Clang-9 toolchain" → "GCC
toolchain" to accurately reflect the `apt install` command that follows
it.

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bkaradzic-microsoft <260535795+bkaradzic-microsoft@users.noreply.github.com>
…nstructions (#1627)

The Linux build instructions listed `libjavascriptcoregtk-4.1-dev` in
the base mandatory packages, causing it to be installed for all engine
targets (including V8) and duplicating the engine-specific install step.
The base command also used `apt` while engine-specific steps used
`apt-get`.

## Changes

- **Remove `libjavascriptcoregtk-4.1-dev` from base install** —
engine-specific packages now live only in their respective engine
sections
- **Standardize on `apt-get`** throughout the Linux section for
consistency

Before:
```
sudo apt install libgl1-mesa-dev x11proto-core-dev libx11-dev libcurl4-openssl-dev libjavascriptcoregtk-4.1-dev g++ cmake ninja-build npm
```

After:
```
sudo apt-get install libgl1-mesa-dev x11proto-core-dev libx11-dev libcurl4-openssl-dev g++ cmake ninja-build npm
```

<!-- START COPILOT CODING AGENT TIPS -->
---

🔒 GitHub Advanced Security automatically protects Copilot coding agent
pull requests. You can protect all pull requests by enabling Advanced
Security for your repositories. [Learn more about Advanced
Security.](https://gh.io/cca-advanced-security)

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bkaradzic-microsoft <260535795+bkaradzic-microsoft@users.noreply.github.com>
The JavaScriptCore cmake invocation in `BUILDING.md` contained a stray
`-D` flag (`-D -D NAPI_JAVASCRIPT_ENGINE=...`), making it an invalid
command that would fail immediately.

## Changes

- **Remove stray `-D`** from the JavaScriptCore cmake command
- **Add `-B build/linux`** to both JavaScriptCore and V8 cmake commands
— consistent with every other platform section in the docs
- **Replace bare `ninja`** with `cmake --build build/linux` to match the
out-of-source build pattern used elsewhere

Before/after for the broken command:
```sh
# Before (invalid)
cmake -G Ninja -D -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore

# After
cmake -B build/linux -G Ninja -D NAPI_JAVASCRIPT_ENGINE=JavaScriptCore
```

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bkaradzic-microsoft <260535795+bkaradzic-microsoft@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants