Skip to content

Commit

Permalink
doc: clarify process.title inconsistencies
Browse files Browse the repository at this point in the history
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: #28945
PR-URL: #34557
Fixes: #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>
  • Loading branch information
coreybutler authored and addaleax committed Sep 22, 2020
1 parent a92aec1 commit e67bd9e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2368,6 +2368,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
Expand Down

0 comments on commit e67bd9e

Please sign in to comment.