Skip to content

doc: clarify useCodeCache setting for cross-platform SEA generation #53994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 8 commits into from
Jul 31, 2024
Merged

doc: clarify useCodeCache setting for cross-platform SEA generation #53994

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a94e7d7
doc: clarify `useCodeCache` setting for cross-platform SEA generation
Jul 22, 2024
e8e6fa3
Update doc/api/single-executable-applications.md
debbs061 Jul 23, 2024
c1685cf
doc: clarify `useCodeCache` and `useSnapshot` settings for cross-plat…
Jul 23, 2024
62b2136
fix: apply markdown formatting
Jul 24, 2024
10fb674
Update doc/api/single-executable-applications.md
debbs061 Jul 25, 2024
85e081b
Update doc/api/single-executable-applications.md
debbs061 Jul 26, 2024
32d6d8a
Update doc/api/single-executable-applications.md
debbs061 Jul 27, 2024
1921bf1
doc: add line breaks for better readability
Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/api/single-executable-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,11 @@ If the paths are not absolute, Node.js will use the path relative to the
current working directory. The version of the Node.js binary used to produce
the blob must be the same as the one to which the blob will be injected.

Note: When generating cross-platform SEAs (e.g., generating an SEA on
platform A for platform B), `useCodeCache` and `useSnapshot` must be set to
false to avoid generating 'broken' executables. The generated executable might
crash on startup if these settings are not configured properly.

### Assets

Users can include assets by adding a key-path dictionary to the configuration
Expand Down