Friday, February 02, 2007

Subversion perversion

As I'd mentioned earlier, Google code has added a Wiki feature supposed to be useful to maintain documentation. We in the programming world know that once you document stuff in a place other than the original source code, it rapidly goes out of sync. So I tried another way to present the generated muSE documentation right where the source code is available - the Subversion repo itself.

I simply generated the HTML documentation using doxygen and placed the output into its own Subversion module/folder - here. Once all the files are tagged with the appropriate mime types, the whole site is functional .. and versioned to boot!

Here are the mime-type setting commands you need to use in the doxygen generated documentation folder -

svn propset svn:mime-type "text/html" *.html
svn propset svn:mime-type "image/png" *.png
svn propset svn:mime-type "text/css" *.css
svn propset svn:mime-type "image/gif" *.gif
svn propset svn:mime-type "text/plain" *.md5
svn propset svn:mime-type "text/plain" *.map

2 comments:

  1. AnonymousFebruary 06, 2007 10:16 AM

    Not sure to ell understand what you're doing, but I tried googlecode yesterday and the wiki is already part of subversion: each wiki page is a file in wiki folder. Project organisation is as follow: branches, tags, trunk, wiki.

    ReplyDelete
  2. KumarFebruary 07, 2007 3:09 PM

    The wiki is not automatically generated from the code whereas the doxygen documentation is. It is easier to keep in sync with the code if they are both generated from the same source file.

    I plan to use the wiki for non-code documentation.

    ReplyDelete