diff options
author | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2007-07-09 21:32:33 +0000 |
---|---|---|
committer | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2007-07-09 21:32:33 +0000 |
commit | 8807ac2950f1eff5efd5204c180d4cfc56378163 (patch) | |
tree | c593e0d62213e6dca40bff5b81cb0c2da490d77a | |
parent | f5f894968a60a85ee197e8a6b1b29ffa3762ac2c (diff) | |
download | puppet-8807ac2950f1eff5efd5204c180d4cfc56378163.tar.gz puppet-8807ac2950f1eff5efd5204c180d4cfc56378163.tar.xz puppet-8807ac2950f1eff5efd5204c180d4cfc56378163.zip |
Changing "element" to "resource" in the documentation, which just aligns with a terminology change we made almost a year ago.
git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2665 980ebf18-57e1-0310-9a29-db15c13687c0
-rw-r--r-- | lib/puppet/metatype/metaparams.rb | 10 | ||||
-rw-r--r-- | lib/puppet/metatype/schedules.rb | 2 | ||||
-rw-r--r-- | lib/puppet/reference/type.rb | 2 | ||||
-rw-r--r-- | lib/puppet/transaction.rb | 2 | ||||
-rw-r--r-- | lib/puppet/type.rb | 2 | ||||
-rwxr-xr-x | lib/puppet/type/exec.rb | 4 | ||||
-rwxr-xr-x | lib/puppet/type/group.rb | 2 | ||||
-rw-r--r-- | lib/puppet/type/pfile.rb | 8 | ||||
-rwxr-xr-x | lib/puppet/type/schedule.rb | 30 | ||||
-rwxr-xr-x | lib/puppet/type/user.rb | 2 | ||||
-rw-r--r-- | lib/puppet/type/yumrepo.rb | 4 |
11 files changed, 34 insertions, 34 deletions
diff --git a/lib/puppet/metatype/metaparams.rb b/lib/puppet/metatype/metaparams.rb index 2d792eeb2..5ec2b6c74 100644 --- a/lib/puppet/metatype/metaparams.rb +++ b/lib/puppet/metatype/metaparams.rb @@ -206,10 +206,10 @@ class Puppet::Type end newmetaparam(:tag) do - desc "Add the specified tags to the associated element. While all elements + desc "Add the specified tags to the associated resource. While all resources are automatically tagged with as much information as possible - (e.g., each class and component containing the element), it can - be useful to add your own tags to a given element. + (e.g., each class and definition containing the resource), it can + be useful to add your own tags to a given resource. Tags are currently useful for things like applying a subset of a host's configuration:: @@ -325,7 +325,7 @@ class Puppet::Type } Note that Puppet will autorequire everything that it can, and - there are hooks in place so that it's easy for elements to add new + there are hooks in place so that it's easy for resources to add new ways to autorequire objects, so if you think Puppet could be smarter here, let us know. @@ -334,7 +334,7 @@ class Puppet::Type automatically realize that the parent directory should be created before the script is pulled down. - Currently, exec elements will autorequire their CWD (if it is + Currently, exec resources will autorequire their CWD (if it is specified) plus any fully qualified paths that appear in the command. For instance, if you had an ``exec`` command that ran the ``myscript`` mentioned above, the above code that pulls the diff --git a/lib/puppet/metatype/schedules.rb b/lib/puppet/metatype/schedules.rb index 7fef707c1..5cd242148 100644 --- a/lib/puppet/metatype/schedules.rb +++ b/lib/puppet/metatype/schedules.rb @@ -23,7 +23,7 @@ class Puppet::Type return true unless schedule = self.schedule # We use 'checked' here instead of 'synced' because otherwise we'll - # end up checking most elements most times, because they will generally + # end up checking most resources most times, because they will generally # have been synced a long time ago (e.g., a file only gets updated # once a month on the server and its schedule is daily; the last sync time # will have been a month ago, so we'd end up checking every run). diff --git a/lib/puppet/reference/type.rb b/lib/puppet/reference/type.rb index 0093a555a..b84a761cc 100644 --- a/lib/puppet/reference/type.rb +++ b/lib/puppet/reference/type.rb @@ -11,7 +11,7 @@ type = Puppet::Util::Reference.newreference :type, :doc => "All Puppet resource str = %{ Metaparameters -------------- -Metaparameters are parameters that work with any element; they are part of the +Metaparameters are parameters that work with any resource type; they are part of the Puppet framework itself rather than being part of the implementation of any given instance. Thus, any defined metaparameter can be used with any instance in your manifest, including defined components. diff --git a/lib/puppet/transaction.rb b/lib/puppet/transaction.rb index d0997d4df..1f7d40637 100644 --- a/lib/puppet/transaction.rb +++ b/lib/puppet/transaction.rb @@ -495,7 +495,7 @@ class Transaction end end - # Prepare to evaluate the elements in a transaction. + # Prepare to evaluate the resources in a transaction. def prepare prefetch() diff --git a/lib/puppet/type.rb b/lib/puppet/type.rb index e3eaf4901..a35a0b12c 100644 --- a/lib/puppet/type.rb +++ b/lib/puppet/type.rb @@ -35,7 +35,7 @@ class Type require 'puppet/metatype/schedules' require 'puppet/metatype/tags' - # Types (which map to elements in the languages) are entirely composed of + # Types (which map to resources in the languages) are entirely composed of # attribute value pairs. Generally, Puppet calls any of these things an # 'attribute', but these attributes always take one of three specific # forms: parameters, metaparams, or properties. diff --git a/lib/puppet/type/exec.rb b/lib/puppet/type/exec.rb index 13d76577a..c3ea0b755 100755 --- a/lib/puppet/type/exec.rb +++ b/lib/puppet/type/exec.rb @@ -48,7 +48,7 @@ module Puppet to native Puppet types as quickly as possible. If you find that you are doing a lot of work with ``exec``, please at least notify us at Reductive Labs what you are doing, and hopefully we can work with - you to get a native element type for the work you are doing." + you to get a native resource type for the work you are doing." require 'open3' @@ -196,7 +196,7 @@ module Puppet newparam(:logoutput) do desc "Whether to log output. Defaults to logging output at the - loglevel for the ``exec`` element. Values are **true**, *false*, + loglevel for the ``exec`` resource. Values are **true**, *false*, and any legal log level." values = [:true, :false] diff --git a/lib/puppet/type/group.rb b/lib/puppet/type/group.rb index e8e2047e5..e0291136a 100755 --- a/lib/puppet/type/group.rb +++ b/lib/puppet/type/group.rb @@ -12,7 +12,7 @@ require 'facter' module Puppet newtype(:group) do @doc = "Manage groups. This type can only create groups. Group - membership must be managed on individual users. This element type + membership must be managed on individual users. This resource type uses the prescribed native tools for creating groups and generally uses POSIX APIs for retrieving information about them. It does not directly modify ``/etc/group`` or anything. diff --git a/lib/puppet/type/pfile.rb b/lib/puppet/type/pfile.rb index 402ca00e8..5eb81c3e6 100644 --- a/lib/puppet/type/pfile.rb +++ b/lib/puppet/type/pfile.rb @@ -11,13 +11,13 @@ module Puppet @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`` element will be used less and less to - manage content, and instead native elements will be used to do so. + 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 - location, rather than using native elements, please contact + location, rather than using native resources, please contact Reductive Labs and we can hopefully work with you to develop a - native element to support what you are doing." + native resource to support what you are doing." newparam(:path) do desc "The path to the file to manage. Must be fully qualified." diff --git a/lib/puppet/type/schedule.rb b/lib/puppet/type/schedule.rb index 2e3c126e4..4b39f7b07 100755 --- a/lib/puppet/type/schedule.rb +++ b/lib/puppet/type/schedule.rb @@ -2,20 +2,20 @@ module Puppet newtype(:schedule) do @doc = "Defined schedules for Puppet. The important thing to understand about how schedules are currently implemented in Puppet is that they - can only be used to stop an element from being applied, they never + can only be used to stop a resource from being applied, they never guarantee that it is applied. Every time Puppet applies its configuration, it will collect the - list of elements whose schedule does not eliminate them from + list of resources whose schedule does not eliminate them from running right then, but there is currently no system in place to - guarantee that a given element runs at a given time. If you + guarantee that a given resource runs at a given time. If you specify a very restrictive schedule and Puppet happens to run at a - time within that schedule, then the elements will get applied; + time within that schedule, then the resources will get applied; otherwise, that work may never get done. Thus, it behooves you to use wider scheduling (e.g., over a couple of hours) combined with periods and repetitions. For instance, if you - wanted to restrict certain elements to only running once, between + wanted to restrict certain resources to only running once, between the hours of two and 4 AM, then you would use this schedule:: schedule { maint: @@ -25,7 +25,7 @@ module Puppet } With this schedule, the first time that Puppet runs between 2 and 4 AM, - all elements with this schedule will get applied, but they won't + all resources with this schedule will get applied, but they won't get applied again between 2 and 4 because they will have already run once that day, and they won't get applied outside that schedule because they will be outside the scheduled range. @@ -40,7 +40,7 @@ module Puppet repeat => 2 } - This will cause elements to be applied every 30 minutes by default. + This will cause resources to be applied every 30 minutes by default. " newparam(:name) do @@ -61,7 +61,7 @@ module Puppet end newparam(:range) do - desc "The earliest and latest that an element can be applied. This + desc "The earliest and latest that a resource can be applied. This is always a range within a 24 hour period, and hours must be specified in numbers between 0 and 23, inclusive. Minutes and seconds can be provided, using the normal colon as a separator. @@ -71,7 +71,7 @@ module Puppet range => \"1:30 - 4:30\" } - This is mostly useful for restricting certain elements to being + This is mostly useful for restricting certain resources to being applied in maintenance windows or during off-peak hours." # This is lame; properties all use arrays as values, but parameters don't. @@ -197,19 +197,19 @@ module Puppet end newparam(:period) do - desc "The period of repetition for an element. Choose from among + desc "The period of repetition for a resource. Choose from among a fixed list of *hourly*, *daily*, *weekly*, and *monthly*. - The default is for an element to get applied every time that + The default is for a resource to get applied every time that Puppet runs, whatever that period is. - Note that the period defines how often a given element will get + Note that the period defines how often a given resource will get applied but not when; if you would like to restrict the hours - that a given element can be applied (e.g., only at night during + that a given resource can be applied (e.g., only at night during a maintenance window) then use the ``range`` attribute. If the provided periods are not sufficient, you can provide a value to the *repeat* attribute, which will cause Puppet to - schedule the affected elements evenly in the period the + schedule the affected resources evenly in the period the specified number of times. Take this schedule:: schedule { veryoften: @@ -217,7 +217,7 @@ module Puppet repeat => 6 } - This can cause Puppet to apply that element up to every 10 minutes. + This can cause Puppet to apply that resource up to every 10 minutes. At the moment, Puppet cannot guarantee that level of repetition; that is, it can run up to every 10 minutes, but diff --git a/lib/puppet/type/user.rb b/lib/puppet/type/user.rb index 04fe4ec48..80b1ddf02 100755 --- a/lib/puppet/type/user.rb +++ b/lib/puppet/type/user.rb @@ -7,7 +7,7 @@ module Puppet users, so it is lacking some features useful for managing normal users. - This element type uses the prescribed native tools for creating + This resource type uses the prescribed native tools for creating groups and generally uses POSIX APIs for retrieving information about them. It does not directly modify /etc/passwd or anything." diff --git a/lib/puppet/type/yumrepo.rb b/lib/puppet/type/yumrepo.rb index 5efb3a307..acb3b9b83 100644 --- a/lib/puppet/type/yumrepo.rb +++ b/lib/puppet/type/yumrepo.rb @@ -188,7 +188,7 @@ module Puppet super end - # Return the Puppet::Util::IniConfig::Section for this yumrepo element + # Return the Puppet::Util::IniConfig::Section for this yumrepo resource def section self.class.section(self[:name]) end @@ -217,7 +217,7 @@ module Puppet return changes end - # Store modifications to this yumrepo element back to disk + # Store modifications to this yumrepo resource back to disk def store self.class.store end |