From 66faf737992b118ee12dcdeab7f47ae19130a673 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Wed, 12 Jun 2013 16:07:52 -0700 Subject: [PATCH] website: update new buidler interface --- website/source/docs/extend/builder.html.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/source/docs/extend/builder.html.markdown b/website/source/docs/extend/builder.html.markdown index 2c574f769..25e5ea6cf 100644 --- a/website/source/docs/extend/builder.html.markdown +++ b/website/source/docs/extend/builder.html.markdown @@ -38,7 +38,7 @@ type Builder interface { // Run is where the actual build should take place. It takes a Ui to // send messages to the user, Hook to execute hooks, and Cache in order // to save files across runs. - Run(Ui, Hook, Cache) Artifact + Run(Ui, Hook, Cache) (Artifact, error) // Cancel cancels a possibly running Builder. This should block until // the builder actually cancels and cleans up after itself. @@ -87,7 +87,9 @@ how the built-in builders are all implemented. Finally, as a result of `Run`, an implementation of `packer.Artifact` should be returned. More details on creating a `packer.Artifact` are covered in the -artifact section below. +artifact section below. If something goes wrong during the build, an error +can be returned, as well. Note that it is perfectly fine to produce no artifact +and no error, although this is rare. ### The "Cancel" Method