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

docs: reorder crashReporter notes to make more sense (#16825)

Browse source 
the note about reports from child processes on Windows should be next to the code snippet.

Side note: is that code even still necessary?
This commit is contained in:
Jeremy Apthorp 2019-02-08 13:26:59 -08:00 committed by Samuel Attard
parent c80c3c18dc
commit 72f3a22ecc
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -62,14 +62,14 @@ Therefore, to collect crash reports from them, use `process.crashReporter.start`
along with an additional one called `crashesDirectory` that should point to a directory to store the crash along with an additional one called `crashesDirectory` that should point to a directory to store the crash
reports temporarily. You can test this out by calling `process.crash()` to crash the child process. reports temporarily. You can test this out by calling `process.crash()` to crash the child process.
**Note:** To collect crash reports from child process in Windows, you need to add this extra code as well.
This will start the process that will monitor and send the crash reports. Replace `submitURL`, `productName`
and `crashesDirectory` with appropriate values.
**Note:** If you need send additional/updated `extra` parameters after your **Note:** If you need send additional/updated `extra` parameters after your
first call `start` you can call `addExtraParameter` on macOS or call `start` first call `start` you can call `addExtraParameter` on macOS or call `start`
again with the new/updated `extra` parameters on Linux and Windows. again with the new/updated `extra` parameters on Linux and Windows.
**Note:** To collect crash reports from child process in Windows, you need to add this extra code as well.
This will start the process that will monitor and send the crash reports. Replace `submitURL`, `productName`
and `crashesDirectory` with appropriate values.
```js ```js
const args = [ const args = [
`--reporter-url=${submitURL}`, `--reporter-url=${submitURL}`,