diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-09-29 19:30:44 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-02 09:39:38 -0700 |
| commit | 344c5c454dd3792502e59ef715cb4ed2ee72ac24 (patch) | |
| tree | 5d0ac1f671981a68518cc2e39656ef127e193a4b /doc | |
| parent | ddcd2359f4adc9fe34e793ad5c1ed33ce500eed7 (diff) | |
| download | android-node-v8-344c5c454dd3792502e59ef715cb4ed2ee72ac24.tar.gz android-node-v8-344c5c454dd3792502e59ef715cb4ed2ee72ac24.tar.bz2 android-node-v8-344c5c454dd3792502e59ef715cb4ed2ee72ac24.zip | |
doc: clarify --pending-deprecation effects on Buffer() usage
Refs: https://github.com/nodejs/node/pull/29725#issuecomment-535723152
PR-URL: https://github.com/nodejs/node/pull/29769
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/deprecations.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 46d2467c72..1082e76be2 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -154,9 +154,10 @@ objects: * [`Buffer.from(string[, encoding])`][from_string_encoding] - Create a `Buffer` that copies `string`. -As of v10.0.0, a deprecation warning is printed at runtime when -`--pending-deprecation` is used or when the calling code is -outside `node_modules` in order to better target developers, rather than users. +Without `--pending-deprecation`, runtime warnings occur only for code not in +`node_modules`. This means there will not be deprecation warnings for +`Buffer()` usage in dependencies. With `--pending-deprecation`, a runtime +warning results no matter where the `Buffer()` usage occurs. <a id="DEP0006"></a> ### DEP0006: child\_process options.customFds |