plugin safe/rebuild controls

1 files changed, 15 insertions, 4 deletions

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index fc4b778db..67f1cf2ba 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -379,12 +379,13 @@ die if not, which will cause the plugin to not be offered in the configuration
 interface.
 
 The data returned is a list of `%config` options, followed by a hash
-describing the option. For example:
+describing the option. There can also be an item named "plugin", which
+describes the plugin as a whole. For example:
 
                 return
 			option_foo => {
 				type => "boolean",
-				description => "enable foo",
+				description => "enable foo?",
 				advanced => 1,
 				safe => 1,
 				rebuild => 1,
@@ -392,10 +393,15 @@ describing the option. For example:
 			option_bar => {
 				type => "string",
 				example => "hello",
-				description => "what to say",
+				description => "option bar",
 				safe => 1,
 				rebuild => 0,
 			},
+			plugin => {
+				description => "description of this plugin",
+				safe => 1,
+				rebuild => 1,
+			},
 
 * `type` can be "boolean", "string", "integer", "pagespec",
   or "internal" (used for values that are not user-visible). The type is
@@ -410,7 +416,12 @@ describing the option. For example:
 * `safe` should be false if the option should not be displayed in unsafe
   configuration methods, such as the web interface. Anything that specifies
   a command to run, a path on disk, or a regexp should be marked as unsafe.
-* `rebuild` should be true if changing the option will require a wiki rebuild.
+  If a plugin is marked as unsafe, that prevents it from being
+  enabled/disabled.
+* `rebuild` should be true if changing the option (or enabling/disabling
+  the plugin) will require a wiki rebuild, false if no rebuild is needed,
+  and undef if a rebuild could be needed in some circumstances, but is not
+  strictly required.
 
 ## Plugin interface