In order to work as efficiently as possible it is necessary to establish conventions to improve team communication and to assist in the creation of clear documentation.

General Project Orientation

The project is currently set up on Matthew’s computer: sol.st.hmc.edu

Source code and the wiki are kept in a Subversion repository. (see the svn book for a description, svn cheatsheet for reference)
The repository can be accessed locally at svn://localhost/XV2PLinux/trunk . The trunk contains working development, branches contains development efforts that are a significant change from the trunk, tags contains snapshots of the code for final testing or release. The wiki is also contained in the repository and is committed after a source revision is described or a major update of the documentation.

Getting Started

Because the build process involves building a set of tools for cross-compiling and obtaining source. The first task of each developer is to walk through the Best Known Build Process, to get a base set of tools, confirm the accuracy of the current Best Known Build Process and gain familiarity with the build process and the development conventions.

After building a system, testing it and editing the wiki with modifications to the build process, pull down the current source form the repository, find something that needs fixing/improving/testing using the Project Progress page and have at it.

Editing the Wiki

Everyone should edit the wiki as whenever they run across something new, make an update to the source, see an error, find a bug, fix a bug, etc.

Making changes that only affect documentation, error reports or details of the wiki itself is simple; just edit the page, submit it and commit the wiki. To commit the wiki just use svn commit /opt/wiki.

Changes to the wiki which address one of the project goals should be noted on the Project Progress page using the same convention as changes to the source code described below.

Modifying the Source Code

When you’ve made a change to the source code in your local copy that you think ought to be part of the working code, commit the changes to the subversion repository and make note of the revision number. Please “make clean” the kernel sources before commiting

Next, add a page to the wiki for that revision number (ie. Rev No1) and describe the changes made in that revision. Link to the revision number on the Project Progress page under the goal(s) it addresses, and update progress percentages accordingly.

Then, make any changes necessary to other parts of the wiki to keep it up to date and commit the wiki.

Revised on April 10, 2007 15:55:18 by Matthew