diff options
| author | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2006-11-09 21:25:02 +0000 |
|---|---|---|
| committer | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2006-11-09 21:25:02 +0000 |
| commit | 10c860f4e05cfb6bb3f6836478e093026e364161 (patch) | |
| tree | 8c3860a4272619b97abf4fc47dff1b574e53f296 | |
| parent | 114cd8ac4191eab4ee0c59a19e8a3e6b4dddc3d3 (diff) | |
Slightly more doc updates
git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1846 980ebf18-57e1-0310-9a29-db15c13687c0
| -rwxr-xr-x | bin/puppetdoc | 105 | ||||
| -rw-r--r-- | lib/puppet/parser/functions.rb | 16 | ||||
| -rwxr-xr-x | lib/puppet/server/report.rb | 14 |
3 files changed, 2 insertions, 133 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc index ff4e8f4ec..51a95b8bb 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -94,101 +94,6 @@ end # Print the docs for arguments def self.configref - puts %{--- -inMenu: true -title: Configuration Reference -orderInfo: 40 ---- -# Puppet Configuration Reference - -## Specifying Configuration Parameters - -Every Puppet executable (with the exception of ``puppetdoc``) accepts all of -the arguments below, but not all of the arguments make sense for every executable. -Each argument has a section listed with it in parentheses; often, that section -will map to an executable (e.g., ``puppetd``), in which case it probably only -makes sense for that one executable. If ``puppet`` is listed as the section, -it is most likely an option that is valid for everyone. - -This will not always be the case. I have tried to be as thorough as possible -in the descriptions of the arguments, so it should be obvious whether an -argument is appropriate or not. - -These arguments can be supplied to the executables either as command-line -arugments or in the configuration file for the appropriate executable. For -instance, the command-line invocation below would set the configuration directory -to /private/puppet - - $ puppetd --confdir=/private/puppet - -Note that boolean options are turned on and off with a slightly different syntax -on the command line: - - $ puppetd --storeconfigs - - $ puppetd --no-storeconfigs - -The invocations above will enable and disable, respectively, the storage of -the client configuration. - -As mentioned above, the configuration parameters can also be stored in a -configuration file located in the configuration directory (`/etc/puppet` -by default). The file is named for the executable it is intended for, for -example `/etc/puppetd.conf` is the configuration file for `puppetd`. - -The file, which follows INI-style formatting, should contain a bracketed -heading named for the executable, followed by pairs of parameters with their -values. Here is an example of a very simple `puppetd.conf` file: - - [puppetd] - confdir = /private/puppet - storeconfigs = true - -Note that boolean parameters must be explicitly specified as `true` or -`false` as seen above. - -If you're starting out with a fresh configuration, you may wish to let -the executable generate a template configuration file for you by invoking -the executable in question with the `--genconfig` command. The executable -will print a template configuration to standard output, which can be -redirected to a file like so: - - $ puppetd --genconfig > /etc/puppet/puppetd.conf - -Note that this invocation will "clobber" (throw away) the contents of any -pre-existing `puppetd.conf` file, so make a backup of your present config -if it contains valuable information. - -Like the `--genconfig` argument, the executables also accept a `--genmanifest` -argument, which will generate a manifest that can be used to manage all of -Puppet's directories and files and prints it to standard output. This can -likewise be redirected to a file: - - $ puppetd --genmanifest > /etc/puppet/manifests/site.pp - -Puppet can also create user and group accounts for itself (one `puppet` group -and one `puppet` user) if it is invoked as `root` with the `--mkusers` argument: - - $ puppetd --mkusers - -## Signals - -The `puppetd` and `puppetmasterd` executables catch some signals for special -handling. Both daemons catch (`SIGHUP`), which forces the server to restart -tself. Predictably, interrupt and terminate (`SIGINT` and `SIGHUP`) will shut -down the server, whether it be an instance of `puppetd` or `puppetmasterd`. - -Sending the `SIGUSR1` signal to an instance of `puppetd` will cause it to -immediately begin a new configuration transaction with the server. This -signal has no effect on `puppetmasterd`. - - -## Configuration Parameter Reference - -Below is a list of all documented parameters. Any default values are in ``block type`` at the end of the description. - -} - docs = {} Puppet.config.each do |name, object| docs[name] = object @@ -218,16 +123,6 @@ end # Print the docs for types def self.typedocs - puts %{--- -inMenu: true -title: Type Reference -orderInfo: 40 ---- -# Type Reference - - - } - types = {} Puppet::Type.loadall diff --git a/lib/puppet/parser/functions.rb b/lib/puppet/parser/functions.rb index 35c51da7c..ad5f53080 100644 --- a/lib/puppet/parser/functions.rb +++ b/lib/puppet/parser/functions.rb @@ -72,21 +72,7 @@ module Functions def self.functiondocs autoloader.loadall - header = %{inMenu: true -title: Function Reference -orderInfo: 40 - -There are two types of functions in Puppet: Statements and rvalues. -Statements stand on their own and do not return arguments; they are used for -performing stand-alone work like importing. Rvalues return values and can -only be used in a statement requiring a value, such as an assignment or a case -statement. - -Here are the functions available in Puppet: - -} - - ret = header.dup + ret = "" @functions.sort { |a,b| a[0].to_s <=> b[0].to_s }.each do |name, hash| ret += "* **%s** (*%s*)" % [name, hash[:type]] diff --git a/lib/puppet/server/report.rb b/lib/puppet/server/report.rb index bbc8e7ddb..efebf1b4e 100755 --- a/lib/puppet/server/report.rb +++ b/lib/puppet/server/report.rb @@ -73,20 +73,8 @@ class Server end def self.reportdocs - docs = %{Puppet clients can report back to the server after each -transaction. This transaction report is sent as a YAML dump and includes every -log message that was generated during the transaction along with as many metrics -as Puppet knows how to collect. + docs = "" -Currently, clients default to not sending in reports; you can enable reporting -by setting the ``report`` parameter to true. - -To use a report, set the ``reports`` parameter on the server; multiple -reports must be comma-separated. - -Puppet provides multiple report handlers that will process client reports: - -} # Use this method so they all get loaded reports.sort { |a,b| a.to_s <=> b.to_s }.each do |name| mod = self.report(name) |
