X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/558e70ee837c7456495f5399c7e62504206ea99b..d5fdd49e70b734b791eb907706f92da5775e2a8b:/doc/runtime.tex diff --git a/doc/runtime.tex b/doc/runtime.tex index 4f6d277..83acd31 100644 --- a/doc/runtime.tex +++ b/doc/runtime.tex @@ -43,7 +43,7 @@ calling functions which make use of keyword arguments; see The header file defines two simple structure types, and a function type which will be described later. -\begin{describe}{type}[struct kwval] +\begin{describe}{ty}[struct kwval] {struct kwval \{ \\ \ind const char *kw; \\ const void *val; \-\\ @@ -56,7 +56,7 @@ will be described later. the actual argument type.) \end{describe} -\begin{describe}{type}[struct kwtab] +\begin{describe}{ty}[struct kwtab] {struct kwtab \{ \\ \ind const struct kwval *v; \\ size_t n; \-\\ @@ -528,7 +528,7 @@ call @|kw_unknown|. message to the standard error stream and calls \man{abort}{3}. \end{describe} -\begin{describe}{type}[kw_unkhookfn] +\begin{describe}{ty}[kw_unkhookfn] {typedef void kw_unkhookfn(const char *@, const char *@);} The @|kw_unkhookfn| type is the type of unknown-keyword handler functions. @@ -824,6 +824,10 @@ The following macro constructs an instance with automatic storage duration. instance should be torn down before this happens, using the \descref{fun}{sod_teardown}[function]. It may be appropriate to @|assert| that the object is ready for deallocation at this time. + + By default, this macro will abort the program if the size allocated for the + instance doesn't match the size required by the class object; set + \descref{feat}{SOD_RECKLESS} to inhibit this check. \end{describe} \subsubsection{Dynamic allocation}