website: document inspect machine-readable types

This commit is contained in:
Mitchell Hashimoto 2013-08-13 21:34:44 -04:00
parent ae3fdaea9b
commit d1ae7b2fdc
2 changed files with 57 additions and 0 deletions

View File

@ -0,0 +1,56 @@
---
layout: "docs_machine_readable"
page_title: "Command: inspect - Machine-Readable Reference"
---
# Inspect Command Types
These are the machine-readable types that exist as part of the output
of `packer inspect`.
<dl>
<dt>template-variable (2)</dt>
<dd>
<p>
A <a href="/docs/templates/user-variables.html">user variable</a>
defined within the template.
</p>
<p>
<strong>Data 1: name</strong> - Name of the variable.
</p>
<p>
<strong>Data 2: default</strong> - The default value of the
variable.
</p>
</dd>
<dt>template-builder (2)</dt>
<dd>
<p>
A builder defined within the template
</p>
<p>
<strong>Data 1: name</strong> - The name of the builder.
</p>
<p>
<strong>Data 2: type</strong> - The type of the builder. This will
generally be the same as the name unless you explicitly override
the name.
</p>
</dd>
<dt>template-provisioner (1)</dt>
<dd>
<p>
A provisioner defined within the template. Multiple of these may
exist. If so, they are outputted in the order they would run.
</p>
<p>
<strong>Data 1: name</strong> - The name/type of the provisioner.
</p>
</dd>
</dl>

View File

@ -7,6 +7,7 @@
<li><a href="/docs/index.html">&laquo; Back to Docs</a></li>
<li><a href="/docs/machine-readable/general.html">General Types</a></li>
<li><a href="/docs/machine-readable/command-build.html">Command: build</a></li>
<li><a href="/docs/machine-readable/command-inspect.html">Command: inspect</a></li>
<li><a href="/docs/machine-readable/command-version.html">Command: version</a></li>
</ul>
<% end %>