]> sipb.mit.edu Git - ikiwiki.git/commitdiff
remove default values in getsetup
authorJoey Hess <joey@kodama.kitenet.net>
Sun, 27 Jul 2008 01:07:15 +0000 (21:07 -0400)
committerJoey Hess <joey@kodama.kitenet.net>
Sun, 27 Jul 2008 01:07:15 +0000 (21:07 -0400)
They were a bit confusing, since they did not actually set the default, and
example values are sufficient.

17 files changed:
IkiWiki/Plugin/aggregate.pm
IkiWiki/Plugin/amazon_s3.pm
IkiWiki/Plugin/attachment.pm
IkiWiki/Plugin/calendar.pm
IkiWiki/Plugin/inline.pm
IkiWiki/Plugin/mdwn.pm
IkiWiki/Plugin/mirrorlist.pm
IkiWiki/Plugin/openid.pm
IkiWiki/Plugin/passwordauth.pm
IkiWiki/Plugin/pinger.pm
IkiWiki/Plugin/prettydate.pm
IkiWiki/Plugin/recentchanges.pm
IkiWiki/Plugin/search.pm
IkiWiki/Plugin/skeleton.pm.example
IkiWiki/Plugin/tag.pm
IkiWiki/Plugin/typography.pm
doc/plugins/write.mdwn

index 0886fd753f3f09bfe35e4cc5d0c74647e97bc309..673668c0ee02cf049740144dbe442d610a7068d2 100644 (file)
@@ -42,14 +42,14 @@ sub getsetup () { #{{{
        return
                aggregateinternal => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "enable aggregation to internal pages?",
                        safe => 0, # enabling needs manual transition
                        rebuild => 0,
                },
                aggregate_webtrigger => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "allow aggregation to be triggered via the web?",
                        safe => 1,
                        rebuild => 0,
index d9279b6800d5df0ea594543f48daf10b0699c5f9..e181a84da04c6c152b74397fcf5d304a46d1344c 100644 (file)
@@ -79,7 +79,7 @@ sub getsetup () { #{{{
                },
                amazon_s3_dupindex => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "store each index file twice? (allows urls ending in \"/index.html\" and \"/\")",
                        safe => 1,
                        rebuild => 1,
index 6f707832dc88247709f555093a8272c733aff707..47e165251376ffa817b014fc041ae1a9cc9aa9d3 100644 (file)
@@ -16,7 +16,6 @@ sub getsetup () { #{{{
        return
                virus_checker => {
                        type => "string",
-                       default => "",
                        example => "clamdscan -",
                        description => "virus checker program (reads STDIN, returns nonzero if virus found)",
                        safe => 0, # executed
index dd6898c5762cdc9508079733597d6d44ea004236..6f1f9bd0729d5ccc539fc83a8bd32cb58274a2c0 100644 (file)
@@ -39,7 +39,7 @@ sub getsetup () { #{{{
        return
                archivebase => {
                        type => "string",
-                       default => "archives",
+                       example => "archives",
                        description => "base of the archives hierarchy",
                        safe => 1,
                        rebuild => 1,
index be9526df8de99de9643dfd82e0a40dda352d20e4..cdd0ab0dc2b7cf86ae3b5c7367bd24fe980d2462 100644 (file)
@@ -49,35 +49,34 @@ sub getsetup () { #{{{
        return
                rss => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "enable rss feeds by default?",
                        safe => 1,
                        rebuild => 1,
                },
                atom => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "enable atom feeds by default?",
                        safe => 1,
                        rebuild => 1,
                },
                allowrss => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "allow rss feeds to be used?",
                        safe => 1,
                        rebuild => 1,
                },
                allowatom => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "allow atom feeds to be used?",
                        safe => 1,
                        rebuild => 1,
                },
                pingurl => {
                        type => "string",
-                       default => "",
                        example => "http://rpc.technorati.com/rpc/ping",
                        description => "urls to ping (using XML-RPC) on feed update",
                        safe => 1,
index 59cb93bc41e3103ab8c5dd61658a1bac542d0b25..332325adc814134520381b088e7524b335342921 100644 (file)
@@ -15,7 +15,7 @@ sub getsetup () { #{{{
        return
                multimarkdown => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "enable multimarkdown features?",
                        safe => 1,
                        rebuild => 1,
index eb273561db4cec5769a7b623f7377bbcd8cea1d8..f7c78fdee33769584278b131955b8eac28291716 100644 (file)
@@ -14,7 +14,7 @@ sub getsetup () { #{{{
        return
                mirrorlist => {
                        type => "string",
-                       default => {},
+                       example => {},
                        description => "list of mirrors",
                        safe => 1,
                        rebuild => 1,
index bc9311d9c04aec49b1db6f269663bc52b379391b..de7f7280e91ce304e91dac1fa2165f5c4326be32 100644 (file)
@@ -25,7 +25,6 @@ sub getsetup () { #{{{
        return
                openidsignup => {
                        type => "string",
-                       default => "",
                        example => "http://myopenid.com/",
                        description => "an url where users can signup for an OpenID",
                        safe => 1,
index 7319614f7a7757e0a361b7703d7a06462ec398e2..82afeef989e517171a416749d27194a1e435b672 100644 (file)
@@ -17,14 +17,14 @@ sub getsetup () { #{{{
        return
                account_creation_password => {
                        type => "string",
-                       default => "",
+                       example => "s3cr1t",
                        description => "a password that must be entered when signing up for an account",
                        safe => 1,
                        rebuild => 0,
                },
                password_cost => {
                        type => "integer",
-                       default => 8,
+                       example => 8,
                        description => "cost of generating a password using Authen::Passphrase::BlowfishCrypt",
                        safe => 1,
                        rebuild => 0,
index 0aee17f8a582235af049ae5b5a53cc6697e9f0fe..e72833b8f45353c2fc79c4008412adf813a50e20 100644 (file)
@@ -20,7 +20,7 @@ sub getsetup () { #{{{
        return
                pinger_timeout => {
                        type => "integer",
-                       default => 15,
+                       example => 15,
                        description => "how many seconds to try pinging before timing out",
                        safe => 1,
                        rebuild => 0,
index 080317f060a6da0030dba46018f84ba31829f099..db5a94f413b567de7c73f2cb93ac90e1d9697461 100644 (file)
@@ -48,14 +48,13 @@ sub getsetup () { #{{{
        return
                prettydateformat => {
                        type => "string",
-                       default => '%X, %B %o, %Y',
+                       example => '%X, %B %o, %Y',
                        description => "format to use to display date",
                        safe => 1,
                        rebuild => 1,
                },
                timetable => {
                        type => "internal",
-                       default => undef,
                        description => "array of time descriptions",
                        safe => 1,
                        rebuild => 1,
index 6ab4f9d033a66e2ce57ab83b5a26b9a429811b91..d534d0cd96f6a92416a507b34ff3d38c1ac1b7b0 100644 (file)
@@ -18,14 +18,14 @@ sub getsetup () { #{{{
        return
                recentchangespage => {
                        type => "string",
-                       default => "recentchanges",
+                       example => "recentchanges",
                        description => "name of the recentchanges page",
                        safe => 1,
                        rebuild => 1,
                },
                recentchangesnum => {
                        type => "integer",
-                       default => 100,
+                       example => 100,
                        description => "number of changes to track",
                        safe => 1,
                        rebuild => 0,
index ff18e1faf4eccd4119dcb1e6a4128c62cec41396..c45e59c8e168df673540d2e0177d1513511a3fa8 100644 (file)
@@ -19,7 +19,6 @@ sub getsetup () { #{{{
        return
                omega_cgi => {
                        type => "string",
-                       default => "/usr/lib/cgi-bin/omega/omega",
                        description => "path to the omega cgi program",
                        safe => 0, # external program
                        rebuild => 0,
index 716ba63ddd480f1a8b69cd530cff40a739e30c8c..49c4d88f288d024cfed3dd31b62392ea0b201fb4 100644 (file)
@@ -43,7 +43,7 @@ sub getsetup () { #{{{
        return
                skeleton => {
                        type => "boolean",
-                       default => 0,
+                       example => 0,
                        description => "example option",
                        safe => 0,
                        rebuild => 0,
index d4cbb67059a2ed0cd38db658cad288341a979a4a..36b434f675c5d0303aa9bd4962bd7302e85afdd0 100644 (file)
@@ -27,7 +27,6 @@ sub getsetup () { #{{{
        return
                tagbase => {
                        type => "string",
-                       default => "",
                        example => "tag",
                        description => "parent page tags are located under",
                        safe => 1,
index 4c486d4b4ad1917c965380fde9ba6cbed66d715e..5ba14084b55f26e5f103ff0065ea72d255229189 100644 (file)
@@ -26,7 +26,7 @@ sub getsetup () { #{{{
        return
                typographyattributes => {
                        type => "string",
-                       default => "3",
+                       example => "3",
                        example => "tag",
                        description => "Text::Typography attributes value",
                        safe => 1,
index 9a844ca06526f148c8f0096b5f30b468b7bc41d0..686f7e518850febee6b47acde5951027f63c1281 100644 (file)
@@ -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