mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Edits per inline comments

Browse source
This commit is contained in:
Jessica Lord 2015-08-27 08:11:51 -07:00
parent 715a88026e
commit f74d7d71e6
2 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/api/content-tracing.md
View file

@ -41,8 +41,8 @@ Once all child processes have acknowledged the `getCategories` request the
Start recording on all processes. Start recording on all processes.
Recording begins immediately locally and asynchronously on child processes Recording begins immediately locally and asynchronously on child processes
as soon as they receive the EnableRecording request. Once all child processes as soon as they receive the EnableRecording request. The `callback` will be
have acknowledged the `startRecording` request the `callback` will be called. called once all child processes have acknowledged the `startRecording` request.
`categoryFilter` is a filter to control what category groups should be `categoryFilter` is a filter to control what category groups should be
traced. A filter can have an optional `-` prefix to exclude category groups traced. A filter can have an optional `-` prefix to exclude category groups
@ -66,11 +66,11 @@ list. Possible options are:
The first 3 options are trace recoding modes and hence mutually exclusive. The first 3 options are trace recoding modes and hence mutually exclusive.
If more than one trace recording modes appear in the `traceOptions` string, If more than one trace recording modes appear in the `traceOptions` string,
the last one takes precedence. If none of the trace recording modes is the last one takes precedence. If none of the trace recording modes are
specified, recording mode is `record-until-full`. specified, recording mode is `record-until-full`.
The trace option will first be reset to the default option (record_mode set to The trace option will first be reset to the default option (`record_mode` set to
`record-until-full`, enable_sampling and enable_systrace set to `false`) `record-until-full`, `enable_sampling` and `enable_systrace` set to `false`)
before options parsed from `traceOptions` are applied on it. before options parsed from `traceOptions` are applied on it.
### `tracing.stopRecording(resultFilePath, callback)` ### `tracing.stopRecording(resultFilePath, callback)`
@ -80,11 +80,11 @@ before options parsed from `traceOptions` are applied on it.
Stop recording on all processes. Stop recording on all processes.
Child processes typically are caching trace data and only rarely flush and send Child processes typically cache trace data and only rarely flush and send
trace data back to the main process. That is because it may be an expensive trace data back to the main process. This helps to minimize the runtime overhead
operation to send the trace data over IPC, and we would like to avoid runtime of tracing since sending trace data over IPC can be an expensive operation. So,
overhead of tracing. So, to end tracing, we must asynchronously ask all to end tracing, we must asynchronously ask all child processes to flush any
child processes to flush any pending trace data. pending trace data.
Once all child processes have acknowledged the `stopRecording` request, Once all child processes have acknowledged the `stopRecording` request,
`callback` will be called with a file that contains the traced data. `callback` will be called with a file that contains the traced data.
@ -123,7 +123,7 @@ Once all child processes have acknowledged the `stopMonitoring` request the
Get the current monitoring traced data. Get the current monitoring traced data.
Child processes are typically caching trace data and only rarely flush and send 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 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 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 runtime overhead from tracing. So, to end tracing, we must asynchronously ask
@ -152,5 +152,5 @@ process.
### `tracing.cancelWatchEvent()` ### `tracing.cancelWatchEvent()`
Cancel the watch event. If tracing is enabled this may race with the watch Cancel the watch event. This may lead to a race condition with the watch event
event callback. callback if tracing is enabled.

4
docs/api/crash-reporter.md
View file

@ -1,4 +1,4 @@
# crash-reporter # crashReporter
The `crash-reporter` module enables sending your app's crash reports. The `crash-reporter` module enables sending your app's crash reports.
@ -34,7 +34,7 @@ The `crash-reporter` module has the following methods:
* Only string properties are sent correctly. * Only string properties are sent correctly.
* Nested objects are not supported. * Nested objects are not supported.
Developers are required to call this method before using other `crashReporter` You are required to call this method before using other `crashReporter`
APIs. APIs.
**Note:** On OS X, Electron uses a new `crashpad` client, which is different **Note:** On OS X, Electron uses a new `crashpad` client, which is different