1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify process.title inconsistencies

Browse Source 
Many users assume the act of assigning a value to `process.title` will
update the name of their application in apps like macOS Activity Monitor
or Windows Services Manager. This has worked in the past, but fails in
some versions of Node.js. Ultimately developers are left confused,
especially when it works in one version of Node.js and not another.
Given the recurring nature and complexity of the underlying problem, it
does not seem like a resolvable problem. This note clarifies the source
of the problem, sets developer expectations.

Refs: https://github.com/nodejs/node/issues/28945
PR-URL: https://github.com/nodejs/node/pull/34557
Fixes: https://github.com/nodejs/node/issues/34280
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Corey Butler 2020-07-29 17:23:51 -05:00 committed by Rich Trott
parent d5c7aec3cb
commit 84b35b2867
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/process.md
View File

@ -2423,6 +2423,12 @@ allowed for longer process title strings by also overwriting the `environ`
memory but that was potentially insecure and confusing in some (rather obscure)
cases.
Assigning a value to `process.title` _may_ not reflect an accurate
(or any) label within the process manager application of the underlying
operating system (i.e. macOS Activity Monitor, Windows Services Manager, etc).
Inconsistencies and breaking changes within the _operating systems process
interface_ make synchronization with these applications unreliable.
## `process.traceDeprecation`
<!-- YAML
added: v0.8.0