|
|
Boost-Commit : |
From: bdawes_at_[hidden]
Date: 2007-11-12 10:03:07
Author: bemandawes
Date: 2007-11-12 10:03:06 EST (Mon, 12 Nov 2007)
New Revision: 41031
URL: http://svn.boost.org/trac/boost/changeset/41031
Log:
Docs: Add system-specific headers text, links. Add table of macros.
Text files modified:
branches/system/libs/system/doc/index.html | 22 +++++++++++++++++
branches/system/libs/system/doc/reference.html | 48 ++++++++++++++++++++++++++++++++++++++-
2 files changed, 67 insertions(+), 3 deletions(-)
Modified: branches/system/libs/system/doc/index.html
==============================================================================
--- branches/system/libs/system/doc/index.html (original)
+++ branches/system/libs/system/doc/index.html 2007-11-12 10:03:06 EST (Mon, 12 Nov 2007)
@@ -43,6 +43,22 @@
<a href="#Acknowledgements">Acknowledgements</a>
</td>
</tr>
+ <tr>
+ <td width="100%" bgcolor="#D7EEFF" align="center">
+ <b><i>Headers</i></b></td>
+ </tr>
+ <tr>
+ <td width="100%" bgcolor="#E8F5FF">
+ <boost/system/error_code.hpp><br>
+ <a href="reference.html#Header-system_error">
+ <boost/system/system_error.hpp></a><br>
+ <a href="../../../boost/system/cygwin_error.hpp">
+ <boost/system/cygwin_error.hpp></a><br>
+ <a href="../../../boost/system/linux_error.hpp">
+ <boost/system/linux_error.hpp></a><br>
+ <a href="../../../boost/system/windows_error.hpp">
+ <boost/system/windows_error.hpp></a></td>
+ </tr>
</table>
<h2><a name="Introduction">Introduction</a></h2>
@@ -73,6 +89,10 @@
occurrences and must be dealt with as they arise, programs become littered with
try/catch blocks, unreadable, and very inefficient. The Boost System library
supports both error reporting by exception and by error code.</p>
+<p>In addition to portable errors codes and conditions supported by the <code>
+error_code.hpp</code> header, system-specific headers support the Cygwin, Linux,
+and Windows platforms. These headers are effectively no-ops if included for
+platforms other than their intended target.</p>
<h2><a name="Design_Rationale">Design Rationale</a></h2>
<p>Class <code>error_code</code> and <code>error_condition</code> are designed as a value types so
they can be copied
@@ -117,7 +137,7 @@
<a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a></p>
<p>Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->September 14, 2007<!--webbot bot="Timestamp" endspan i-checksum="37985" --> </font>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->November 12, 2007<!--webbot bot="Timestamp" endspan i-checksum="39581" --> </font>
</p>
</body>
Modified: branches/system/libs/system/doc/reference.html
==============================================================================
--- branches/system/libs/system/doc/reference.html (original)
+++ branches/system/libs/system/doc/reference.html 2007-11-12 10:03:06 EST (Mon, 12 Nov 2007)
@@ -38,6 +38,7 @@
<tr>
<td width="100%" bgcolor="#E8F5FF">
<a href="#Introduction">Introduction</a><br>
+ Macros<br>
<a href="#Header-error_code">Header <boost/system/error_code.hpp></a><br>
<a href="#Class-error_category">Class <code>error_category</code></a><br>
Class error_category synopsis<br>
@@ -68,8 +69,51 @@
<p>This reference documentation describes components that
programs may use to report error conditions originating from the operating
system or other low-level application program interfaces.</p>
-<p>System Library components do not change the value of <code>
+<p>Boost.System library components never change the value of <code>
errno</code>.</p>
+<h2><a name="Macros">Macros</a></h2>
+<p>Users may defined the following macros if desired. Sensible defaults are
+provided, so users may ignore these macros if they prefer.</p>
+<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111">
+ <tr>
+ <td><b><i>Macro Name</i></b></td>
+ <td><b><i>Default</i></b></td>
+ <td><b><i>Effect if defined</i></b></td>
+ </tr>
+ <tr>
+ <td valign="top"><code>BOOST_WINDOWS_API</code></td>
+ <td valign="top">Defined if Windows is detected by Boost.System's automatic configuration
+ code, otherwise not defined.</td>
+ <td valign="top">Implementation uses the Microsoft Windows native
+ application program interface (API).</td>
+ </tr>
+ <tr>
+ <td valign="top"><code>BOOST_POSIX_API</code></td>
+ <td valign="top">Defined if Windows is not detected by Boost.System's automatic configuration
+ code.</td>
+ <td valign="top">Implementation uses the POSIX native
+ application program interface (API).</td>
+ </tr>
+ <tr>
+ <td valign="top"><code>BOOST_SYSTEM_DYN_LINK</code></td>
+ <td valign="top">Defined if <code>BOOST_ALL_DYN_LINK</code> is defined,
+ otherwise not defined.</td>
+ <td valign="top">Boost.System library is dynamically linked. If not defined,
+ static linking is assumed.</td>
+ </tr>
+ <tr>
+ <td valign="top"><code>BOOST_SYSTEM_NO_LIB</code></td>
+ <td valign="top">Defined if <code>BOOST_ALL_NO_LIB</code> is defined,
+ otherwise not defined.</td>
+ <td valign="top">Boost.System library does not use the Boost auto-link
+ facility.</td>
+ </tr>
+ <tr>
+ <td valign="top"><code>BOOST_SYSTEM_NO_DEPRECATED</code></td>
+ <td valign="top">Not defined.</td>
+ <td valign="top">Deprecated features are excluded.</td>
+ </tr>
+</table>
<h2><a name="Header-error_code">Header <boost/system/error_code.hpp></a></h2>
<h3><boost/system/error_code.hpp> synopsis</h3>
<blockquote>
@@ -699,7 +743,7 @@
<a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a></p>
<p>Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->October 23, 2007<!--webbot bot="Timestamp" endspan i-checksum="30853" --> </font>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->November 12, 2007<!--webbot bot="Timestamp" endspan i-checksum="39581" --> </font>
</p>
</body>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk