Add README file on maintaining this Git repos.
authorEdward Z. Yang <edwardzyang@thewritingpot.com>
Mon, 12 Jan 2009 00:19:50 +0000 (19:19 -0500)
committerEdward Z. Yang <edwardzyang@thewritingpot.com>
Mon, 12 Jan 2009 04:24:25 +0000 (23:24 -0500)
Signed-off-by: Edward Z. Yang <edwardzyang@thewritingpot.com>
README.SIPB [new file with mode: 0644]

diff --git a/README.SIPB b/README.SIPB
new file mode 100644 (file)
index 0000000..29127fd
--- /dev/null
@@ -0,0 +1,40 @@
+README for SIPB maintainers
+
+How this repository is set up, and how to keep IkiWiki up to date.
+
+
+Setup:
+
+There are three branches of interest: remotes/origin/master, master
+and sipb.  remotes/origin/master is the remote branch we are tracking;
+all upstream changes show up in this branch when we `git fetch`.
+
+master is our "awaiting upstream approval" branch, based off of
+remotes/origin/master. Any patches in this branch should be immediately
+suitable for submission to IkiWiki maintainers/. Ideally, this branch
+should be equivalent to remotes/origin/master.
+
+sipb is our live branch. It contains all of the ugly hacks and custom
+modifications that we needed to make our website run. Ideally, this
+branch is equivalent to master. Don't expect it to be without a lot
+of rearchitecting and upstream cooperation.
+
+
+Keeping up to date:
+
+This two-tiered setup means that you will need to rebase twice in order
+to propagate changes; possibly once if master == origin/master. Your
+commands will look like this:
+
+$ git checkout origin
+if master == remotes/origin/master:
+  $ git pull
+else
+  $ git fetch
+  $ git rebase origin/master
+fi
+$ git checkout sipb
+$ git rebase master
+
+TODO: Make a script that does this.
+