[Boost-commit] svn:boost r84556 - branches/release/libs/context/doc

Subject: [Boost-commit] svn:boost r84556 - branches/release/libs/context/doc
From: oliver.kowalke_at_[hidden]
Date: 2013-05-30 11:21:49

Author: olli
Date: 2013-05-30 11:21:48 EDT (Thu, 30 May 2013)
New Revision: 84556
URL: http://svn.boost.org/trac/boost/changeset/84556

Log:
context: add hint for make_fcontext() in docu

Text files modified: 
   branches/release/libs/context/doc/fcontext.qbk |     3 ++-                                     
   1 files changed, 2 insertions(+), 1 deletions(-)

Modified: branches/release/libs/context/doc/fcontext.qbk
==============================================================================
--- branches/release/libs/context/doc/fcontext.qbk	(original)
+++ branches/release/libs/context/doc/fcontext.qbk	2013-05-30 11:21:48 EDT (Thu, 30 May 2013)
@@ -239,7 +239,8 @@
 
 [heading `fcontext_t * make_fcontext( void * sp, std::size_t size, void(*fn)(intptr_t))`]
 [variablelist
-[[Precondition:] [Stack `sp` function pointer `fn` are valid and `size` > 0.]]
+[[Precondition:] [Stack `sp` function pointer `fn` are valid (depending on the architecture
+`sp` points to the top or bottom of the stack) and `size` > 0.]]
 [[Effects:] [Creates an fcontext_t at the beginning of the stack and prepares the stack
 to execute the __context_fn__ `fn`.]]
 [[Returns:][Returns a pointer to fcontext_t which is placed on the stack.]]