From: José Fonseca <jfonseca@vmware.com>
Date: Wed, 3 Feb 2010 15:56:36 +0000 (+0000)
Subject: gallium/docs: Document the OS module.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=976afaf98f4b1ce32003dd014cbb3c09063bcb68;p=mesa.git

gallium/docs: Document the OS module.
---

diff --git a/src/gallium/docs/source/distro.rst b/src/gallium/docs/source/distro.rst
index 0ef9fe2645c..0fabb639ad3 100644
--- a/src/gallium/docs/source/distro.rst
+++ b/src/gallium/docs/source/distro.rst
@@ -103,6 +103,22 @@ Xorg XFree86 DDX
 Auxiliary
 ---------
 
+OS
+^^
+
+The OS module contains the abstractions for basic operating system services:
+
+* memory allocation
+* simple message logging
+* obtaining run-time configuration option
+* threading primitives
+
+This is the bare minimum required to port Gallium to a new platform.
+
+The OS module already provides the implementations of these abstractions for
+the most common platforms.  When targeting an embedded platform no
+implementation will be provided -- these must be provided separately.
+
 CSO Cache
 ^^^^^^^^^