doc: add missing worker error #21947
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER was missing from the docs - add it there based on the wording Anna used in the her PR. PR-URL: Reviewed-By:
nodejs-github-bot
added
doc
4 tasks
addaleax
reviewed
Jul 23, 2018
doc/api/errors.md
Outdated
|
|
||
| A SharedArrayBuffer object was transfered but we do not see a lifetime partner | ||
| object and it was not us who externalized it - we are not sure how to serialize | ||
| it because it's unclear how the memory is actually owned. |
There was a problem hiding this comment.
This description makes sense as a code comment, but it might not be ideal for the docs. How about this?
A
SharedArrayBufferobject was encountered during serialization whose memory is not managed by the JavaScript engine or by Node. Such anSharedArrayBuffercan not be serialized.This can only happen when native addons create
SharedArrayBuffers in “externalized” mode, or put existingSharedArrayBufferinto externalized mode.
|
@benjamingr Thanks! In fact, this was noticed by a testcase from #21470 😉. |
doc/api/errors.md
Outdated
| <a id="ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER"></a> | ||
| ### ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER | ||
|
|
||
| A `SharedArrayBuffer` whose memory is not managed by the JavaScript engine or by Node.js was |
There was a problem hiding this comment.
Line length here and below)
doc/api/errors.md
Outdated
| ### ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER | ||
|
|
||
| A `SharedArrayBuffer` whose memory is not managed by the JavaScript engine or by Node.js was | ||
| encountered during serialization. Such a `SharedArrayBuffer` can not be serialized. |
vsemozhetbyt
approved these changes
Jul 23, 2018
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
lpinca
approved these changes
Jul 23, 2018
JungMinu
approved these changes
Jul 25, 2018
cjihrig
approved these changes
Jul 27, 2018
jasnell
approved these changes
Jul 27, 2018
|
Landed in f42aa32 |
addaleax
pushed a commit
that referenced
this pull request
Jul 27, 2018
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER was missing from the docs - add it there based on the wording Anna used in the her PR. PR-URL: #21947 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
targos
pushed a commit
that referenced
this pull request
Jul 31, 2018
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER was missing from the docs - add it there based on the wording Anna used in the her PR. PR-URL: #21947 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
This was referenced Aug 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@ChALkeR noticed that
ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFERwas missing from the docs. This PR adds it there based on the wording @addaleax used in the her PR.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes