core: better synced folder plugin docs
This commit is contained in:
parent
c04fa5e54e
commit
ae4fa1a946
|
@ -3,15 +3,33 @@ module Vagrant
|
||||||
module V2
|
module V2
|
||||||
# This is the base class for a synced folder implementation.
|
# This is the base class for a synced folder implementation.
|
||||||
class SyncedFolder
|
class SyncedFolder
|
||||||
|
# This is called early when the synced folder is set to determine
|
||||||
|
# if this implementation can be used for this machine. This should
|
||||||
|
# return true or false.
|
||||||
|
#
|
||||||
|
# @return [Boolean]
|
||||||
def usable?(machine)
|
def usable?(machine)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This is called before the machine is booted, allowing the
|
||||||
|
# implementation to make any machine modifications or perhaps
|
||||||
|
# verifications.
|
||||||
|
#
|
||||||
|
# No return value.
|
||||||
def prepare(machine, folders, opts)
|
def prepare(machine, folders, opts)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This is called after the machine is booted and after networks
|
||||||
|
# are setup.
|
||||||
|
#
|
||||||
|
# No return value.
|
||||||
def enable(machine, folders, opts)
|
def enable(machine, folders, opts)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This is called after destroying the machine during a
|
||||||
|
# `vagrant destroy`.
|
||||||
|
#
|
||||||
|
# No return value.
|
||||||
def cleanup(machine)
|
def cleanup(machine)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue