From 2a4584a4131943a3c564a9cf5dca5d3acae4f53e Mon Sep 17 00:00:00 2001 From: Beman Date: Mon, 26 Jan 2015 09:16:41 -0500 Subject: [PATCH] Add recommendation to protect against assignment ills, with example. --- doc/arithmetic.html | 9 +++++++-- doc/buffers.html | 7 ++++++- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/doc/arithmetic.html b/doc/arithmetic.html index 2d72bd3..0383fad 100644 --- a/doc/arithmetic.html +++ b/doc/arithmetic.html @@ -346,7 +346,12 @@ Code that uses aligned types is possibly non-portable because alignment requirements vary between hardware architectures and because alignment may be affected by compiler switches or pragmas. For example, alignment of an 64-bit integer may be to a 32-bit boundary on a 32-bit machine. Furthermore, aligned types -are only available on architectures with 16, 32, and 64-bit integer types.

+are only available on architectures with 16, 32, and 64-bit integer types.

+

Recommendation: Protect yourself against alignment ills. For +example:

+
+ 
static_assert(sizeof(containing_struct) == 12, "sizeof(containing_struct) is wrong");
+

Note: One-byte types have identical functionality. They are provided to improve code readability and searchability.

@@ -677,7 +682,7 @@ differs from endian representation size. Vicente Botet and other reviewers suggested supporting floating point types.

Last revised: -19 January, 2015

+25 January, 2015

© Copyright Beman Dawes, 2006-2009, 2013

Distributed under the Boost Software License, Version 1.0. See www.boost.org/ LICENSE_1_0.txt

diff --git a/doc/buffers.html b/doc/buffers.html index 594b941..a424dd0 100644 --- a/doc/buffers.html +++ b/doc/buffers.html @@ -334,6 +334,11 @@ requirements vary between hardware architectures and because alignment may be affected by compiler switches or pragmas. For example, alignment of an 64-bit integer may be to a 32-bit boundary on a 32-bit machine. Furthermore, aligned types are only available on architectures with 16, 32, and 64-bit integer types.

+

Recommendation: Protect yourself against alignment ills. For +example:

+
+ 
static_assert(sizeof(containing_struct) == 12, "sizeof(containing_struct) is wrong");
+

Note: One-byte big and little buffer types have identical functionality. They are provided to improve code readability and searchability.

@@ -650,7 +655,7 @@ any Boost object libraries.

Last revised: -19 January, 2015

+25 January, 2015

© Copyright Beman Dawes, 2006-2009, 2013

Distributed under the Boost Software License, Version 1.0. See www.boost.org/ LICENSE_1_0.txt