From owner-svn-src-head@freebsd.org  Wed Feb  1 16:15:24 2017
Return-Path: <owner-svn-src-head@freebsd.org>
Delivered-To: svn-src-head@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id DCF95CCB817;
 Wed,  1 Feb 2017 16:15:24 +0000 (UTC) (envelope-from brd@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id ACD1AF81;
 Wed,  1 Feb 2017 16:15:24 +0000 (UTC) (envelope-from brd@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id v11GFNUV060305;
 Wed, 1 Feb 2017 16:15:23 GMT (envelope-from brd@FreeBSD.org)
Received: (from brd@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id v11GFNGl060304;
 Wed, 1 Feb 2017 16:15:23 GMT (envelope-from brd@FreeBSD.org)
Message-Id: <201702011615.v11GFNGl060304@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: brd set sender to brd@FreeBSD.org
 using -f
From: Brad Davis <brd@FreeBSD.org>
Date: Wed, 1 Feb 2017 16:15:23 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
 svn-src-head@freebsd.org
Subject: svn commit: r313044 - head/release
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-src-head@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: SVN commit messages for the src tree for head/-current
 <svn-src-head.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-head/>
List-Post: <mailto:svn-src-head@freebsd.org>
List-Help: <mailto:svn-src-head-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-src-head>,
 <mailto:svn-src-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 01 Feb 2017 16:15:25 -0000

Author: brd (doc,ports committer)
Date: Wed Feb  1 16:15:23 2017
New Revision: 313044
URL: https://svnweb.freebsd.org/changeset/base/313044

Log:
  Add some comments with examples on how to build Vagrant images.
  
  Approved by:	re (gjb)

Modified:
  head/release/Makefile.vagrant

Modified: head/release/Makefile.vagrant
==============================================================================
--- head/release/Makefile.vagrant	Wed Feb  1 13:12:07 2017	(r313043)
+++ head/release/Makefile.vagrant	Wed Feb  1 16:15:23 2017	(r313044)
@@ -1,8 +1,20 @@
 #
 # $FreeBSD$
 #
+# Makefile for producing and uploading Vagrant boxes to Hashicorp Atlas
 #
-# Makefile for uploading Vagrant boxes to Hashicorp Atlas
+# Usage Example:
+#   Create a Vagrant image for VirtualBox:
+#     make vagrant-box WITH_VMIMAGES=y WITH_CLOUDWARE=y \
+#       CLOUDWARE=vagrant-virtualbox VMFORMATS=vmdk
+#
+#   To create a Vagrant image for VMWare and Upload it to Atlas:
+#     VAGRANT_KEY is your Atlas API Token
+#     VAGRANT_USERNAME is your Atlas Username
+#     env VAGRANT_KEY=foo VAGRANT_USERNAME=bar make vagrant-upload \
+#       WITH_VMIMAGES=y WITH_CLOUDWARE=y CLOUDWARE=vagrant-vmware \
+#       VMFORMATS=vmdk
+#     For more info: https://www.vagrantup.com/docs/other/atlas.html
 #
 
 VAGRANT_IMG?=		${.OBJDIR}/vagrant.vmdk