Better documentation and error messages for unsupported guest features

This commit is contained in:
Mitchell Hashimoto 2012-01-03 07:50:01 -08:00
parent 99d3565132
commit 09945fe4f9
2 changed files with 47 additions and 19 deletions

View File

@ -47,7 +47,9 @@ module Vagrant
#
# If when this method returns, the machine's state isn't "powered_off,"
# Vagrant will proceed to forcefully shut the machine down.
def halt; end
def halt
raise BaseError, :_key => :unsupported_halt
end
# Mounts a shared folder. This method is called by the shared
# folder action with an open SSH session (passed in as `ssh`).
@ -60,11 +62,15 @@ module Vagrant
# @param [String] name The name of the shared folder.
# @param [String] guestpath The path on the machine which the user
# wants the folder mounted.
def mount_shared_folder(ssh, name, guestpath, owner, group); end
def mount_shared_folder(ssh, name, guestpath, owner, group)
raise BaseError, :_key => :unsupported_shared_folder
end
# Mounts a shared folder via NFS. This assumes that the exports
# via the host are already done.
def mount_nfs(ip, folders); end
def mount_nfs(ip, folders)
raise BaseError, :_key => :unsupported_nfs
end
# Configures the given list of networks on the virtual machine.
#
@ -79,9 +85,14 @@ module Vagrant
# :interface => 1
# }
#
def configure_networks(networks); end
def configure_networks(networks)
raise BaseError, :_key => :unsupported_configure_networks
end
def change_host_name(name); end
# Called to change the hostname of the virtual machine.
def change_host_name(name)
raise BaseError, :_key => :unsupported_host_name
end
end
end
end

View File

@ -573,26 +573,43 @@ en:
guest:
base:
unsupported_bridged: |-
Bridged networking is very distro-specific. Vagrant has support for many
distros built-in: Debian, Ubuntu, Gentoo, and RedHat. The distro of your VM
couldn't be detected, or isn't supported for host only networking.
unsupported_configure_networks: |-
Networking features require support that is dependent on the operating
system running within the guest virtual machine. Vagrant has built-in support
for many operating systems: Debian, Ubuntu, Gentoo, and RedHat. The distro
of your VM couldn't be detected or doesn't support networking features.
Most of the time this is simply due to the fact that no one has contributed
back the SSH commands necessary to set this up. Please report a bug and this
will be fixed for your distro.
unsupported_host_only: |-
Host only networking is very distro-specific. Vagrant has support for many
distros built-in: Debian, Ubuntu, Gentoo, and RedHat. The distro of your VM
couldn't be detected, or isn't supported for host only networking.
Most of the time this is simply due to the fact that no one has contributed
back the SSH commands necessary to set this up. Please report a bug and this
will be fixed for your distro.
back the logic necessary to set this up. Please report a bug as well as the
box you're using.
unsupported_host_name: |-
Setting host name is currently only supported on Debian, Ubuntu and RedHat.
If you'd like your guest OS to be supported, please open a ticket on the
project.
unsupported_nfs: |-
Vagrant doesn't support mounting NFS shared folders for your specific
guest operating system yet, or possibly couldn't properly detect the
operating system on the VM.
Most of the time this is simply due to the fact that no one has contributed
back the logic necessary to set this up. Please report a bug as well as the
box you're using.
unsupported_halt: |-
Vagrant doesn't support graceful shutdowns for your specific
guest operating system yet, or possibly couldn't properly detect the
operating system on the VM.
Most of the time this is simply due to the fact that no one has contributed
back the logic necessary to set this up. Please report a bug as well as the
box you're using.
unsupported_shared_folder: |-
Vagrant doesn't support mounting shared folders for your specific
guest operating system yet, or possibly couldn't properly detect the
operating system on the VM.
Most of the time this is simply due to the fact that no one has contributed
back the logic necessary to set this up. Please report a bug as well as the
box you're using.
linux:
attempting_halt: "Attempting graceful shutdown of linux..."
mount_fail: "Failed to mount shared folders. `vboxsf` was not available."