Revision as of 04:25, 20 January 2007

Graph of svn activity up to revision 2027, taken 14/11/06.

I don't feel like reading this whole document. How do I obtain and compile Odamex from Subversion?

Following is the cheat-sheet command to build and run odamex from svn on a typical *nix system. This command is not guaranteed to work, in fact it is more likely to fail, you should not use it unless you understand what it does.

cd; svn co svn://odamex.net:3000/ odamex; cd odamex/trunk; make; ./odamex

What is Subversion?

Subversion is the current version control repository used to maintain the Odamex source code. In layman's terms, it allows multiple people to be working on the same project at the same time while giving those same people the facilities to recognize collisions between two contributors code.

How do I access Odamex's Subversion respository?

Odamex's subversion repository can be accessed using the following URL:

http://odamex.net/svn/root/

What is Odamex's Subversion access policy?

Read-only access to Odamex's Subversion repository is public, meaning that anyone can checkout the source for their own purposes, including modification and compilation. However, further repository access, such as Commit access, is restricted based on our Policy. If you wish to contribute to Odamex, please send a patch to one of the indicated MAINTAINERS. Those that contribute considerable time to improve the Odamex source may be granted full or partial access.

Generally, the project manager(s) will administrate this access with the guidance of the lead coder(s). Inactive accounts will tend to get frozen or disabled after a certain length of time.

How do I use a subversion client?

This depends on the subversion client you happen to be using. However, there are some terms that you should recognize that are consistant between clients.

Checkout

The process of checking out means that you connect to the subversion server and it downloads a revision of the code you specify and places it into a newly created subversion filesystem on your local hard drive. By default, the HEAD(latest) revision is the one that is checked out, and probably the one that you are most interested in.

This is how you check out from the command line:

svn checkout <server name> <destination directory>

Update

Once you check out a revision of odamex's source code, your local version of the code stays that way. If a newer version of the code comes out, you have two options. You can either check out a new version of the code into a seporate directory, or you can update the existing code that you already have. Note that any changes you have made to your local copy are kept, and not discarded, and if the version you download from the server collides with any of your changed files, subversion will tell you this, and you must handle the conflict between your local copy and the server's repository manually, usually through a revert, or by creating a new local copy so you don't lose your hard work..

This is how you update from the command line:

svn update <local directory>

Note that you do not need to specify the server, as subversion remembers the server where your local copy originated from.

What Subversion clients are avalable?

There are many, many subversion clients avalable:

• Subversion: Command Line client for multiple platforms.
• TortiseSVN: Windows Explorer extension for Windows.
• RapidSVN: wxWidgets based GUI client for multiple platforms.

How is Odamex's repository organized

Each branch keeps an entire odamex source tree.

• root
  • trunk - Bleeding-edge development, expect things to break often
  • branches
    • stable - The latest stable version, merged with trunk when features mature
    • ogl_hack - A very experimental attempt at creating an OpenGL-based renderer for Odamex
    • other temporary branches may be created or destoryed
  • tags

How can I be notified when the repository updates?

Any changes to our svn repository are reported in:

• The Odamex Changelog
• The Odamex IRC Channel by the odasvn bot.

Guidelines for maintainers

• Do
  • Regularly update your working copy
  • Commit individual improvements and corrections to the existing code
  • Separate your commits semantically
  • Make an informative comment with each commit
  • Mention related bugs and revisions (see changelog for examples)
  • Seek comments on bugzilla and forum before making major changes
  • Test your changes before every commit
• Do not
  • Commit broken code to trunk or stable
  • Commit untested code to stable
  • Make giant monolithic commits
  • Make major changes without consulting maintainers
  • Make frivolous commits
  • Overwrite other people's recent work without asking them
  • Change EOL modes of files, All files should be LF