[Boost-commit] svn:boost r63745 - in sandbox/SOC/2010/bit_masks/lib/integer/doc: . bit_mask_doc/overview

Subject: [Boost-commit] svn:boost r63745 - in sandbox/SOC/2010/bit_masks/lib/integer/doc: . bit_mask_doc/overview
From: bbartmanboost_at_[hidden]
Date: 2010-07-08 08:55:57

Author: bbartman
Date: 2010-07-08 08:55:56 EDT (Thu, 08 Jul 2010)
New Revision: 63745
URL: http://svn.boost.org/trac/boost/changeset/63745

Log:
removed old section
Text files modified: 
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask_doc/overview/rationale.qbk |    40 ++++++++++++++++++++++++++++++++++++++++
   sandbox/SOC/2010/bit_masks/lib/integer/doc/rationale.qbk                       |    32 --------------------------------        
   2 files changed, 40 insertions(+), 32 deletions(-)

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask_doc/overview/rationale.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask_doc/overview/rationale.qbk	(original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask_doc/overview/rationale.qbk	2010-07-08 08:55:56 EDT (Thu, 08 Jul 2010)
@@ -6,4 +6,44 @@
 ]
 
 [section rationale]
+The motivation for the creation of a structure for creating bit masks on compile
+time. Bit masks are usually create using hexadecimal characters or by using
+macros. In either case the readability of the clarity of the bit masks are
+obscured and often the mask it self is not readible. This extension will also 
+allow the users to work with endianness at an abstract level.
+
+[/
+The motivation and rationale behind the creation a bit masking library stems
+from the following example:
+``
+struct foo {
+    bool b1:1;
+    bool b2:1;
+    int i1:2;
+    int i2:2;
+};
+``
+The struct `foo` is composed of bit fields. This is fine and wouldn't be a big
+issues accept that there is something which the user can't see that can cause
+problems with this struct. The size of struct `foo` need not be any larger then
+`char`, 1 byte, which is the smalles type which can hold it. Now the actual size
+of `foo` is 4 bytes. This can cause havoc if a union was made with this type and
+a char while the user was thinking that their type is 1 byte in size. So in order
+to create something which could handle this situation correctly. This library
+was created to help with the internal management and storage bit fields and
+non-standardly aligned data. The goal is to provide both masking utilities and
+commonlly used structures which would be able to correct the size of the
+structure and provide simple accessors to the data stored within.
+
+[h3 Project Data Structure Motivation and Rationale]
+There are several data structures provided which make doing some slightly more
+complex tasks simple and organized. The structures which the library provides
+are `bit_mask_group`, `bit_mask_tuple`, `bit_field_tuple` and 
+`pointer_plus_bits`.
+
+
+`bit_mask_group` is not a container it doesn't store any data however it
+provides a way of organizing your masks. The structure also provides additional
+run time support on top of its tuple style interface.
+]
 [endsect]

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/rationale.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/rationale.qbk	(original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/rationale.qbk	2010-07-08 08:55:56 EDT (Thu, 08 Jul 2010)
@@ -6,38 +6,6 @@
 ]
 
 [section:rationale Rationale And Motivation]
-The motivation and rationale behind the creation a bit masking library stems
-from the following example:
-``
-struct foo {
-    bool b1:1;
-    bool b2:1;
-    int i1:2;
-    int i2:2;
-};
-``
-The struct `foo` is composed of bit fields. This is fine and wouldn't be a big
-issues accept that there is something which the user can't see that can cause
-problems with this struct. The size of struct `foo` need not be any larger then
-`char`, 1 byte, which is the smalles type which can hold it. Now the actual size
-of `foo` is 4 bytes. This can cause havoc if a union was made with this type and
-a char while the user was thinking that their type is 1 byte in size. So in order
-to create something which could handle this situation correctly. This library
-was created to help with the internal management and storage bit fields and
-non-standardly aligned data. The goal is to provide both masking utilities and
-commonlly used structures which would be able to correct the size of the
-structure and provide simple accessors to the data stored within.
-
-[h3 Project Data Structure Motivation and Rationale]
-There are several data structures provided which make doing some slightly more
-complex tasks simple and organized. The structures which the library provides
-are `bit_mask_group`, `bit_mask_tuple`, `bit_field_tuple` and 
-`pointer_plus_bits`.
-
-
-`bit_mask_group` is not a container it doesn't store any data however it
-provides a way of organizing your masks. The structure also provides additional
-run time support on top of its tuple style interface.
 
 [endsect]