3.1. Contributing to Uttk

Uttk use Vcs (A version control system wrapper) to commit into our Subversion repository. Vcs help us to perform some automatic tasks on each commit. For example each commit is posted on mailing list uttk-patches@lists.feydakins.org with a specific format including the ChangeLog entry, the diff, statistics about the diff…

You can get Vcs with the gem package.

  • Install Vcs:
    • Using rubygems (as root):
      gem install vcs
    • Check that Vcs is well installed:
      vcs --help
    • To use it properly you can make aliases:
      • To try it now type (take care about backquotes “`”): `vcs --mk-alias`
      • To install it add the output of vcs --mk-alias in your shell configuration (Zsh)
    • Check the alias (take care about the bang “!”):
      • In a subversion working copy the command svn st! is suppose to produce the same thing as svn st.
      • In a CVS working copy the command cvs st! is suppose to produce the same thing as cvs st.
    • Check your configuration:
      • The command vcs --check will warn you about missing configuration variables, and display nothing when everything is ok.
    • Vcs is built to be robust to errors so it create junk files (which names are leading by a coma “,”) and after solving a problem you can relaunch the same command to continue your task.
    • For any question about the Vcs installation and use reach me at: ertai@feydakins.org
  • Use Vcs to commit in Uttk:
    In the trunk directory of Uttk just type svn uttkci and follow instructions

You can just submit a patch using SVK patches.

Example:

svk commit -P add-this-and-fix-that send-a-mail —to uttk-discussion@lists.feydakins.org —subject “[PATCH] bla … bla” —attach ~/.svk/patch/add-this-and-fix-that.patch —body “…”