From 0a2fb8c383737473e9bf6c2bdcb018dce1f35216 Mon Sep 17 00:00:00 2001 From: Rick Hornsby Date: Tue, 3 Mar 2020 12:44:58 -0600 Subject: [PATCH 1/2] Clarify `expect_disconnect` behavior --- website/source/docs/provisioners/shell.html.md.erb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/source/docs/provisioners/shell.html.md.erb b/website/source/docs/provisioners/shell.html.md.erb index eb57a927e..06e1219db 100644 --- a/website/source/docs/provisioners/shell.html.md.erb +++ b/website/source/docs/provisioners/shell.html.md.erb @@ -65,9 +65,9 @@ The example below is fully functional. - `Vars` is the list of `environment_vars`, if configured. - `EnvVarFile` is the path to the file containing env vars, if `use_env_var_file` is true. -- `expect_disconnect` (boolean) - Defaults to `false`. Whether to error if - the server disconnects us. A disconnect might happen if you restart the ssh - server or reboot the host. + +- `expect_disconnect` (boolean) - Defaults to `false`. Allow server to disconnect from us without throwing an error. + A disconnect might happen if you restart the ssh server or reboot the host. - `inline_shebang` (string) - The [shebang](https://en.wikipedia.org/wiki/Shebang_%28Unix%29) value to use From b91c4d32cc20643e2073a25b09448e473967da5e Mon Sep 17 00:00:00 2001 From: rjhornsby Date: Tue, 3 Mar 2020 15:19:13 -0600 Subject: [PATCH 2/2] Additional clarity Co-Authored-By: Megan Marsh --- website/source/docs/provisioners/shell.html.md.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/provisioners/shell.html.md.erb b/website/source/docs/provisioners/shell.html.md.erb index 06e1219db..038b00449 100644 --- a/website/source/docs/provisioners/shell.html.md.erb +++ b/website/source/docs/provisioners/shell.html.md.erb @@ -66,7 +66,7 @@ The example below is fully functional. - `EnvVarFile` is the path to the file containing env vars, if `use_env_var_file` is true. -- `expect_disconnect` (boolean) - Defaults to `false`. Allow server to disconnect from us without throwing an error. +- `expect_disconnect` (boolean) - Defaults to `false`. When `true`, allow the server to disconnect from Packer without throwing an error. A disconnect might happen if you restart the ssh server or reboot the host. - `inline_shebang` (string) - The