docs: correct datatype inconsistencies bool => boolean (issue #5468)

This commit is contained in:
Matthew Aynalem 2017-10-16 09:11:33 -07:00
parent 201b9a21e0
commit 3716effa75
16 changed files with 29 additions and 29 deletions

View File

@ -50,7 +50,7 @@ builder.
### Optional:
- `skip_region_validation` (bool) - The region validation can be skipped if this
- `skip_region_validation` (boolean) - The region validation can be skipped if this
value is true, the default value is false.
- `image_description` (string) - The description of the image, with a length
@ -71,12 +71,12 @@ builder.
letter or a Chinese character, and may contain numbers, `_` or `-`. It cannot
begin with `http://` or `https://`.
- `image_force_delete` (bool) - If this value is true, when the target image name
- `image_force_delete` (boolean) - If this value is true, when the target image name
is duplicated with an existing image, it will delete the existing image and
then create the target image, otherwise, the creation will fail. The default
value is false.
- `image_force_delete_snapshots` (bool) - If this value is true, when delete the
- `image_force_delete_snapshots` (boolean) - If this value is true, when delete the
duplicated existing image, the source snapshot of this image will be delete
either.
@ -116,11 +116,11 @@ builder.
- `zone_id` (string) - ID of the zone to which the disk belongs.
- `io_optimized` (bool) - I/O optimized.
- `io_optimized` (boolean) - I/O optimized.
Default value: false for Generation I instances; true for other instances.
- `force_stop_instance` (bool) - Whether to force shutdown upon device restart.
- `force_stop_instance` (boolean) - Whether to force shutdown upon device restart.
The default value is `false`.
If it is set to `false`, the system is shut down normally; if it is set to

View File

@ -289,7 +289,7 @@ each category, the available configuration keys are alphabetized.
- `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs.
This is helpful to limit the AMIs to a trusted third party, or to your own account.
- `most_recent` (bool) - Selects the newest created image when true.
- `most_recent` (boolean) - Selects the newest created image when true.
This is most useful for selecting a daily distro build.
- `sriov_support` (boolean) - Enable enhanced networking (SriovNetSupport but not ENA)

View File

@ -290,7 +290,7 @@ builder.
- `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs.
This is helpful to limit the AMIs to a trusted third party, or to your own account.
- `most_recent` (bool) - Selects the newest created image when true.
- `most_recent` (boolean) - Selects the newest created image when true.
This is most useful for selecting a daily distro build.
- `spot_price` (string) - The maximum hourly price to pay for a spot instance

View File

@ -283,7 +283,7 @@ builder.
- `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs.
This is helpful to limit the AMIs to a trusted third party, or to your own account.
- `most_recent` (bool) - Selects the newest created image when true.
- `most_recent` (boolean) - Selects the newest created image when true.
This is most useful for selecting a daily distro build.
- `spot_price` (string) - The maximum hourly price to pay for a spot instance

View File

@ -196,7 +196,7 @@ builder.
- `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs.
This is helpful to limit the AMIs to a trusted third party, or to your own account.
- `most_recent` (bool) - Selects the newest created image when true.
- `most_recent` (boolean) - Selects the newest created image when true.
This is most useful for selecting a daily distro build.
- `spot_price` (string) - The maximum hourly price to pay for a spot instance

View File

@ -288,7 +288,7 @@ builder.
- `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs.
This is helpful to limit the AMIs to a trusted third party, or to your own account.
- `most_recent` (bool) - Selects the newest created image when true.
- `most_recent` (boolean) - Selects the newest created image when true.
This is most useful for selecting a daily distro build.
- `snapshot_tags` (object of key/value strings) - Tags to apply to snapshot.

View File

@ -91,16 +91,16 @@ can be configured for this builder.
- `disk_size` (integer) - The size, in megabytes, of the hard disk to create
for the VM. By default, this is 40 GB.
- `enable_dynamic_memory` (bool) - If true enable dynamic memory for virtual machine.
- `enable_dynamic_memory` (boolean) - If true enable dynamic memory for virtual machine.
This defaults to false.
- `enable_mac_spoofing` (bool) - If true enable mac spoofing for virtual machine.
- `enable_mac_spoofing` (boolean) - If true enable mac spoofing for virtual machine.
This defaults to false.
- `enable_secure_boot` (bool) - If true enable secure boot for virtual machine.
- `enable_secure_boot` (boolean) - If true enable secure boot for virtual machine.
This defaults to false.
- `enable_virtualization_extensions` (bool) - If true enable virtualization extensions for virtual machine.
- `enable_virtualization_extensions` (boolean) - If true enable virtualization extensions for virtual machine.
This defaults to false. For nested virtualization you need to enable mac spoofing, disable dynamic memory
and have at least 4GB of RAM for virtual machine.
@ -187,7 +187,7 @@ can be configured for this builder.
If it doesn't shut down in this time, it is an error. By default, the timeout
is "5m", or five minutes.
- `skip_compaction` (bool) - If true skip compacting the hard disk for virtual machine when
- `skip_compaction` (boolean) - If true skip compacting the hard disk for virtual machine when
exporting. This defaults to false.
- `switch_name` (string) - The name of the switch to connect the virtual machine to. Be defaulting

View File

@ -96,16 +96,16 @@ can be configured for this builder.
- `cpu` (integer) - The number of cpus the virtual machine should use. If
this isn't specified, the default is 1 cpu.
- `enable_dynamic_memory` (bool) - If true enable dynamic memory for virtual
- `enable_dynamic_memory` (boolean) - If true enable dynamic memory for virtual
machine. This defaults to false.
- `enable_mac_spoofing` (bool) - If true enable mac spoofing for virtual
- `enable_mac_spoofing` (boolean) - If true enable mac spoofing for virtual
machine. This defaults to false.
- `enable_secure_boot` (bool) - If true enable secure boot for virtual
- `enable_secure_boot` (boolean) - If true enable secure boot for virtual
machine. This defaults to false.
- `enable_virtualization_extensions` (bool) - If true enable virtualization
- `enable_virtualization_extensions` (boolean) - If true enable virtualization
extensions for virtual machine. This defaults to false. For nested
virtualization you need to enable mac spoofing, disable dynamic memory and
have at least 4GB of RAM for virtual machine.
@ -208,7 +208,7 @@ can be configured for this builder.
doesn't shut down in this time, it is an error. By default, the timeout is
"5m", or five minutes.
- `skip_compaction` (bool) - If true skip compacting the hard disk for
- `skip_compaction` (boolean) - If true skip compacting the hard disk for
virtual machine when exporting. This defaults to false.
- `switch_name` (string) - The name of the switch to connect the virtual

View File

@ -114,7 +114,7 @@ builder.
User's Guide](https://www.vmware.com/pdf/VirtualDiskManager.pdf) for desktop
VMware clients. For ESXi, refer to the proper ESXi documentation.
* `disable_vnc` (bool) - Whether to create a VNC connection or not.
* `disable_vnc` (boolean) - Whether to create a VNC connection or not.
A `boot_command` cannot be used when this is `false`. Defaults to `false`.
- `floppy_files` (array of strings) - A list of files to place onto a floppy

View File

@ -71,7 +71,7 @@ builder.
five seconds and one minute 30 seconds, respectively. If this isn't
specified, the default is 10 seconds.
* `disable_vnc` (bool) - Whether to create a VNC connection or not.
* `disable_vnc` (boolean) - Whether to create a VNC connection or not.
A `boot_command` cannot be used when this is `false`. Defaults to `false`.
- `floppy_files` (array of strings) - A list of files to place onto a floppy

View File

@ -72,7 +72,7 @@ two categories: required and optional parameters.
limit of 0 to 256 characters. Leaving it blank means null, which is the
default value. It cannot begin with <http://> or <https://>.
- `image_force_delete` (bool) - If this value is true, when the target image
- `image_force_delete` (boolean) - If this value is true, when the target image
name is duplicated with an existing image, it will delete the existing image
and then create the target image, otherwise, the creation will fail. The
default value is false.

View File

@ -34,7 +34,7 @@ permissions to the GCS `paths`.
### Optional
- `keep_input_artifact` (bool) - If true, do not delete the Google Compute Engine
- `keep_input_artifact` (boolean) - If true, do not delete the Google Compute Engine
(GCE) image being exported.
## Basic Example

View File

@ -24,7 +24,7 @@ You can specify manifest more than once and write each build to its own file, or
### Optional:
- `output` (string) The manifest will be written to this file. This defaults to `packer-manifest.json`.
- `strip_path` (bool) Write only filename without the path to the manifest file. This defaults to false.
- `strip_path` (boolean) Write only filename without the path to the manifest file. This defaults to false.
### Example Configuration

View File

@ -103,7 +103,7 @@ Optional Parameters:
files. The command should read and write on stdin and stdout, respectively.
Defaults to `/usr/lib/sftp-server -e`.
- `skip_version_check` (bool) - Check if ansible is installed prior to running.
- `skip_version_check` (boolean) - Check if ansible is installed prior to running.
Set this to `true`, for example, if you're going to install ansible during
the packer run.

View File

@ -59,14 +59,14 @@ Optional parameters:
various
[configuration template variables](/docs/templates/engine.html) available.
- `prevent_sudo` (bool) - stop Converge from running with adminstrator
- `prevent_sudo` (boolean) - stop Converge from running with adminstrator
privileges via sudo
- `bootstrap_command` (string) - the command used to bootstrap Converge. This
has various
[configuration template variables](/docs/templates/engine.html) available.
- `prevent_bootstrap_sudo` (bool) - stop Converge from bootstrapping with
- `prevent_bootstrap_sudo` (boolean) - stop Converge from bootstrapping with
administrator privileges via sudo
### Module Directories

View File

@ -72,7 +72,7 @@ Optional parameters:
available variables: `Path`, which is the path to the script to run, and
`Vars`, which is the list of `environment_vars`, if configured.
- `expect_disconnect` (bool) - Defaults to `false`. Whether to error if the
- `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.