Documentation

Duckwater Documentation

Here you can find various documentation for the project.

Documentation Source Gate

The Duckwater design documentation (and other materials)
is currently kept in a Mercurial gate.

duckwater-docs: Anonymous pull is allowed. You must either be a leader of this project (or a committer for the duckwater-docs repository) to push. Please visit the OpenSolaris Mercurial page read these instructions on how to use Mercurial repositories.

Status: The repository is now live.  Currently the documentation gate
is being assembled for PSARC inception materials.

To bringover from the duckwater\-docs repository

   
$ hg clone ssh://your\-login@hg.opensolaris.org/hg/duckwater/duckwater\-docs or $ hg clone ssh://anon@hg.opensolaris.org/hg/duckwater/duckwater\-docs

Documentation Format

Currently the documentation format of choice is rst format
(reStructuredText) and some plaint text..

Details on rst can be found here:

• reStructuredText
• rst Quick Start
• rst Quick reference

rst tools can be found here:

• Docutils
• pdftex

We currently use blastwave's tetex distribution to generate the
doctools pdf files output from this gate.

See:

• Blastwave
• and tetex

for details.