X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=ikiwiki.setup;h=c0cc708ffce61fcc9897ee98cecfc21c70b23e51;hb=8718fedf9ef5c5da0f3628c92b0f33d94d07a424;hp=2e417179b02317a21ddde985f9ab1bf2935744e0;hpb=edb8489396cd121863350e429eb2679d7bef3c9d;p=ikiwiki-bootstrap

diff --git a/ikiwiki.setup b/ikiwiki.setup
index 2e41717..c0cc708 100644
--- a/ikiwiki.setup
+++ b/ikiwiki.setup
@@ -12,7 +12,7 @@
 # but this clone is owned by ikiwiki so its working-copy content
 # should never be edited manually, nor should anybody clone from or
 # push to this repository. To make this quite clear, I suggest hiding
-# the checkout inside the repository as show below.
+# the checkout inside the repository as shown below.
 #
 # To set this up, just do:
 #
@@ -22,7 +22,8 @@
 #	git clone $gitrepo ikiwiki-checkout
 #
 # And then push into $gitrepo this ikiwiki.setup file, a templates/
-# directory, and a src/ directory with your wiki content.
+# directory, and a src/ directory with your wiki content. See README
+# for more details.
 #
 # Also, see the destdir and url parameters below which must also be
 # configured before things will work at all.
@@ -30,7 +31,7 @@
 our ($gitrepo, $checkout);
 
 BEGIN {
-	$gitrepo = '/path/to/bare/git/repo';
+	$gitrepo = "/path/to/bare/git/repo";
 	$checkout = "$gitrepo/ikiwiki-checkout";
 }
 
@@ -45,12 +46,22 @@ use IkiWiki::Setup::Standard {
 	# And you'll likely want to customise these as well
 	wikiname => "MyWiki",
 	#adminuser => ["yourname", ],
-	adminemail => 'me@example.org',
+	adminemail => "me@example.org",
 
 	# 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 +106,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",