From d983eb42e6c8691ed6bd14bf2e2de2f92acb6245 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 20 May 2016 13:58:48 -0700 Subject: [PATCH 1/5] Use ### for headings for consistency --- docs/api/environment-variables.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index 819af6c99ec6..d4991a44a3ab 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -19,36 +19,36 @@ on Windows console: > electron ``` -## `ELECTRON_RUN_AS_NODE` +### `ELECTRON_RUN_AS_NODE` Starts the process as a normal Node.js process. -## `ELECTRON_ENABLE_LOGGING` +### `ELECTRON_ENABLE_LOGGING` Prints Chrome's internal logging to console. -## `ELECTRON_LOG_ASAR_READS` +### `ELECTRON_LOG_ASAR_READS` When Electron reads from an ASAR file, log the read offset and file path to the system `tmpdir`. The resulting file can be provided to the ASAR module to optimize file ordering. -## `ELECTRON_ENABLE_STACK_DUMPING` +### `ELECTRON_ENABLE_STACK_DUMPING` When Electron crashed, prints the stack trace to console. This environment variable will not work if `crashReporter` is started. -## `ELECTRON_DEFAULT_ERROR_MODE` _Windows_ +### `ELECTRON_DEFAULT_ERROR_MODE` _Windows_ Shows Windows's crash dialog when Electron crashed. This environment variable will not work if `crashReporter` is started. -## `ELECTRON_NO_ATTACH_CONSOLE` _Windows_ +### `ELECTRON_NO_ATTACH_CONSOLE` _Windows_ Don't attach to current console session. -## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_ +### `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_ Don't use global menu bar on Linux. From d56c36b4a78721e3010932d857b8cce87347e092 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 20 May 2016 14:01:08 -0700 Subject: [PATCH 2/5] Minor wording updates --- docs/api/environment-variables.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index d4991a44a3ab..260c63126138 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -25,7 +25,7 @@ Starts the process as a normal Node.js process. ### `ELECTRON_ENABLE_LOGGING` -Prints Chrome's internal logging to console. +Prints Chrome's internal logging to the console. ### `ELECTRON_LOG_ASAR_READS` @@ -35,20 +35,20 @@ to optimize file ordering. ### `ELECTRON_ENABLE_STACK_DUMPING` -When Electron crashed, prints the stack trace to console. +When Electron crashes, prints the stack trace to the console. -This environment variable will not work if `crashReporter` is started. +This environment variable will not work if the `crashReporter` is started. ### `ELECTRON_DEFAULT_ERROR_MODE` _Windows_ -Shows Windows's crash dialog when Electron crashed. +Shows the Windows's crash dialog when Electron crashes. -This environment variable will not work if `crashReporter` is started. +This environment variable will not work if the `crashReporter` is started. ### `ELECTRON_NO_ATTACH_CONSOLE` _Windows_ -Don't attach to current console session. +Don't attach to the current console session. ### `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_ -Don't use global menu bar on Linux. +Don't use the global menu bar on Linux. From 588420ecd228fcef1f491e5f570df677485cfbc3 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 20 May 2016 14:02:10 -0700 Subject: [PATCH 3/5] Use active voice --- docs/api/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index 260c63126138..840d0ba93479 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -35,7 +35,7 @@ to optimize file ordering. ### `ELECTRON_ENABLE_STACK_DUMPING` -When Electron crashes, prints the stack trace to the console. +Prints the stack trace to the console when Electron crashes. This environment variable will not work if the `crashReporter` is started. From e1d9229507f7a05535902e3a51939558a7c11749 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 20 May 2016 14:03:28 -0700 Subject: [PATCH 4/5] Tweak intro sentence --- docs/api/environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index 840d0ba93479..f2de1284d1c3 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -2,8 +2,8 @@ > Control application configuration and behavior without changing code. -Some behaviors of Electron are controlled by environment variables, because they -are initialized earlier than command line and the app's code. +Certain Electron behaviors are controlled by environment variables because they +are initialized earlier than the command line flags and the app's code. Examples on POSIX shells: From f16f48aa7c6b29a84e374ff92e8ebd53b5e94fb7 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 20 May 2016 14:03:56 -0700 Subject: [PATCH 5/5] Tweak example intros --- docs/api/environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index f2de1284d1c3..a4df27504b57 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -5,14 +5,14 @@ Certain Electron behaviors are controlled by environment variables because they are initialized earlier than the command line flags and the app's code. -Examples on POSIX shells: +POSIX shell example: ```bash $ export ELECTRON_ENABLE_LOGGING=true $ electron ``` -on Windows console: +Windows console example: ```powershell > set ELECTRON_ENABLE_LOGGING=true