From: Joey Hess <joey@kodama.kitenet.net>
Date: Tue, 5 Feb 2008 18:49:25 +0000 (-0500)
Subject: add a page describing ikiwiki's git repo, including branches
X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/commitdiff_plain/4e3329699bbacfd5f41699590333b0f3e06750d5?ds=sidebyside

add a page describing ikiwiki's git repo, including branches
---

diff --git a/doc/download.mdwn b/doc/download.mdwn
index 609d074b5..16728f019 100644
--- a/doc/download.mdwn
+++ b/doc/download.mdwn
@@ -32,20 +32,4 @@ Also. FreeBSD has ikiwiki in its
 
 ## revision control
 
-### git
-
-Ikiwiki is developed in a git repository and can be checked out by
-either of these commands:
-
-	git clone git://git.ikiwiki.info/
-	git clone http://git.ikiwiki.info/ikiwiki.git/
-
-The gitweb is [here](http://git.ikiwiki.info/?p=ikiwiki).
-
-Commits to this git repository are fed into [CIA](http://cia.vc), and can
-be browsed, subscribed to etc on its
-[project page](http://cia.vc/stats/project/ikiwiki).
-
-### subversion
-
-Ikiwiki's subversion repository is no longer available, use git instead.
+Ikiwiki is developed in a [[git_repository|git]].
diff --git a/doc/git.mdwn b/doc/git.mdwn
new file mode 100644
index 000000000..0979e9bf1
--- /dev/null
+++ b/doc/git.mdwn
@@ -0,0 +1,33 @@
+Ikiwiki is developed in a git_repository and can be checked out 
+like this:
+
+	git clone git://git.ikiwiki.info/
+
+Or like this if your firewall only passes http traffic (slow):
+
+	git clone http://git.ikiwiki.info/ikiwiki.git/
+
+The gitweb is [here](http://git.ikiwiki.info/?p=ikiwiki).
+
+Commits to this git repository are fed into [CIA](http://cia.vc), and can
+be browsed, subscribed to etc on its
+[project page](http://cia.vc/stats/project/ikiwiki).
+
+## branches
+
+You are of course free to set up your own ikiwiki git repository with your
+own [[patches|patch]].
+
+Some of the branches included in the main repository include:
+
+* `gallery` contains the [[todo/Gallery]] plugin. It's not yet merged
+  die to license issues.
+* `html` is an unfinished attempt at making ikiwiki output HTML 4.01
+  instead of xhtml.
+* `prefix-directives` changes the preprocessor directive syntax. It
+  is approxiamtly one failing test case away from merging.
+* `wikiwyg` adds [[todo/wikiwyg]] support. It is unmerged pending some
+  changes.
+* `pristine-tar` contains deltas that
+  [pristine-tar](http://kitenet.net/~joey/code/pristine-tar)
+  can use to recreate released tarballs of ikiwiki
diff --git a/doc/index.mdwn b/doc/index.mdwn
index bfbe46724..1a416d798 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -14,7 +14,8 @@ with ikiwiki, and some [[tips]].
 
 All wikis are supposed to have a [[SandBox]], so this one does too.
 
-This site generally runs the latest release of ikiwiki; currently, it runs ikiwiki [[version ]].
+This site generally runs the latest release of ikiwiki; currently, it runs
+ikiwiki [[version ]].
 
 ## developer resources
 
diff --git a/doc/patch.mdwn b/doc/patch.mdwn
index 05476a408..ca1620225 100644
--- a/doc/patch.mdwn
+++ b/doc/patch.mdwn
@@ -4,5 +4,8 @@ to duplicate work without coordination, here's a queue of suggested patches.
 If you post a patch to the [[todo]] or [[bugs]] list, or elsewhere,
 once it's ready to be applied, add a 'patch' tag so it will show up here.
 
+If your patch is non-trivial and might need several iterations to get
+right, please consider publishing a [[git]] branch.
+
 [[inline pages="(todo/* or bugs/*) and link(patch) and !link(bugs/done) and
 !link(todo/done) and !*/Discussion" rootpage="todo" archive="yes"]]