Changeset 421a287 for doc/user

Timestamp:

Jun 2, 2017, 4:59:26 PM (7 years ago)

Author:

Peter A. Buhr <pabuhr@…>

Branches:

ADT, aaron-thesis, arm-eh, ast-experimental, cleanup-dtors, deferred_resn, demangler, enum, forall-pointer-decay, jacob/cs343-translation, jenkins-sandbox, master, new-ast, new-ast-unique-expr, new-env, no_list, persistent-indexer, pthread-emulation, qualifiedEnum, resolv-new, with_gc

Children:

a4683611

Parents:

83e9bd3

Message:

update allocation documentation

File:

• doc/user/user.tex (modified) (4 diffs)

doc/user/user.tex

@@ -11 +11 @@
 %% Created On       : Wed Apr  6 14:53:29 2016
 %% Last Modified By : Peter A. Buhr
-%% Last Modified On : Thu Jun  1 22:46:09 2017
-%% Update Count     : 2126
+%% Last Modified On : Fri Jun  2 10:07:51 2017
+%% Update Count     : 2128
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -185 +185 @@
 While the \CFA I/O looks similar to the \Index*[C++]{\CC{}} output style, there are important differences, such as automatic spacing between variables as in \Index*{Python} (see~\VRef{s:IOLibrary}).
 
-This document is a user manual for the \CFA programming language, targeted at \CFA programmers.
+This document is a programmer reference-manual for the \CFA programming language.
+The manual covers the core features of the language and runtime-system, with simple examples illustrating syntax and semantics of each feature.
+The manual does not teach programming, i.e., how to combine the new constructs to build complex programs.
+A reader should already have an intermediate knowledge of control flow, data structures, and concurrency issues to understand the ideas presented as well as some experience programming in C/\CC.
 Implementers may refer to the \CFA Programming Language Specification for details about the language syntax and semantics.
-In its current state, this document covers the intended core features of the language.
 Changes to the syntax and additional features are expected to be included in later revisions.
 
@@ -5273 +5275 @@
 \begin{cfa}[aboveskip=0pt,belowskip=0pt]
 // C unsafe allocation
-extern "C" { void * mallac( size_t size ); }§\indexc{memset}§
-extern "C" { void * calloc( size_t dim, size_t size ); }§\indexc{calloc}§
-extern "C" { void * realloc( void * ptr, size_t size ); }§\indexc{realloc}§
-extern "C" { void * memalign( size_t align, size_t size ); }§\indexc{memalign}§
-extern "C" { int posix_memalign( void ** ptr, size_t align, size_t size ); }§\indexc{posix_memalign}§
+extern "C" {
+void * mallac( size_t size );§\indexc{memset}§
+void * calloc( size_t dim, size_t size );§\indexc{calloc}§
+void * realloc( void * ptr, size_t size );§\indexc{realloc}§
+void * memalign( size_t align, size_t size );§\indexc{memalign}§
+int posix_memalign( void ** ptr, size_t align, size_t size );§\indexc{posix_memalign}§
+}
 
 // §\CFA§ safe equivalents, i.e., implicit size specification
@@ -5302 +5306 @@
 
 // C unsafe initialization/copy
-extern "C" { void * memset( void * dest, int c, size_t size ); }
-extern "C" { void * memcpy( void * dest, const void * src, size_t size ); }
+extern "C" {
+void * memset( void * dest, int c, size_t size );
+void * memcpy( void * dest, const void * src, size_t size );
+}
 
 // §\CFA§ safe initialization/copy