svn commit: r313044 - head/release

[Brad Davis]

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