Skip to content

Commit

Permalink
remove API documentation from .pp files
Browse files Browse the repository at this point in the history
Refer to the README for all parameter documentation.
  • Loading branch information
Joshua Hoblitt committed May 20, 2014
1 parent e80f45a commit 9f785e0
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 34 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ class { '::mdadm':

##### `force_service`

`Bool` defaults to 'false'
`Bool` defaults to `false`

By default, the `mdadm` class will not attempt to start the `mdmonitor` service
unless the `$::mdadm_arrays` fact lists `md` arrays. If this parameter is set to `true` the class will always attempt to start the `mdmonitor` service.

##### `service_ensure`

Expand Down
27 changes: 2 additions & 25 deletions manifests/init.pp
Original file line number Diff line number Diff line change
@@ -1,30 +1,7 @@
# == Class: mdadm
#
# simple template
#
# === Parameters
#
# All parameteres are optional.
#
# [*config_options*]
# Hash. defaults to '{}'
#
# [*force_service*]
# Bool. defaults to 'false'
#
# [*service_ensure*]
# String. defaults to 'running'
# Valid strings are: 'running', 'stopped'
#
# [*service_enable*]
# Bool. defaults to 'true'
#
# [*raid_check_options*]
# Hash. defaults to '{}'
#
# === Examples
#
# include mdadm
# Please refer to https://github.com/jhoblitt/puppet-mdadm#usage for parameter
# documentation.
#
class mdadm(
$config_options = {},
Expand Down
8 changes: 0 additions & 8 deletions manifests/params.pp
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@
#
# This class should be considered private.
#
# === Authors
#
# Joshua Hoblitt <jhoblitt@cpan.org>
#
# === Copyright
#
# Copyright (C) 2013 Joshua Hoblitt
#
class mdadm::params {
case $::osfamily {
'redhat': {
Expand Down

0 comments on commit 9f785e0

Please sign in to comment.