Skip to content

Commit 5ac3533

Browse files
committed
doc: describe perfetto builds without naming the configure flag
Keep the --with-perfetto flag itself documented in BUILDING.md and refer to a perfetto build by its observable behavior in doc/api, matching how cli.md already describes FFI-gated builds. Signed-off-by: Lazizbek Ergashev <lazerg2@gmail.com>
1 parent 228464b commit 5ac3533

2 files changed

Lines changed: 8 additions & 9 deletions

File tree

doc/api/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3303,8 +3303,8 @@ added: v9.8.0
33033303

33043304
Template string specifying the filepath for the trace event data, it
33053305
supports `${rotation}` and `${pid}`. It defaults to `node_trace.${rotation}.log`,
3306-
or to `node_trace.${rotation}.pftrace` when Node.js is built with the
3307-
`--with-perfetto` configure flag. See [Trace events][] for details.
3306+
or to `node_trace.${rotation}.pftrace` in builds with Perfetto support. See
3307+
[Trace events][] for details.
33083308

33093309
### `--trace-events-enabled`
33103310

doc/api/tracing.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,11 @@ string that supports `${rotation}` and `${pid}`:
102102
node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js
103103
```
104104

105-
Node.js can also be built with the `--with-perfetto` configure flag, described
106-
in [BUILDING.md][]. Such a build writes [Perfetto][] protobuf traces instead of
107-
JSON, so the default file name becomes `node_trace.${rotation}.pftrace` and the
108-
files can be opened in [`ui.perfetto.dev`][]. It cannot write JSON traces, and
109-
it does not support trace collection over the inspector protocol.
105+
Node.js can also be built with [Perfetto][] support, as described in
106+
[BUILDING.md][]. Such a build writes Perfetto protobuf traces instead of JSON,
107+
so the default file name becomes `node_trace.${rotation}.pftrace` and the files
108+
can be opened in [`ui.perfetto.dev`][]. It cannot write JSON traces, and it
109+
does not support trace collection over the inspector protocol.
110110

111111
To guarantee that the log file is properly generated after signal events like
112112
`SIGINT`, `SIGTERM`, or `SIGBREAK`, make sure to have the appropriate handlers
@@ -295,8 +295,7 @@ console.log(getEnabledCategories());
295295

296296
### Collect trace events data by inspector
297297

298-
The `NodeTracing` domain is not registered in builds configured with
299-
`--with-perfetto`.
298+
The `NodeTracing` domain is not registered in builds with Perfetto support.
300299

301300
```mjs
302301
import { Session } from 'node:inspector';

0 commit comments

Comments
 (0)