From: Joey Hess <joey@kodama.kitenet.net>
Date: Thu, 10 Jul 2008 02:47:06 +0000 (-0400)
Subject: clarifications, comments
X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/commitdiff_plain/aa1f0080a81ac253ae4ff8822132327ee29fe835?ds=sidebyside

clarifications, comments
---

diff --git a/IkiWiki/Setup.pm b/IkiWiki/Setup.pm
index 778e1b495..a37264cd7 100644
--- a/IkiWiki/Setup.pm
+++ b/IkiWiki/Setup.pm
@@ -1,4 +1,11 @@
 #!/usr/bin/perl
+# Ikiwiki setup files are perl files that 'use IkiWiki::Setup::foo',
+# passing it some sort of configuration data.
+#
+# There can be multiple modules, with different configuration styles.
+# The setup modules each convert the data into the hashes used by ikiwiki
+# internally (if it's not already in that format), and store it in
+# IkiWiki::Setup::$raw_setup, to pass it back to this module.
 
 package IkiWiki::Setup;
 use warnings;
@@ -6,8 +13,6 @@ use strict;
 use IkiWiki;
 use open qw{:utf8 :std};
 
-# This hashref is where setup files store settings while they're being
-# loaded. It is not used otherwise.
 our $raw_setup;
 
 sub load ($) { # {{{
@@ -67,14 +72,14 @@ sub setup () { #{{{
 		next if $c eq 'syslog';
 		if (defined $setup{$c}) {
 			if (! ref $setup{$c}) {
-				$config{$c}=IkiWiki::possibly_foolish_untaint($setup{$c});
+				$config{$c}=possibly_foolish_untaint($setup{$c});
 			}
 			elsif (ref $setup{$c} eq 'ARRAY') {
-				$config{$c}=[map { IkiWiki::possibly_foolish_untaint($_) } @{$setup{$c}}]
+				$config{$c}=[map { possibly_foolish_untaint($_) } @{$setup{$c}}]
 			}
 			elsif (ref $setup{$c} eq 'HASH') {
 				foreach my $key (keys %{$setup{$c}}) {
-					$config{$c}{$key}=IkiWiki::possibly_foolish_untaint($setup{$c}{$key});
+					$config{$c}{$key}=possibly_foolish_untaint($setup{$c}{$key});
 				}
 			}
 		}