Preface

This guide describes how to install, configure and build the source code delivery of the ChorusOS operating system. It explains both the source architecture and the way the product is built from source code.

Who Should Use This Book

This guide is written for experienced system administrators installing and maintaining the source code version of the ChorusOS 5.0 operating system.

Software developers with experience of the ChorusOS operating system will find use for the description of how to build ChorusOS systems from the source code and the examples showing how to adjust the system configuration to include modified components.

Before You Read This Guide

It is assumed here that you have installed the source code delivery of the ChorusOS 5.0 operating system for your host-target combination. For more details concerning installation, see the ChorusOS 5.0 Installation Guide and README.SRC.html.

If you do not have access to a local copy of the product documentation, including the man pages, it is assumed here that you have access to Sun documentation online. See Accessing Sun Documentation Online near the end of this preface for details.

How This Guide Is Organized

The ChorusOS 5.0 Source Delivery Guide is divided into the following chapters:

• Chapter 1, System and Support Requirements details the hardware and software requirements for a source delivery of the ChorusOS operating system

• Chapter 2, ChorusOS Source Layout explains where in the source code various vital components are stored.

• Chapter 3, Building and Build Tools explains how to build a source delivery of the ChorusOS operating system.

• Chapter 4, Customization gives examples of how to adapt the source delivery of the ChorusOS operating system to your own requirements.

• Chapter 5, Patches explains how to add patches to the ChorusOS operating system.

Related Documents

The following provide more extensive information on some of the topics covered in this guide:

• The ChorusOS 5.0 Application Developer's Guide demonstrates how to build an application component.

• The ChorusOS 5.0 Features and Architecture Overview provides an overview of the current release of the product.

• The ChorusOS 5.0 System Administrator's Guide offers quick access to descriptions and demonstrations of how to administrate ChorusOS systems in their operating environments.

• Managing Projects with make, Published by O'Reilly and Associates, ISBN: 0937175900, details how to use the make tool to build software products.

• The Solaris^TM reference manual pages, m4(1) and make(1S), and the ChorusOS reference manual pages, ChorusOSMkMf(1CC), configurator(1CC), configure(1CC), and mkmerge(1CC), cover in detail some of the tools used in this guide.

• Software Portability with Imake, Published by O'Reilly and Associates, ISBN: 1565922263, details how to use the imake tool to build software products.

Ordering Sun Documents

Fatbrain.com, an Internet professional bookstore, stocks select product documentation from Sun Microsystems, Inc.

For a list of documents and how to order them, visit the Sun Documentation Center on Fatbrain.com at http://www1.fatbrain.com/documentation/sun.

Accessing Sun Documentation Online

The docs.sun.com^SM Web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. The URL is http://www.oracle.com/technetwork/indexes/documentation/index.html.

Typographic Conventions

The following table describes the typographic changes used in this book.

Table P-1 Typographic Conventions

Typeface or Symbol	Meaning	Example
AaBbCc123	The names of commands, files, and directories; on-screen computer output	Edit your .login file. Use ls -a to list all files. machine_name% you have mail.
AaBbCc123	What you type, contrasted with on-screen computer output	machine_name% su Password:
AaBbCc123	Command-line placeholder: replace with a real name or value	To delete a file, type rm filename.
AaBbCc123	Book titles, new words, or terms, or words to be emphasized.	Read Chapter 6 in User's Guide. These are called class options. You must be root to do this.

Directory Conventions

The following table describes the directory conventions used in this book.

Table P-2 Directory Conventions

Directory	Description
download_dir	Directory containing the ChorusOS 5.0 download files.  Example: /home/user/downloads/ChorusOS_5.0/
extract_dir	Directory containing sufficient space to extract the delivery. This directory can be a local or an NFS mounted disk that has "write" permission.  Example: /home/user/extract/
install_dir	Directory where you install the ChorusOS product.  Example (also default): /opt/SUNWconn/SEW/5.0-processor_family where processor_family is one of the following: UltraSPARC, x86, PowerPC, MPC8xx Note that, during installation, you can choose the installation directory other than /opt/SUNWconn/SEW/. However, the 5.0-processor_family directory containing the ChorusOS directories and files is automatically created in the directory you specify.
build_dir	Directory where you configure and build the system image. This directory can be a local or an NFS mounted disk, but you must have "write" permission.  Example: /home/user/chorusos/build/
root_dir	Directory containing the ChorusOS file system.   Example: /install_dir/chorus-family/os/root
mount_dir	Directory on the host containing a file system you want to mount on a target.  Example: host:/install_dir/chorus-family/os/root
source_dir	Directory containing the source files.  Example: install_dir/chorus-family/src/

---

Note -

family is one of the following:

• usparc for UltraSPARC IIi/III

• x86 for Intel x86/Pentium

• ppc60x for the Motorola PowerPC 60x and 750 processor family and the PowerQUICC II (mpc8260) microcontroller

• mpc860 for the Motorola PowerQUICC I (mpc8xx) microcontroller.

---

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P-3 Shell Prompts

Shell	Prompt
C shell prompt	machine_name%
C shell superuser prompt	machine_name#
Bourne shell and Korn shell prompt	$
Bourne shell and Korn shell superuser prompt	#