From 2b0c4e6385a9f7f10b74cec5cd26852b0fd5f05c Mon Sep 17 00:00:00 2001 From: Paul McKellar Date: Mon, 19 Nov 2012 13:10:04 -0800 Subject: [PATCH] Change description of plugins to avoid self referencial definitions. e.g. 'destroy' will destroy your VM --- plugins/commands/destroy/plugin.rb | 5 ++++- plugins/commands/halt/plugin.rb | 3 ++- plugins/commands/ssh/plugin.rb | 2 +- plugins/commands/status/plugin.rb | 4 ++-- plugins/commands/suspend/plugin.rb | 3 ++- 5 files changed, 11 insertions(+), 6 deletions(-) diff --git a/plugins/commands/destroy/plugin.rb b/plugins/commands/destroy/plugin.rb index 0e657794b..6f24c93b6 100644 --- a/plugins/commands/destroy/plugin.rb +++ b/plugins/commands/destroy/plugin.rb @@ -4,7 +4,10 @@ module VagrantPlugins module CommandDestroy class Plugin < Vagrant.plugin("2") 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 require File.expand_path("../command", __FILE__) diff --git a/plugins/commands/halt/plugin.rb b/plugins/commands/halt/plugin.rb index d05a60886..8bed53830 100644 --- a/plugins/commands/halt/plugin.rb +++ b/plugins/commands/halt/plugin.rb @@ -5,7 +5,8 @@ module VagrantPlugins class Plugin < Vagrant.plugin("2") name "halt command" description <<-DESC - The `halt` command halts your virtual machine. + The `halt` command shuts your virtual machine down forcefully. + The command `up` recreates it. DESC command("halt") do diff --git a/plugins/commands/ssh/plugin.rb b/plugins/commands/ssh/plugin.rb index f9bfee9a8..78f5178a9 100644 --- a/plugins/commands/ssh/plugin.rb +++ b/plugins/commands/ssh/plugin.rb @@ -5,7 +5,7 @@ module VagrantPlugins class Plugin < Vagrant.plugin("2") name "ssh command" 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 command("ssh") do diff --git a/plugins/commands/status/plugin.rb b/plugins/commands/status/plugin.rb index b980a1a08..66f9c0dca 100644 --- a/plugins/commands/status/plugin.rb +++ b/plugins/commands/status/plugin.rb @@ -5,8 +5,8 @@ module VagrantPlugins class Plugin < Vagrant.plugin("2") name "status command" description <<-DESC - The `status` command shows the status of all your virtual machines - in this environment. + The `status` command shows what the running state (running/saved/..) + is of all your virtual machines in this environment. DESC command("status") do diff --git a/plugins/commands/suspend/plugin.rb b/plugins/commands/suspend/plugin.rb index 1aa9ee0f6..d4a64f818 100644 --- a/plugins/commands/suspend/plugin.rb +++ b/plugins/commands/suspend/plugin.rb @@ -5,7 +5,8 @@ module VagrantPlugins class Plugin < Vagrant.plugin("2") name "suspend command" 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 command("suspend") do