improve the ikiwiki.setup for git, hope I got everything right

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index cda524ae15dfc7671c1a1f2f95aa82cfabfc561a..89a331790afca50c110ea465cd761e7903c73c17 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -16,31 +16,45 @@ use IkiWiki::Setup::Standard {
        
        url => "http://myhost/wiki",
        cgiurl => "http://myhost/ikiwiki.cgi",
        
        url => "http://myhost/wiki",
        cgiurl => "http://myhost/ikiwiki.cgi",

-       #historyurl => "http://svn.myhost/trunk/[[file]]",

        #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
        #templatedir => "/usr/share/ikiwiki/templates",
        
        #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
        #templatedir => "/usr/share/ikiwiki/templates",
        

-       #rcs => "", # don't use svn
-       rcs => "svn", # use svn (the default)
+       # Subversion stuff.
+       rcs => "svn",
+       #historyurl => "http://svn.myhost/trunk/[[file]]",

        svnrepo => "/svn/wiki",
        svnpath => "trunk",
 
        svnrepo => "/svn/wiki",
        svnpath => "trunk",
 

+       # Git stuff.
+       #rcs => "git",
+       #historyurl => "http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
+

        wrappers => [
        wrappers => [

+               #{
+               #       # The cgi wrapper.
+               #       cgi => 1,
+               #       wrapper => "/var/www/wiki/ikiwiki.cgi",
+               #       wrappermode => "06755",
+               #},

                {
                {

-                       # The svn wrapper.
+                       # The svn post-commit wrapper.

                        # Note that this will overwrite any exsting
                        # post-commit hook script, which may not be
                        # what you want.
                        # Note that this will overwrite any exsting
                        # post-commit hook script, which may not be
                        # what you want.

-                       wrapper => "/svn/wiki/hooks/post-commit",
+                       wrapper => "/svn/wikirepo/hooks/post-commit",

                        wrappermode => "04755",
                        # Enable mail notifications of commits.
                        notify => 1,
                },
                #{
                        wrappermode => "04755",
                        # Enable mail notifications of commits.
                        notify => 1,
                },
                #{

-               #       # The cgi wrapper.
-               #       cgi => 1,
-               #       wrapper => "/var/www/wiki/ikiwiki.cgi",
-               #       wrappermode => "06755",
+               #       # The git post-update wrapper.
+               #       # Note that this will overwrite any exsting
+               #       # post-commit hook script, which may not be
+               #       # what you want.
+               #       wrapper => "/git/wikirepo/hooks/post-update",
+               #       wrappermode => "04755",
+               #       # Enable mail notifications of commits.
+               #       notify => 1,

                #},
        ],
        
                #},
        ],
        

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 01649b1971e61fd346868d5482ca0635326ed756..cd6bfdc9c6610beeb7dd08562ad4559b4588a685 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -66,13 +66,16 @@ and that has optional support for commits from the web.
    Most of the options, like `wikiname` in the setup file are the same as
    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
    `destdir` are the two directories you specify when running ikiwiki by
    Most of the options, like `wikiname` in the setup file are the same as
    ikiwiki's command line options (documented in [[usage]]. `srcdir` and
    `destdir` are the two directories you specify when running ikiwiki by

-   hand. `rcsrepo` is the path to your master rcs repository.  Make sure
+   hand. `svnrepo` is the path to your subversion repository.  Make sure

    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 
    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 

-   Note that the default file has a block to configure an Rcs wrapper to
-   update the wiki.  You need to uncomment the related block for whatever
-   rcs you use and comment out the other rcs blocks.
+   If you want to use git, comment out the subversion stuff, uncomment and
+   edit the git stuff.
+
+   Note that the default file has a block to configure an [[post-commit]] 
+   wrapper to update the wiki. You need to uncomment the related block for
+   whatever rcs you use and comment out the other rcs blocks.

 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.
 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.


@@ -90,14 +93,8 @@ and that has optional support for commits from the web.
    
    The `historyurl` setting makes ikiwiki add the links, and in that url,
    "\[[file]]" is replaced with the name of the file to view. So edit
    
    The `historyurl` setting makes ikiwiki add the links, and in that url,
    "\[[file]]" is replaced with the name of the file to view. So edit

-   ikiwiki.setup and set `historyurl` to something like this for
-   Subversion:
-
-       `http://svn.host/trunk/\[[file]]?root=wiki`
-
-   Or this for Git:
-
-       `http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]`
+   ikiwiki.setup and ucomment the appropriate `historyurl` setting and edit
+   it for your setup.

    
    Then run `ikiwiki --setup ikiwiki.setup` again.
 
    
    Then run `ikiwiki --setup ikiwiki.setup` again.