Change description of plugins to avoid self referencial definitions. e.g. 'destroy' will destroy your VM

This commit is contained in:
Paul McKellar 2012-11-19 13:10:04 -08:00
parent b416665fd7
commit 2b0c4e6385
5 changed files with 11 additions and 6 deletions

View File

@ -4,7 +4,10 @@ module VagrantPlugins
module CommandDestroy module CommandDestroy
class Plugin < Vagrant.plugin("2") class Plugin < Vagrant.plugin("2")
name "destroy command" name "destroy command"
description "The `destroy` command destroys your virtual machines." description <<-DESC
The `destroy` command deletes and removes the files and record of your virtual machines.
All data is lost and a new VM will have to be created using `up`
DESC
command("destroy") do command("destroy") do
require File.expand_path("../command", __FILE__) require File.expand_path("../command", __FILE__)

View File

@ -5,7 +5,8 @@ module VagrantPlugins
class Plugin < Vagrant.plugin("2") class Plugin < Vagrant.plugin("2")
name "halt command" name "halt command"
description <<-DESC description <<-DESC
The `halt` command halts your virtual machine. The `halt` command shuts your virtual machine down forcefully.
The command `up` recreates it.
DESC DESC
command("halt") do command("halt") do

View File

@ -5,7 +5,7 @@ module VagrantPlugins
class Plugin < Vagrant.plugin("2") class Plugin < Vagrant.plugin("2")
name "ssh command" name "ssh command"
description <<-DESC description <<-DESC
The `ssh` command provides SSH access to the virtual machine. The `ssh` command allows you to SSH in to your running virtual machine.
DESC DESC
command("ssh") do command("ssh") do

View File

@ -5,8 +5,8 @@ module VagrantPlugins
class Plugin < Vagrant.plugin("2") class Plugin < Vagrant.plugin("2")
name "status command" name "status command"
description <<-DESC description <<-DESC
The `status` command shows the status of all your virtual machines The `status` command shows what the running state (running/saved/..)
in this environment. is of all your virtual machines in this environment.
DESC DESC
command("status") do command("status") do

View File

@ -5,7 +5,8 @@ module VagrantPlugins
class Plugin < Vagrant.plugin("2") class Plugin < Vagrant.plugin("2")
name "suspend command" name "suspend command"
description <<-DESC description <<-DESC
The `suspend` command suspends a running virtual machine. The `suspend` command suspends execution and puts it to sleep.
The command `resume` returns it to running status.
DESC DESC
command("suspend") do command("suspend") do