Document trail plugin v3
[ikiwiki.git] / doc / post-commit.mdwn
index ea11ba7c936a3008880255aecde79fbd42e47234..1c5176d428da8b3e4890cf492ebd75a34e60e194 100644 (file)
@@ -1,10 +1,8 @@
 If your wiki is kept in [[revision_control|rcs]], a post-commit hook is run
-every time you commit a change to your repository. To make the wiki be
-updated each time a commit is made, it can be run from (or as) a
-post-commit hook.
+every time you commit a change to your repository.
 
-The best way to run ikiwiki in a post-commit hook is using a wrapper, which
-ikiwiki is usually configured to generate using a setup file.
+ikiwiki generates the "post-commit hook" once you've uncommented the relevant
+section (under wrappers) in the ikiwiki.setup.
 
 The generated wrapper is a C program that is designed to safely be made
 suid if necessary. It's hardcoded to run ikiwiki with the settings
@@ -17,4 +15,5 @@ your wiki checkout and html directory. If so, you can safely make
 the wrapper suid to a user who can write there (*not* to root!). You might
 want to read [[Security]] first.
 
-[[Setup]] explains setting this up in more detail.
+[[Setup]] explains setting this up from the start and see [[rcs/details]] to
+know more.