[Pkg-puppet-devel] [SCM] Puppet packaging for Debian branch, upstream, updated. 2.6.1rc1-141-gcdb2b90
Markus Roberts
Markus at reality.com
Mon Aug 16 12:49:03 UTC 2010
The following commit has been merged in the upstream branch:
commit 79e0a2e5c9e2f654c0f7ed37e1bf3342a54e4525
Author: Jes Fraser <jes at gadget.geek.nz>
Date: Wed Aug 11 17:04:28 2010 +1200
Reformatting documentation from RST to MarkDown (#4509)
Signed-off-by: Jes Fraser <jes at gadget.geek.nz>
diff --git a/lib/puppet/type/cron.rb b/lib/puppet/type/cron.rb
index b3f5e60..ebbef72 100755
--- a/lib/puppet/type/cron.rb
+++ b/lib/puppet/type/cron.rb
@@ -15,32 +15,32 @@ Puppet::Type.newtype(:cron) do
association is made and synced to disk, you can then manage the job
normally (e.g., change the schedule of the job).
- Example::
-
- cron { logrotate:
- command => \"/usr/sbin/logrotate\",
- user => root,
- hour => 2,
- minute => 0
- }
-
- Note that all cron values can be specified as an array of values::
-
- cron { logrotate:
- command => \"/usr/sbin/logrotate\",
- user => root,
- hour => [2, 4]
- }
-
- Or using ranges, or the step syntax ``*/2`` (although there's no guarantee that
- your ``cron`` daemon supports it)::
-
- cron { logrotate:
- command => \"/usr/sbin/logrotate\",
- user => root,
- hour => ['2-4'],
- minute => '*/10'
- }
+ Example
+
+ cron { logrotate:
+ command => \"/usr/sbin/logrotate\",
+ user => root,
+ hour => 2,
+ minute => 0
+ }
+
+ Note that all cron values can be specified as an array of values
+
+ cron { logrotate:
+ command => \"/usr/sbin/logrotate\",
+ user => root,
+ hour => [2, 4]
+ }
+
+ Or using ranges, or the step syntax `*/2` (although there's no guarantee that
+ your `cron` daemon supports it)
+
+ cron { logrotate:
+ command => \"/usr/sbin/logrotate\",
+ user => root,
+ hour => ['2-4'],
+ minute => '*/10'
+ }
"
ensurable
@@ -206,7 +206,7 @@ Puppet::Type.newtype(:cron) do
profile is not sourced when the command is run, so if the
user's environment is desired it should be sourced manually.
- All cron parameters support ``absent`` as a value; this will
+ All cron parameters support `absent` as a value; this will
remove any existing values for that field."
def retrieve
@@ -293,7 +293,7 @@ Puppet::Type.newtype(:cron) do
but will not associate them with a specific job.
Settings should be specified exactly as they should appear in
- the crontab, e.g., ``PATH=/bin:/usr/bin:/usr/sbin``."
+ the crontab, e.g., `PATH=/bin:/usr/bin:/usr/sbin`."
validate do |value|
unless value =~ /^\s*(\w+)\s*=\s*(.*)\s*$/ or value == :absent or value == "absent"
diff --git a/lib/puppet/type/file.rb b/lib/puppet/type/file.rb
index 71f2756..f35a264 100644
--- a/lib/puppet/type/file.rb
+++ b/lib/puppet/type/file.rb
@@ -16,7 +16,7 @@ Puppet::Type.newtype(:file) do
@doc = "Manages local files, including setting ownership and
permissions, creation of both files and directories, and
retrieving entire files from remote servers. As Puppet matures, it
- expected that the ``file`` resource will be used less and less to
+ expected that the `file` resource will be used less and less to
manage content, and instead native resources will be used to do so.
If you find that you are often copying files in from a central
@@ -61,33 +61,33 @@ Puppet::Type.newtype(:file) do
newparam(:backup) do
desc "Whether files should be backed up before
being replaced. The preferred method of backing files up is via
- a ``filebucket``, which stores files by their MD5 sums and allows
+ a `filebucket`, which stores files by their MD5 sums and allows
easy retrieval without littering directories with backups. You
can specify a local filebucket or a network-accessible
- server-based filebucket by setting ``backup => bucket-name``.
- Alternatively, if you specify any value that begins with a ``.``
- (e.g., ``.puppet-bak``), then Puppet will use copy the file in
+ server-based filebucket by setting `backup => bucket-name`.
+ Alternatively, if you specify any value that begins with a `.`
+ (e.g., `.puppet-bak`), then Puppet will use copy the file in
the same directory with that value as the extension of the
- backup. Setting ``backup => false`` disables all backups of the
+ backup. Setting `backup => false` disables all backups of the
file in question.
- Puppet automatically creates a local filebucket named ``puppet`` and
+ Puppet automatically creates a local filebucket named `puppet` and
defaults to backing up there. To use a server-based filebucket,
- you must specify one in your configuration::
+ you must specify one in your configuration
- filebucket { main:
- server => puppet
- }
+ filebucket { main:
+ server => puppet
+ }
- The ``puppet master`` daemon creates a filebucket by default,
+ The `puppet master` daemon creates a filebucket by default,
so you can usually back up to your main server with this
configuration. Once you've described the bucket in your
- configuration, you can use it in any file::
+ configuration, you can use it in any file
- file { \"/my/file\":
- source => \"/path/in/nfs/or/something\",
- backup => main
- }
+ file { \"/my/file\":
+ source => \"/path/in/nfs/or/something\",
+ backup => main
+ }
This will back the file up to the central server.
@@ -192,9 +192,9 @@ Puppet::Type.newtype(:file) do
newparam(:ignore) do
desc "A parameter which omits action on files matching
specified patterns during recursion. Uses Ruby's builtin globbing
- engine, so shell metacharacters are fully supported, e.g. ``[a-z]*``.
+ engine, so shell metacharacters are fully supported, e.g. `[a-z]*`.
Matches that would descend into the directory structure are ignored,
- e.g., ``*/*``."
+ e.g., `*/*`."
validate do |value|
unless value.is_a?(Array) or value.is_a?(String) or value == false
@@ -205,10 +205,10 @@ Puppet::Type.newtype(:file) do
newparam(:links) do
desc "How to handle links during file actions. During file copying,
- ``follow`` will copy the target file instead of the link, ``manage``
- will copy the link itself, and ``ignore`` will just pass it by.
- When not copying, ``manage`` and ``ignore`` behave equivalently
- (because you cannot really ignore links entirely during local recursion), and ``follow`` will manage the file to which the
+ `follow` will copy the target file instead of the link, `manage`
+ will copy the link itself, and `ignore` will just pass it by.
+ When not copying, `manage` and `ignore` behave equivalently
+ (because you cannot really ignore links entirely during local recursion), and `follow` will manage the file to which the
link points."
newvalues(:follow, :manage)
@@ -223,7 +223,7 @@ Puppet::Type.newtype(:file) do
files unless you really know what you are doing. This option only
makes sense when recursively managing directories.
- Note that when using ``purge`` with ``source``, Puppet will purge any files
+ Note that when using `purge` with `source`, Puppet will purge any files
that are not on the remote system."
defaultto :false
@@ -234,7 +234,7 @@ Puppet::Type.newtype(:file) do
newparam(:sourceselect) do
desc "Whether to copy all valid sources, or just the first one. This parameter
is only used in recursive copies; by default, the first valid source is the
- only one used as a recursive source, but if this parameter is set to ``all``,
+ only one used as a recursive source, but if this parameter is set to `all`,
then all valid sources will have all of their contents copied to the local host,
and for sources that have the same file, the source earlier in the list will
be used."
diff --git a/lib/puppet/type/group.rb b/lib/puppet/type/group.rb
index 9f26d22..19753d1 100755
--- a/lib/puppet/type/group.rb
+++ b/lib/puppet/type/group.rb
@@ -89,7 +89,7 @@ module Puppet
newparam(:allowdupe, :boolean => true) do
desc "Whether to allow duplicate GIDs. This option does not work on
- FreeBSD (contract to the ``pw`` man page)."
+ FreeBSD (contract to the `pw` man page)."
newvalues(:true, :false)
diff --git a/lib/puppet/type/host.rb b/lib/puppet/type/host.rb
index 929542d..7169d12 100755
--- a/lib/puppet/type/host.rb
+++ b/lib/puppet/type/host.rb
@@ -94,7 +94,7 @@ module Puppet
end
@doc = "Installs and manages host entries. For most systems, these
- entries will just be in ``/etc/hosts``, but some systems (notably OS X)
+ entries will just be in `/etc/hosts`, but some systems (notably OS X)
will have different solutions."
end
end
diff --git a/lib/puppet/type/mount.rb b/lib/puppet/type/mount.rb
index 6ee5dd1..78bb500 100755
--- a/lib/puppet/type/mount.rb
+++ b/lib/puppet/type/mount.rb
@@ -5,8 +5,8 @@ module Puppet
information into the mount table. The actual behavior depends
on the value of the 'ensure' parameter.
- Note that if a ``mount`` receives an event from another resource,
- it will try to remount the filesystems if ``ensure`` is set to ``mounted``."
+ Note that if a `mount` receives an event from another resource,
+ it will try to remount the filesystems if `ensure` is set to `mounted`."
feature :refreshable, "The provider can remount the filesystem.",
:methods => [:remount]
@@ -15,10 +15,10 @@ module Puppet
# call code when sync is called.
newproperty(:ensure) do
desc "Control what to do with this mount. Set this attribute to
- ``umounted`` to make sure the filesystem is in the filesystem table
- but not mounted (if the filesystem is currently mounted, it will be unmounted). Set it to ``absent`` to unmount (if necessary) and remove
- the filesystem from the fstab. Set to ``mounted`` to add it to the
- fstab and mount it. Set to ``present`` to add to fstab but not change
+ `umounted` to make sure the filesystem is in the filesystem table
+ but not mounted (if the filesystem is currently mounted, it will be unmounted). Set it to `absent` to unmount (if necessary) and remove
+ the filesystem from the fstab. Set to `mounted` to add it to the
+ fstab and mount it. Set to `present` to add to fstab but not change
mount/unmount status"
newvalue(:defined) do
@@ -149,7 +149,7 @@ module Puppet
newproperty(:dump) do
desc "Whether to dump the mount. Not all platform support this.
- Valid values are ``1`` or ``0``. or ``2`` on FreeBSD, Default is ``0``."
+ Valid values are `1` or `0`. or `2` on FreeBSD, Default is `0`."
if Facter["operatingsystem"].value == "FreeBSD"
newvalue(%r{(0|1|2)})
@@ -183,7 +183,7 @@ module Puppet
end
newparam(:path) do
- desc "The deprecated name for the mount point. Please use ``name`` now."
+ desc "The deprecated name for the mount point. Please use `name` now."
def value=(value)
warning "'path' is deprecated for mounts. Please use 'name'."
@@ -193,7 +193,7 @@ module Puppet
end
newparam(:remounts) do
- desc "Whether the mount can be remounted ``mount -o remount``. If
+ desc "Whether the mount can be remounted `mount -o remount`. If
this is false, then the filesystem will be unmounted and remounted
manually, which is prone to failure."
--
Puppet packaging for Debian
More information about the Pkg-puppet-devel
mailing list