Documentation: conditional plugin specific configs

Wrap plugin specific configs into has_plugin checks to avoid breakage when Vagrantfile is shared and/or plugin is removed (for testing/development).
This commit is contained in:
Tuomo Tanskanen 2014-01-07 09:58:30 +02:00
parent 5342a7ce33
commit 949df52a26
3 changed files with 17 additions and 8 deletions

View file

@ -23,10 +23,12 @@ from within your `Vagrantfile`:
```ruby ```ruby
Vagrant.configure("2") do |config| Vagrant.configure("2") do |config|
config.vm.box = 'your-box' config.vm.box = 'your-box'
if Vagrant.has_plugin?("vagrant-cachier")
config.cache.auto_detect = true config.cache.auto_detect = true
# If you are using VirtualBox, you might want to enable NFS for shared folders # If you are using VirtualBox, you might want to enable NFS for shared folders
# config.cache.enable_nfs = true # config.cache.enable_nfs = true
end end
end
``` ```
For more information please read the documentation available at For more information please read the documentation available at

View file

@ -23,10 +23,12 @@ from within your `Vagrantfile`:
```ruby ```ruby
Vagrant.configure("2") do |config| Vagrant.configure("2") do |config|
config.vm.box = 'your-box' config.vm.box = 'your-box'
if Vagrant.has_plugin?("vagrant-cachier")
config.cache.auto_detect = true config.cache.auto_detect = true
# If you are using VirtualBox, you might want to enable NFS for shared folders # If you are using VirtualBox, you might want to enable NFS for shared folders
# config.cache.enable_nfs = true # config.cache.enable_nfs = true
end end
end
``` ```
For more information please check out the links on the menu above. For more information please check out the links on the menu above.

View file

@ -3,13 +3,18 @@
## Auto detect supported cache buckets ## Auto detect supported cache buckets
This is the easiest way to get started with plugin. By adding the code below to This is the easiest way to get started with plugin. By adding the code below to
your `Vagrantfile` you can enable automatic detection of supported cache _buckets_: your `Vagrantfile` you can enable automatic detection of supported cache _buckets_.
It is a good practise to wrap plugin specific configuration with `has_plugin?` checks
so the user's Vagrantfiles do not break if plugin is uninstalled or Vagrantfile shared
with people not having the plugin installed.
```ruby ```ruby
Vagrant.configure("2") do |config| Vagrant.configure("2") do |config|
# ... # ...
if Vagrant.has_plugin?("vagrant-cachier")
config.cache.auto_detect = true config.cache.auto_detect = true
end end
end
``` ```
This will make vagrant-cachier do its best to find out what is supported on the This will make vagrant-cachier do its best to find out what is supported on the