fix IkiWiki::Setup::load docs
authorJoey Hess <joey@kodama.kitenet.net>
Sat, 13 Sep 2008 01:20:34 +0000 (21:20 -0400)
committerJoey Hess <joey@kodama.kitenet.net>
Sat, 13 Sep 2008 01:20:34 +0000 (21:20 -0400)
doc/bugs/Does_IkiWiki::Setup::load__40____41___really_return_a_hash__63__.mdwn
doc/plugins/write.mdwn

index 898941474a45ff31d5126bc3bb02033ba124c580..6facec8966219dfc13da2e531109da35a97fdaed 100644 (file)
@@ -6,3 +6,5 @@ Shouldn't this print a bunch of output (admittedly not very nicely formatted).
 [ 11 rocinante  ~/tmp ]  perl -M'IkiWiki::Setup' -e 'print IkiWiki::Setup::load("foo.setup");'
 </pre>
 I get nothing with ikiwiki 2.63 [[DavidBremner]]
+
+> The docs were wrong, it populates `%config`. --[[Joey]] [[done]]
index e8ba0a6abe6826924b8e41aee71b3ceea50ae13e..920fb8797cfa4a1d09e0947e261dc7455f1f89c7 100644 (file)
@@ -805,6 +805,6 @@ when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
 to a hash containing all the config items. They should also implement a
 `gendump` function.
 
-By the way, to parse a ikiwiki setup file, a program just needs to
-do something like:
-`use IkiWiki::Setup; my %setup=IkiWiki::Setup::load($filename)`
+By the way, to parse a ikiwiki setup file and populate `%config`, a
+program just needs to do something like:
+`use IkiWiki::Setup; IkiWiki::Setup::load($filename)`