Initial reST documentation using Sphinx.

25 files changed, 432 insertions, 0 deletions

diff --git a/user/additional/index.rst b/user/additional/index.rst
new file mode 100644
index 0000000..b0ff7eb
--- /dev/null
+++ b/user/additional/index.rst
@@ -0,0 +1,35 @@
+======================
+Additional Information
+======================
+
+Information and details that do not belong in other sections go here.
+
+
+
+Important Terms
+===============
+
+Waf
+---
+Waf build system.  For more information see http://www.waf.io/
+
+See :ref:`waf`.
+
+
+Test Suite
+----------
+RTEMS test suite located in the ``testsuites/`` directory.
+
+
+
+Command List
+============
+
+List of all available commands in RTEMS
+
+
+Program List
+============
+
+List of all available programs in RTEMS
+
diff --git a/user/architecture/index.rst b/user/architecture/index.rst
new file mode 100644
index 0000000..6b3dd83
--- /dev/null
+++ b/user/architecture/index.rst
@@ -0,0 +1,10 @@
+=============
+Architectures
+=============
+
+XXX: preamble Architectures
+
+
+
+Testing. :r:arch:`sparc`
+
diff --git a/user/bsp/index.rst b/user/bsp/index.rst
new file mode 100644
index 0000000..b98db68
--- /dev/null
+++ b/user/bsp/index.rst
@@ -0,0 +1,10 @@
+===
+BSP
+===
+
+XXX: preamble BSPs
+
+
+
+Testing. :r:bsp:`sparc/sis`
+
diff --git a/user/config/build.rst b/user/config/build.rst
new file mode 100644
index 0000000..e43f30c
--- /dev/null
+++ b/user/config/build.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Build Configuration
+===================
+.. index:: Build Configuration
+
+XXX: build configuration
+
+
diff --git a/user/config/index.rst b/user/config/index.rst
new file mode 100644
index 0000000..c5c8145
--- /dev/null
+++ b/user/config/index.rst
@@ -0,0 +1,10 @@
+======
+Config
+======
+XXX: All about rtems config
+
+.. include:: build.rst
+.. include:: runtime.rst
+
+
+
diff --git a/user/config/runtime.rst b/user/config/runtime.rst
new file mode 100644
index 0000000..b2e69e8
--- /dev/null
+++ b/user/config/runtime.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Runtime
+=======
+.. index:: Runtime Configuration
+
+XXX: runtime config
+
+
diff --git a/user/glossary/index.rst b/user/glossary/index.rst
new file mode 100644
index 0000000..534f928
--- /dev/null
+++ b/user/glossary/index.rst
@@ -0,0 +1,19 @@
+========
+Glossary
+========
+
+.. glossary::
+
+	Waf
+		Waf build system.  For more information see http://www.waf.io/
+
+		See :ref:`waf`.
+
+
+	Test Suite
+	Testsuite
+		RTEMS test suite located in the ``testsuites/`` directory.
+
+
+	RTEMS
+		The Real-Time Executive for Multiprocessor Systems or RTEMS is a open source fully featured Real Time Operating System or RTOS that supports a variety of open standard application programming interfaces (API) and interface standards such as POSIX and BSD sockets.
diff --git a/user/index.rst b/user/index.rst
new file mode 100644
index 0000000..38b60f0
--- /dev/null
+++ b/user/index.rst
@@ -0,0 +1,36 @@
+.. highlight:: c
+
+============================
+RTEMS |version| user manual.
+============================
+
+Table of Contents
+-----------------
+
+.. toctree::
+	:maxdepth: 2
+
+	overview/index
+
+
+.. toctree::
+	:maxdepth: 2
+	:numbered:
+
+	start/index
+	config/index
+
+	tools/index
+	waf/index
+	test/index
+
+	bsp/index
+	architecture/index
+
+	support/index
+	additional/index
+	glossary/index
+
+
+*   :ref:`genindex`
+*   :ref:`search`
diff --git a/user/overview/index.rst b/user/overview/index.rst
new file mode 100644
index 0000000..432cee8
--- /dev/null
+++ b/user/overview/index.rst
@@ -0,0 +1,13 @@
+=========
+Overview
+=========
+
+Welcome to the :ref:term:`RTEMS` user manual.
+
+This document will attempt to cover every topic required as a user of RTEMS.
+
+.. note::
+  Developers should look at the :r:url:`devel` for technical information the 
+  design and development of RTEMS is located there.
+
+
diff --git a/user/start/depend.rst b/user/start/depend.rst
new file mode 100644
index 0000000..1f75282
--- /dev/null
+++ b/user/start/depend.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+Dependencies
+============
+.. index:: Dependencies
+
+XXX: List dependencies
+
diff --git a/user/start/index.rst b/user/start/index.rst
new file mode 100644
index 0000000..2573843
--- /dev/null
+++ b/user/start/index.rst
@@ -0,0 +1,10 @@
+===============
+Getting Started
+===============
+
+XXX: Very brief overview.
+
+
+.. include:: depend.rst
+.. include:: installation.rst
+.. include:: transition.rst
diff --git a/user/start/installation.rst b/user/start/installation.rst
new file mode 100644
index 0000000..f81abc4
--- /dev/null
+++ b/user/start/installation.rst
@@ -0,0 +1,24 @@
+:orphan:
+
+Installation
+============
+
+.. index:: Installation
+
+XXX: Some notes about waf etc.
+
+
+Released Version
+----------------
+
+.. index:: Tarball
+
+XXX: Tarball
+
+
+Development Version
+-------------------
+.. index:: Git
+
+XXX: Git
+
diff --git a/user/start/transition.rst b/user/start/transition.rst
new file mode 100644
index 0000000..4baea83
--- /dev/null
+++ b/user/start/transition.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Transition
+===========
+.. index:: Transition, Autotools
+
+XXX: Transition from auto* to waf.
+
+
diff --git a/user/support/index.rst b/user/support/index.rst
new file mode 100644
index 0000000..dc53b0a
--- /dev/null
+++ b/user/support/index.rst
@@ -0,0 +1,83 @@
+=======
+Support
+=======
+
+RTEMS offers a variety of support options.
+
+This chapter covers all options available to both users and developers.  If you belive this is a bug report please submit it to the bug tracker otherwise the developers mailing list the default location.
+
+
+Bug Tracker
+===========
+
+The bug tracker can be found at the :r:url:`bugs`.
+
+See the `Submission Guidelines <http://devel.rtems.org/wiki/NewTicket/>`_ for details on submitting a ticket.
+
+Be sure to do a cursory search for any tickets that may be relevant to your problem.
+
+If you are unsure about your issue status submit a ticket and we will help you sort it out.
+
+
+
+Documentation
+=============
+
+The latest user documentation can always be found at the :r:url:`docs`.  
+
+
+.. _support-mailing-lists:
+
+Mailing Lists
+=============
+
+We have several mailing lists for RTEMS users and developers.
+
+	* :r:list:`announce`
+		* Announcements for major and other project-related issues.
+
+	* :r:list:`bugs`
+		* Bugs email from :r:url:`bugs`.
+
+	* :r:list:`devel`
+		* Developers list, this is for developers of RTEMS itself.
+
+
+	* :r:list:`build`
+		* Results from the testing and building of RTEMS.
+
+	* :r:list:`users`
+		* Users of RTEMS.
+
+	* :r:list:`vc`
+		* Commits to the RTEMS master repository.
+
+
+IRC
+===
+
+RTEMS IRC is available on the Freenode network. See the `Freenode <http://www.freenode.net/>`_ web site for details on connecting, selecting a nickname, and general usage tips. If you are new to IRC it is recommended reading.
+
+
+These are the current IRC channels.
+
+  **#rtems**
+
+This is a general channel for all things RTEMS. You can just hang out with other RTEMS users and developers to talk about RTEMS, using RTEMS or to make contact with other RTEMS users.
+Logs
+
+
+The #rtems channel is logged. You can find the logs at http://www.rtems.org/irclogs/. You can search the logs using Google by adding
+
+  **site:rtems.org inurl:irclogs**
+
+to your search terms. 
+
+
+
+Developers
+==========
+
+Developers can find help and support on the mailing lists, see :ref:`support-mailing-lists`.
+
+Technical documents including design, :r:url:`gsoc`, :r:url:`socis` can be found on the :r:url:`devel`.
diff --git a/user/test/create.rst b/user/test/create.rst
new file mode 100644
index 0000000..329b076
--- /dev/null
+++ b/user/test/create.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Creating A Test
+===============
+.. index:: Creating a Test
+
+XXX: How to create a test.
+
+
diff --git a/user/test/index.rst b/user/test/index.rst
new file mode 100644
index 0000000..c767070
--- /dev/null
+++ b/user/test/index.rst
@@ -0,0 +1,10 @@
+==========
+Test Suite
+==========
+
+XXX: All about the test suite.
+
+
+.. include:: running.rst
+.. include:: create.rst
+
diff --git a/user/test/running.rst b/user/test/running.rst
new file mode 100644
index 0000000..c5161d7
--- /dev/null
+++ b/user/test/running.rst
@@ -0,0 +1,27 @@
+:orphan:
+
+Running
+========
+.. index:: Running a Test
+
+XXX: How to run tests via waf.
+
+
+Host
+----
+
+XXX: Host-based tests
+
+
+Simulation
+----------
+.. index:: Test Simulation
+
+XXX: Simulator
+
+
+
+Hardware
+--------
+XXX: Running on real hardware.
+
diff --git a/user/tools/build.rst b/user/tools/build.rst
new file mode 100644
index 0000000..8ec5dff
--- /dev/null
+++ b/user/tools/build.rst
@@ -0,0 +1,18 @@
+:orphan:
+
+Build Tools
+===========
+.. index:: Tools, rtems-config, rtems-cc
+
+
+
+rtems-config
+------------
+
+XXX: rtems-config
+
+
+rtems-cc
+--------
+
+XXX: rtems-cc
diff --git a/user/tools/index.rst b/user/tools/index.rst
new file mode 100644
index 0000000..a95668f
--- /dev/null
+++ b/user/tools/index.rst
@@ -0,0 +1,10 @@
+=====
+Tools
+=====
+
+XXX: All about rtems config
+
+
+.. include:: build.rst
+.. include:: simulation.rst
+
diff --git a/user/tools/simulation.rst b/user/tools/simulation.rst
new file mode 100644
index 0000000..7d86d4b
--- /dev/null
+++ b/user/tools/simulation.rst
@@ -0,0 +1,14 @@
+:orphan:
+
+Simulation
+==========
+.. index:: Simulation Tools, rtems-run
+
+XXX: simulation
+
+
+rtems-run
+---------
+
+XXX: rtems-run
+
diff --git a/user/waf/build.rst b/user/waf/build.rst
new file mode 100644
index 0000000..c01cd31
--- /dev/null
+++ b/user/waf/build.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Building
+========
+.. index:: Building
+
+XXX: How to build.
+
+
diff --git a/user/waf/config.rst b/user/waf/config.rst
new file mode 100644
index 0000000..00663fe
--- /dev/null
+++ b/user/waf/config.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Config
+=======
+.. index:: Config
+
+XXX: waf config
+
+
diff --git a/user/waf/index.rst b/user/waf/index.rst
new file mode 100644
index 0000000..0fac53c
--- /dev/null
+++ b/user/waf/index.rst
@@ -0,0 +1,13 @@
+.. _waf:
+
+===
+Waf
+===
+
+XXX: All about waf.
+
+
+.. include:: config.rst
+.. include:: build.rst
+.. include:: install.rst
+
diff --git a/user/waf/install.rst b/user/waf/install.rst
new file mode 100644
index 0000000..2ae5a80
--- /dev/null
+++ b/user/waf/install.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+Installing RTEMS
+================
+.. index:: Installing RTEMS
+
+XXX: How to install.
+
+
diff --git a/user/wscript b/user/wscript
new file mode 100644
index 0000000..7f76341
--- /dev/null
+++ b/user/wscript
@@ -0,0 +1,19 @@
+from sys import path
+from os.path import abspath
+path.append(abspath('../common/'))
+
+from waf import cmd_configure, cmd_build
+
+def configure(ctx):
+	cmd_configure(ctx)
+
+def build(ctx):
+
+	sub = {
+		"VERSION":				"1.0",
+		"RELEASE":				"5.0.0",
+		"DOC":					"User Manual",
+		"FILE_DOC":				"rtemsmanual",
+	}
+
+	cmd_build(ctx, sub)