diff options
| author | Joey Hess <joey@kodama.kitenet.net> | 2008-07-26 21:07:15 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-07-26 21:07:15 -0400 |
| commit | 42ac4ec00959bd6162076af799023545b698bed9 (patch) | |
| tree | e66364aa8c9716d086c801e27cc21e8a2a947a96 /doc/plugins | |
| parent | c83fd4a32868d46765a88f6903dd807f18c9ae84 (diff) | |
remove default values in getsetup
They were a bit confusing, since they did not actually set the default, and
example values are sufficient.
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/write.mdwn | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 9a844ca06..686f7e518 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -376,7 +376,6 @@ describing the option. For example: return option_foo => { type => "boolean", - default => 0, description => "enable foo", safe => 1, rebuild => 1, @@ -392,8 +391,7 @@ describing the option. For example: * `type` can be "boolean", "string", "integer", "internal" (used for values that are not user-visible). The type is the type of the leaf values; the `%config` option may be an array or hash of these. -* `default` should be set to the default value of the option, if any. -* `example` can be set to an example value, which will not be used by default. +* `example` can be set to an example value. * `description` is a short description of the option. * `safe` should be false if the option should not be displayed in unsafe configuration methods, such as the web interface. Anything that specifies |