Add script for generating wiki page.
authorJelmer Vernooij <jelmer@samba.org>
Tue, 8 Jul 2008 20:53:54 +0000 (22:53 +0200)
committerJelmer Vernooij <jelmer@samba.org>
Tue, 8 Jul 2008 20:53:54 +0000 (22:53 +0200)
HACKING [new file with mode: 0644]
INSTALL
README
wiki.py [new file with mode: 0755]

diff --git a/HACKING b/HACKING
new file mode 100644 (file)
index 0000000..5d77963
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,13 @@
+Development
+===========
+
+Unit testing
+~~~~~~~~~~~~
+To run the bzr-svn testsuite, simply run 
+'bzr selftest --starting-with=bazaar.plugins.svn' or 
+run 'make check' in the top-level bzr-svn directory.
+
+Coding Style, etc
+~~~~~~~~~~~~~~~~~
+Please refer to HACKING in the Bazaar source distribution.
+
diff --git a/INSTALL b/INSTALL
index d27f3a2662f275873d589f80422be5439cf15273..b8bc42caffffa7ddf6dc8b8211755a46688b1674 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,24 +1,24 @@
 Installation
-============
+------------
 
 Requirements
-------------
+~~~~~~~~~~~~
 
 Bazaar
-~~~~~~
+^^^^^^
 
 You will need a recent version of Bazaar, usually the release of Bazaar 
 released in the same month as the release of bzr-svn you are using. bzr-svn 
 will warn if the Bazaar release used is too old or too new.
 
 SQLite
-~~~~~~
+^^^^^^
 
 If you are using Python 2.4, you will need to have the pysqlite module 
 installed.  Python 2.5 and higher have sqlite support built in. 
 
 Subversion development files
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 You need the Subversion libraries, including the development files. This should
 be readily packaged for most platforms. The package name for Debian 
@@ -45,7 +45,7 @@ To install on OS X Leopard do something like the following.  Note: If you have M
 
  
 bzr-rebase
-~~~~~~~~~~
+^^^^^^^^^^
 
 In order to be able to use the ``svn-upgrade`` command (for those 
 who used versions of bzr-svn older than 0.4.0), you will need the `bzr-rebase`_ 
@@ -54,14 +54,14 @@ plugin.
 .. _bzr-rebase: http://bazaar-vcs.org/Rebase
 
 Building
---------
+~~~~~~~~
 
 Simply place this directory in ~/.bazaar/plugins and you should be able 
 to check out branches from Subversion using bzr. Make sure the directory 
 name is 'svn'. The plugin has to be built as well by running ``make``.
 
 Packages
---------
+~~~~~~~~
 
 Instead of installing the plugin yourself, you can also install a prepackaged 
 version of it for your platform.
@@ -100,12 +100,14 @@ After installing, add the svn-python bindings to your Python2.5 installation
 ::
 
   # Tiger
-  echo "/opt/subversion-1.5.x/lib/svn-python/" > /Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/site-packages/subversion.pth
+  echo "/opt/subversion-1.5.x/lib/svn-python/" > \
+         /Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/site-packages/subversion.pth
 
   # Leopard
-  echo "/opt/subversion-1.5.x/lib/svn-python/" > /System/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/site-packages/subversion.pth
+  echo "/opt/subversion-1.5.x/lib/svn-python/" > \
+         /System/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5/site-packages/subversion.pth
 
-Install the bzr_svn plugin following the instructions in the `From Source`_ section (a DMG is coming soon ;) )
+Install the bzr_svn plugin following the instructions in the `From Source on Mac OS X`_ section. A DMG will hopefully be released soon as well.
 
 ..
        vim: ft=rest
diff --git a/README b/README
index e0b720df58ef060e73f7003d80be302c281f0444..9b04c756dbaf1f7fdb30c62fadd42ea469c5a533 100644 (file)
--- a/README
+++ b/README
@@ -84,14 +84,6 @@ specified in the `mapping specification`_.
 
 .. _mapping specification: BzrForeignBranches/Subversion/mapping
 
-Support
--------
-Ask bzr-svn related questions on the `Bazaar mailing list`_ or in the 
-#bzr IRC channel on Freenode_.
-
-.. _Bazaar mailing list: http://lists.canonical.com/listinfo/bazaar/
-.. _Freenode: http://www.freenode.net/
-
 Limitations
 -----------
 
@@ -149,6 +141,14 @@ Other features currently held back by Bazaars feature set:
    
   Spec at https://launchpad.net/products/bzr/+spec/bzr-cpick-data
 
+Support
+-------
+Ask bzr-svn related questions on the `Bazaar mailing list`_ or in the 
+#bzr IRC channel on Freenode_.
+
+.. _Bazaar mailing list: http://lists.canonical.com/listinfo/bazaar/
+.. _Freenode: http://www.freenode.net/
+
 Bugs
 ----
 
@@ -157,14 +157,5 @@ https://launchpad.net/bzr-svn/.
 
 The wiki for this plugin is at http://bazaar-vcs.org/BzrForeignBranches/Subversion.
 
-Development
------------
-
-Unit testing
-~~~~~~~~~~~~
-To run the bzr-svn testsuite, simply run 
-'bzr selftest --starting-with=bazaar.plugins.svn' or 
-run 'make check' in the top-level bzr-svn directory.
-
 ..
        vim: ft=rest
diff --git a/wiki.py b/wiki.py
new file mode 100755 (executable)
index 0000000..6b0e7df
--- /dev/null
+++ b/wiki.py
@@ -0,0 +1,65 @@
+#!/usr/bin/python
+# Copyright (C) 2008 Jelmer Vernooij <jelmer@samba.org>
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from bzrlib.branch import Branch
+import sys
+
+b = Branch.open(".")
+
+DOWNLOAD_URL = "http://samba.org/~jelmer/bzr"
+
+def write_releaselist(f):
+    f.write("\nReleases\n")
+    f.write("--------\n\n")
+
+    versions = []
+
+    for release in b.tags.get_tag_dict():
+        (name, version) = release.rsplit("-", 1)
+        assert name == "bzr-svn"
+        versions.append(version)
+
+    def version_sort(a, b):
+        def versiontuple(a):
+            return [int(x) for x in a.split(".")]
+        return cmp(versiontuple(a), versiontuple(b))
+
+    versions.sort(version_sort, reverse=True)
+
+    for version in versions:
+        f.write("* %s_\n" % version)
+
+    f.write("\n")
+
+    for version in versions:
+        f.write(".. _%s: %s/bzr-svn-%s.tar.gz\n" % (version, DOWNLOAD_URL, version))
+
+    f.write("\n")
+
+f = sys.stdout
+f.write("#FORMAT rst\n")
+f.write(open("README", "r").read())
+write_releaselist(f)
+f.write(open("INSTALL", "r").read())
+f.write("""
+Credits
+-------
+bzr-svn was written by JelmerVernooij_ with the help from various other people.
+See the AUTHORS file in the source distribution for a list.
+
+.. _JelmerVernooij: http://samba.org/~jelmer/
+
+""")