responses and doc improvement
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Sat, 23 Dec 2006 05:58:15 +0000 (05:58 +0000)
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Sat, 23 Dec 2006 05:58:15 +0000 (05:58 +0000)
doc/bugs/HTML_is_not_update_nor_created_when_editing_markdown_via_CGI.mdwn
doc/bugs/cgi_wrapper_always_regenerated.mdwn
doc/usage.mdwn

index e95166518b38f9b581c1b5a89e7eb34c8bd318da..b1a63361e7c66fd7036642b109244f4ca7a701fe 100644 (file)
@@ -5,4 +5,15 @@ so when have new page it has a "?Page". (So CGI is working that much.) I edit ("
 
 How to get that file generated automatically on save (via edit)?
 
 
 How to get that file generated automatically on save (via edit)?
 
-If this is documented, sorry I missed it.
\ No newline at end of file
+If this is documented, sorry I missed it.
+
+> If a revision control system is configured, ikiwiki relies on a hook
+> being triggered by its commit to the RCS, which then runs ikiwiki again
+> to do the build, same as happens when a commit is made to the RCS
+> directly. If the appropriate hook is not uncommented and configured in
+> the setup file, you could see the behavior you describe.
+>
+> If no revision control system is used, ikiwiki handles the build after
+> writing the file.
+> 
+> --[[Joey]]
index 142a24db2a5047e7240e0b61832aaf8dad9e7612..76819422b5891b702fee26e31653b0fded41d5ec 100644 (file)
@@ -5,3 +5,12 @@ Whenever I run ikiwiki with --setup with this same configuration, then each time
 Should I use a different config? This is confusing because if I use a config without my cgi wrapper defined, I still have my left-over ikiwiki.cgi still in place (so CGI is enabled).
 
 It seems wasteful to update each time when my goal is just to create the HTML pges (since the CGI didn't generate them) as noted in my other bug report.
 Should I use a different config? This is confusing because if I use a config without my cgi wrapper defined, I still have my left-over ikiwiki.cgi still in place (so CGI is enabled).
 
 It seems wasteful to update each time when my goal is just to create the HTML pges (since the CGI didn't generate them) as noted in my other bug report.
+
+> If ikiwiki is run in refresh mode, it won't regnerate the wrapper. You
+> want to run it in refresh mode, because it's also wastful to rebuild all
+> the unchanged pages, which is done by default when setting up a wiki with
+> --setup.
+> 
+> Example of refresh mode: `ikiwiki -setup ikiwiki.setup --refresh`
+> 
+> Improved the docs slightly, so I'll call this [[bugs/done]] --[[Joey]]
index ce60d91a4f7790cd5385666d2a527bb70bd62d3c..4440660f6a1015105368bfa55539164797c9224a 100644 (file)
@@ -56,10 +56,12 @@ These options control the mode that ikiwiki is operating in.
   In setup mode, ikiwiki reads the config file, which is really a perl
   program that can call ikiwiki internal functions.
 
   In setup mode, ikiwiki reads the config file, which is really a perl
   program that can call ikiwiki internal functions.
 
+  [[ikiwiki.setup]] is an example of such a config file.
+
   The default action when --setup is specified is to automatically generate
   wrappers for a wiki based on data in a config file, and rebuild the wiki.
   The default action when --setup is specified is to automatically generate
   wrappers for a wiki based on data in a config file, and rebuild the wiki.
-
-  [[ikiwiki.setup]] is an example of such a config file.
+  If you only want to build any changed pages, you can use --refresh with
+  --setup.
 
 * --wrappers
 
 
 * --wrappers