web commit by ManojSrivastava
[ikiwiki.git] / doc / rcs / git.mdwn
index e90aa24328874fa751e211610f0958e9c8f99044..bff322d5a79b2ccc7ae1697b64cd08ebaf86b825 100644 (file)
@@ -17,7 +17,9 @@ shallow, single level tree, with a bare repository (meaning that it
 does not have a working tree checked out) at the root, and various
 working clones (with working directories) as leaf nodes.  The root
 (bare) repository is meant to be pushed to and pulled from the various
-working clones. 
+working clones. The image below displays the relationship between the
+root repository and the clone repositories (this is not a directory
+layout):
 
 ![Git repository relationships](http://people.debian.org/~srivasta/ikiwiki_git.png)
 
@@ -40,34 +42,47 @@ yourself.
 So, to reiterate, when using Git, you probably want to set up three
 repositories:
 
-* The root repository. This should be a bare repository (meaning that it does not have a working tree checked out), which the other repositories will push to/pull from.  It is a bare repository, since there are problems pushing to a repository that has a working directory. This is called _repository_ in [[ikiwiki-makerepo]]'s  manual page. Nominally, this bare repository has a `post-commit` hook that would change directory to the ikiwiki leaf node repository below (the working directory for ikiwiki), do a _git pull_, and refresh ikiwiki to regenerate the wiki with any new content.
-* The second repository is a clone of the bare root repository, and has a working tree which is used as ikiwiki's srcdir for compiling the wiki. **Never** push to this repository. When running as a [[cgi]], the changes are committed to this repository, and pushed to the master repository above. This is called _srcdir_ in [[ikiwiki-makerepo]]'s manual page.
-* The other (third, fourth, fifth, sixth -- however many pleases you) repositories are also clones of the bare root repository above -- and these have a working directory for you to work on. Use either the `git` transport (if available), or `ssh`. These repositories may be on remote machines, your laptop, whereever you find convenient to hack on your wiki. Any new content should be pushed to the bare master repository when you are ready to publish it, and then the post-commit hook of the bare repository will ensure that the ikiwiki's source directory is updated, and the ikiwiki refreshed with the new content.
-
-Using three or more of repositories isn't the most obvious set up, but it works the best for typical ikiwiki use.  [[tips/Laptop_wiki_with_git]] describes a different way to set up ikiwiki and git.
+* The root repository. This should be a bare repository (meaning that
+  it does not have a working tree checked out), which the other
+  repositories will push to/pull from.  It is a bare repository, since
+  there are problems pushing to a repository that has a working
+  directory. This is called _repository_ in [[ikiwiki-makerepo]]'s
+  manual page. Nominally, this bare repository has a `post-commit`
+  hook that would change directory to the ikiwiki leaf node repository
+  below (the working directory for ikiwiki), do a _git pull_, and
+  refresh ikiwiki to regenerate the wiki with any new content.
+* The second repository is a clone of the bare root repository, and
+  has a working tree which is used as ikiwiki's srcdir for compiling
+  the wiki. **Never** push to this repository. When running as a
+  [[cgi]], the changes are committed to this repository, and pushed to
+  the master repository above. This is called _srcdir_ in
+  [[ikiwiki-makerepo]]'s manual page.
+* The other (third, fourth, fifth, sixth -- however many pleases you)
+  repositories are also clones of the bare root repository above --
+  and these have a working directory for you to work on. Use either
+  the `git` transport (if available), or `ssh`. These repositories may
+  be on remote machines, your laptop, whereever you find convenient to
+  hack on your wiki. you can commit local changes to the version on
+  the laptop, perhaps while offline. You can browse and edit the wiki
+  using a local web server. Any new content should be pushed to the
+  bare master repository when you are ready to publish it, and then
+  the post-commit hook of the bare repository will ensure that the
+  ikiwiki's source directory is updated, and the ikiwiki refreshed
+  with the new content.
+
+Using three or more of repositories isn't the most obvious set up, but
+it works the best for typical ikiwiki use. [[ikiwiki-makerepo]] can
+automate setting this up for the common case where there is no
+pre-existing wiki. [[tips/Laptop_wiki_with_git]] describes a different
+way to set up ikiwiki and git.
 
 It is **paramount** that you **never** push to the non-bare repository
 ([this FAQ entry explains why](http://git.or.cz/gitwiki/GitFaq#head-b96f48bc9c925074be9f95c0fce69bcece5f6e73)).
-Instead, clone the bare repository as mentioned above, and push **only** to the bare repository.
+Instead, clone the bare repository as mentioned above, and push
+**only** to the bare repository.
 
 The ikiwiki `post-commit` hook should be put in the bare repository.
 
-### Ten steps to get rich using git as your ikiwiki SCM  
-
-1. `mkdir -p /path/to/repository && cd /path/to/repository`
-2. `git --bare init --shared`
-3. `mkdir -p /path/to/clone0 && cd  /path/to/clone0`
-4. `git clone /path/to/repository`
-5. `echo /.ikiwiki > .gitignore`
-6. `echo recentchanges >> .gitignore`
-7. `git add .gitignore`
-8. Now, populate your wiki. You could us `cp` to copy over files, use you favourite editor to create files and `git add` them, or you could import a wiki repository from another VCS using `git-svnimport`, `git-archimport`, or `git-cvsimport`. Make sure the permissions are correct in order for [[cgi]] to commit here (consider actually cloning another reposotory for yourself, on this or on another machine). Use `git add` to add these files to the index.
-9. `git push`
-10. Profit.
-
-[[ikiwiki-makerepo]] can automate setting this up for the common case
-where there is no pre-existing wiki.
-
 ## git repository with multiple committers
 
 It can be tricky to get the permissions right to allow multiple people to
@@ -86,3 +101,46 @@ be setgid to the right group. Then the srcdir, including its git
 repository, should only be writable by the wiki's admin, and *not* by the
 group. Take care that ikiwiki uses a umask that does not cause files in
 the srcdir to become group writable. (umask 022 will work.)
+
+## Configuration
+
+### Ikiwiki working directory
+
+* Configure a cgi wrapper as usual, but configure the git wrapper to
+  be written to the post-commit hook of the git clone being used by
+  the ikiwiki (clone 0 in the image). Set in the configuration:
+
+        gitorigin_branch=> "origin",
+        ## git post-commit wrapper
+        wrapper => "/path/to/bare/repo/.git/hooks/post-commit",
+
+
+
+### Working clones (Clone 1 .. N in the image)
+
+* By default, ikiwiki pulls and pushes from `origin`. This is not
+  ideal for the working clones, since the user might go through
+  several iterations of a posting before pushing to the bare root of
+  the repository tree. In the configuration, set:
+
+        gitorigin_branch => "",
+        ## git post-commit wrapper
+        wrapper => "/working/dir/.git/hooks/post-commit",
+
+  Then just committing should refresh the ikiwiki on the local host.
+
+* You can optionally enable to the [[plugins/mirrorlist]] plugin,
+  and configure it so that each page links to the corresponding page on the
+  server.
+
+Now just run `ikiwiki -setup wiki.setup -getctime` and you should be
+good to go. (You only need the slow `-getctime` option the first time you
+run setup.)
+
+Use standard git commands to handle pulling from and pushing to the server.
+
+Note: Currently, after pulling changes, you will need to manually update
+the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`. This
+is because git 1.5.4 doesn't have a hook that is run locally after pulling
+changes. Newer versions of git will have a `post-merge` hook that should
+work for this purpose.