From 55082a514b844b1aa1324b3860264aa4b68ae85a Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Wed, 11 Dec 2013 13:46:21 -0800 Subject: [PATCH] website: document the description field --- website/source/docs/templates/introduction.html.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/source/docs/templates/introduction.html.markdown b/website/source/docs/templates/introduction.html.markdown index 8010ec922..83ca0faf2 100644 --- a/website/source/docs/templates/introduction.html.markdown +++ b/website/source/docs/templates/introduction.html.markdown @@ -20,6 +20,10 @@ A template is a JSON object that has a set of keys configuring various components of Packer. The available keys within a template are listed below. Along with each key, it is noted whether it is required or not. +* `description` (optional) is a string providing a description of what + the template does. This output is used only in the + [inspect command](/docs/command-line/inspect.html). + * `builders` (_required_) is an array of one or more objects that defines the builders that will be used to create machine images for this template, and configures each of those builders. For more information on how to define