Add notes on --verbose and --rebuild

[ikiwiki-bootstrap] / ikiwiki.setup

diff --git a/ikiwiki.setup b/ikiwiki.setup
index 2e417179b02317a21ddde985f9ab1bf2935744e0..8ef49cf6d83fdc1a2e6d97d6ced9e67343d2997b 100644 (file)
--- a/ikiwiki.setup
+++ b/ikiwiki.setup
@@ -50,7 +50,17 @@ use IkiWiki::Setup::Standard {
        # Everything else can be customised on an as-needed basis
        srcdir => "$checkout/src",
        templatedir => "$checkout/templates",
-       underlaydir => "$checkout/underlay",
+
+       # There's not really much point to having an underlay come
+       # from the same place as the rest of the source like this:
+       #
+       #       underlaydir => "$checkout/underlay",
+       #
+       # since you might as well put such content in src/ instead of
+       # in underlay. I suppose if you have some files common to
+       # several separate wiki instances then the underlay might
+       # still be useful. But for now, we'll just leave it off.
+       underlaydir = "/dev/null",
 
        # Git stuff.
        rcs => "git",
@@ -95,7 +105,12 @@ use IkiWiki::Setup::Standard {
        # Only send cookies over SSL connections.
        #sslcookie => 1,
        # Logging settings:
-       verbose => 0,
+
+       # It's stupid to set verbose to 0 here since it's the default
+       # anyway, and it has the side effect of making --verbose on
+       # the command-line not work.
+       # verbose => 0,
+
        syslog => 0,
        # To link to user pages in a subdirectory of the wiki.
        #userdir => "users",