apt::force: Added 2 parameters for automatic configuration file handling; fixes ...

[puppet-modules/puppetlabs-apt.git] / README.md

diff --git a/README.md b/README.md
index 7991404290aa311278899f6fa154c40e5cc84bfb..c7938a6a880879e875e204ab72f8fa8bb365b90e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -71,13 +71,21 @@ Installs the build depends of a specified package.
 ### apt::force
 
 Forces a package to be installed from a specific release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
+The cfg_files parameter controls wether newer or older configuration files should be used or only unchanged configuration files should be updated. Cfg_missing forces the provider to install all missing configuration files. Both are optional.
 
     apt::force { 'glusterfs-server':
-      release => 'unstable',
-      version => '3.0.3',
-      require => Apt::Source['debian_unstable'],
+      release     => 'unstable',
+      version     => '3.0.3',
+      cfg_files   => 'unchanged',
+      cfg_missing => true,
+      require     => Apt::Source['debian_unstable'],
     }
 
+You can additionally set the following attributes:
+
+ * `cfg_files`: "new", "old", "unchanged" or "none" (default). "new" will overwrite all existing configuration files with newer ones, "old" will force usage of all old files and "unchanged" only updates unchanged config files whereas setting "none" will don't do anything but providing backward-compatability with existing puppet manifests.
+ * `cfg_missing`: "true" or "false". Setting cfg_missing to false will provide backward compatability whereas setting true will add an aptitude/apt-get parameter which checks and installs missing configuration files for the selected package.
+
 ### apt_key
 
 A native Puppet type and provider for managing GPG keys for APT is provided by this module.