From b0b81da72e327c1e1122c919943005cd07cddb63 Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Tue, 29 Jan 2019 14:56:17 -0800 Subject: [PATCH] docs: remove nonexistent contentTracing methods --- docs/api/content-tracing.md | 42 ------------------------------------- docs/api/promisification.md | 3 --- 2 files changed, 45 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index e324188195300..6d1729689b02b 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -81,48 +81,6 @@ Trace data will be written into `resultFilePath` if it is not empty or into a temporary file. The actual file path will be passed to `callback` if it's not `null`. -### `contentTracing.startMonitoring(options, callback)` - -* `options` Object - * `categoryFilter` String - * `traceOptions` String -* `callback` Function - -Start monitoring on all processes. - -Monitoring begins immediately locally and asynchronously on child processes as -soon as they receive the `startMonitoring` request. - -Once all child processes have acknowledged the `startMonitoring` request the -`callback` will be called. - -### `contentTracing.stopMonitoring(callback)` - -* `callback` Function - -Stop monitoring on all processes. - -Once all child processes have acknowledged the `stopMonitoring` request the -`callback` is called. - -### `contentTracing.captureMonitoringSnapshot(resultFilePath, callback)` - -* `resultFilePath` String -* `callback` Function - * `resultFilePath` String - -Get the current monitoring traced data. - -Child processes typically cache trace data and only rarely flush and send -trace data back to the main process. This is because it may be an expensive -operation to send the trace data over IPC and we would like to avoid unneeded -runtime overhead from tracing. So, to end tracing, we must asynchronously ask -all child processes to flush any pending trace data. - -Once all child processes have acknowledged the `captureMonitoringSnapshot` -request the `callback` will be called with a file that contains the traced data. - - ### `contentTracing.getTraceBufferUsage(callback)` * `callback` Function diff --git a/docs/api/promisification.md b/docs/api/promisification.md index 90648b7d6f8e3..1e79b55eb62de 100644 --- a/docs/api/promisification.md +++ b/docs/api/promisification.md @@ -14,9 +14,6 @@ When a majority of affected functions are migrated, this flag will be enabled by - [contentTracing.getCategories(callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#getCategories) - [contentTracing.startRecording(options, callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#startRecording) - [contentTracing.stopRecording(resultFilePath, callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#stopRecording) -- [contentTracing.startMonitoring(options, callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#startMonitoring) -- [contentTracing.stopMonitoring(callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#stopMonitoring) -- [contentTracing.captureMonitoringSnapshot(resultFilePath, callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#captureMonitoringSnapshot) - [contentTracing.getTraceBufferUsage(callback)](https://github.com/electron/electron/blob/master/docs/api/content-tracing.md#getTraceBufferUsage) - [cookies.get(filter, callback)](https://github.com/electron/electron/blob/master/docs/api/cookies.md#get) - [cookies.set(details, callback)](https://github.com/electron/electron/blob/master/docs/api/cookies.md#set)