From 3139d3d2c504c37cd26914f030862764ecc2da70 Mon Sep 17 00:00:00 2001 From: Tyler Tidman Date: Sun, 19 Jul 2015 10:56:00 -0400 Subject: [PATCH] Fixes #2474: Replace use of 'int' and 'uint' in website docs with 'integer' and wrap long lines --- .../source/docs/builders/qemu.html.markdown | 2 +- .../docs/templates/communicator.html.md | 26 +++++++++++-------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/website/source/docs/builders/qemu.html.markdown b/website/source/docs/builders/qemu.html.markdown index 5516d1f2e..ce39c53ec 100644 --- a/website/source/docs/builders/qemu.html.markdown +++ b/website/source/docs/builders/qemu.html.markdown @@ -239,7 +239,7 @@ qemu-system-x86 command. The arguments are all printed for review. If it doesn't shut down in this time, it is an error. By default, the timeout is "5m", or five minutes. -* `ssh_host_port_min` and `ssh_host_port_max` (uint) - The minimum and +* `ssh_host_port_min` and `ssh_host_port_max` (integer) - The minimum and maximum port to use for the SSH port on the host machine which is forwarded to the SSH port on the guest machine. Because Packer often runs in parallel, Packer will choose a randomly available port in this range to use as the diff --git a/website/source/docs/templates/communicator.html.md b/website/source/docs/templates/communicator.html.md index 6afb9b0f1..f38815309 100644 --- a/website/source/docs/templates/communicator.html.md +++ b/website/source/docs/templates/communicator.html.md @@ -57,7 +57,7 @@ The SSH communicator has the following options: * `ssh_host` (string) - The address to SSH to. This usually is automatically configured by the builder. - * `ssh_port` (int) - The port to connect to SSH. This defaults to 22. + * `ssh_port` (integer) - The port to connect to SSH. This defaults to 22. * `ssh_username` (string) - The username to connect to SSH with. @@ -67,24 +67,27 @@ The SSH communicator has the following options: * `ssh_private_key_file` (string) - Path to a PEM encoded private key file to use to authentiate with SSH. - * `ssh_pty` (boolean) - If true, a PTY will be requested for the SSH connection. - This defaults to false. + * `ssh_pty` (boolean) - If true, a PTY will be requested for the SSH + connection. This defaults to false. * `ssh_timeout` (string) - The time to wait for SSH to become available. - Packer uses this to determine when the machine has booted so this is usually - quite long. Example value: "10m" + Packer uses this to determine when the machine has booted so this is + usually quite long. Example value: "10m" - * `ssh_handshake_attempts` (int) - The number of handshakes to attempt with - SSH once it can connect. This defaults to 10. + * `ssh_handshake_attempts` (integer) - The number of handshakes to attempt + with SSH once it can connect. This defaults to 10. - * `ssh_disable_agent` (boolean) - If true, SSH agent forwarding will be disabled. + * `ssh_disable_agent` (boolean) - If true, SSH agent forwarding will be + disabled. * `ssh_bastion_host` (string) - A bastion host to use for the actual SSH connection. - * `ssh_bastion_port` (int) - The port of the bastion host. Defaults to 22. + * `ssh_bastion_port` (integer) - The port of the bastion host. Defaults to + 22. - * `ssh_bastion_username` (string) - The username to connect to the bastion host. + * `ssh_bastion_username` (string) - The username to connect to the bastion + host. * `ssh_bastion_password` (string) - The password to use to authenticate with the bastion host. @@ -98,7 +101,8 @@ The WinRM communicator has the following options. * `winrm_host` (string) - The address for WinRM to connect to. - * `winrm_port` (int) - The WinRM port to connect to. This defaults to 5985. + * `winrm_port` (integer) - The WinRM port to connect to. This defaults to + 5985. * `winrm_username` (string) - The username to use to connect to WinRM.