SPIN Operating System Documentation

June 8, 1996

Documentation Information

Every major directory in the SPIN source tree contains a doc directory which contains (minimally) an index.html file. The doc directory may also contain auxiliary files.

Basic information

Getting started at UW.
How to get started with SPIN at UW.
Getting started outside UW.
How to install SPIN on the Alpha platform from the distribution.
Modula-3
A good starting point for M3.
User programs.
User space programs.
Writing extensions
Writing kernel extensions.

Critical Procedures

Building
How to build the latest release.
Release Notes
Release Notes
Booting - Alpha
Booting on the alpha platform.
Booting - iX86
Booting on the x86 platform.
Debugging
Finding and fixing bugs
GNATS
Reporting and tracking bugs (or go directly to SPIN PRMS)
Profiling
Profiling

UW Procedures

Merging
How merge your code into the potato.
Testing
Reality checking your kernel.
Versioning
How to use CVS.
Writing documentation
Writing and managing documentation.
Creating a new platform
How to build a new platform

The SPIN Source Tree

The sources developed for SPIN are organized in three trees:
kernel
The SPIN kernel
user
SPIN applications, and their extensions of the SPIN kernel.
local
The SPIN adaptation of Modula-3, the debugger and other tools that run on the development platform.


ddion@cs.washington.edu