summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-12 21:20:34 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-12 21:20:34 -0400
commit97b71834bb99e967490b8b6f40677c248b947333 (patch)
tree5a17c2732ffbec89e6bd46a8c29d5d82830fc4bb
parentf1e29d04a603351bd92780d1349d848b0eceba05 (diff)
fix IkiWiki::Setup::load docs
-rw-r--r--doc/bugs/Does_IkiWiki::Setup::load__40____41___really_return_a_hash__63__.mdwn2
-rw-r--r--doc/plugins/write.mdwn6
2 files changed, 5 insertions, 3 deletions
diff --git a/doc/bugs/Does_IkiWiki::Setup::load__40____41___really_return_a_hash__63__.mdwn b/doc/bugs/Does_IkiWiki::Setup::load__40____41___really_return_a_hash__63__.mdwn
index 898941474..6facec896 100644
--- a/doc/bugs/Does_IkiWiki::Setup::load__40____41___really_return_a_hash__63__.mdwn
+++ b/doc/bugs/Does_IkiWiki::Setup::load__40____41___really_return_a_hash__63__.mdwn
@@ -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]]
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index e8ba0a6ab..920fb8797 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -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)`