doc: clarify useCodeCache setting for cross-platform SEA generation

PR-URL: #53994 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
nodejs · Aug 14, 2024 · 923195b · 923195b
1 parent 037672f
commit 923195b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/api/single-executable-applications.md b/doc/api/single-executable-applications.md
@@ -190,6 +190,13 @@ 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 a SEA
+for `linux-x64` on `darwin-arm64`), `useCodeCache` and `useSnapshot`
+must be set to false to avoid generating incompatible executables.
+Since code cache and snapshots can only be loaded on the same platform
+where they are compiled, the generated executable might crash on startup when
+trying to load code cache or snapshots built on a different platform.
+
 ### Assets
 
 Users can include assets by adding a key-path dictionary to the configuration