From bfd00f12d15fb8b22388d9b43247d98b600727bb Mon Sep 17 00:00:00 2001 From: jpekkila Date: Thu, 12 Sep 2019 16:39:26 +0000 Subject: [PATCH 1/2] API_specification_and_user_manual.md edited online with Bitbucket. Syntax fixes. --- .../API_specification_and_user_manual.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md b/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md index a928d44..45e5930 100644 --- a/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md +++ b/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md @@ -1,4 +1,4 @@ -# Astaroth specification and user manual +a# Astaroth specification and user manual Copyright (C) 2014-2019, Johannes Pekkila, Miikka Vaisala. @@ -227,7 +227,7 @@ Synchronization is done using `Stream` primitives, defined as ```C typedef enum { STREAM_DEFAULT, STREAM_0, ..., STREAM_16, NUM_STREAMS } Stream; #define STREAM_ALL (NUM_STREAMS) -```. +``` Functions queued in the same stream will be executed sequentially. If two or more consequent functions are queued in different streams, then these functions may execute in parallel. Finally, @@ -276,8 +276,7 @@ Since we allow the user to operate on subsets of the computational domain in use AcResult acDeviceSwapBuffers(const Device device); AcResult acNodeSwapBuffers(const Node node); ``` -> All functions provided with the API operate on input buffers and ensure that the complete result -is available in the input buffer when the function has completed. User-specified kernels are exceptions and write the result to output buffers. Therefore buffers have to be swapped only after calling user-specified kernels. +> **NOTE**: All functions provided with the API operate on input buffers and ensure that the complete result is available in the input buffer when the function has completed. User-specified kernels are exceptions and write the result to output buffers. Therefore buffers have to be swapped only after calling user-specified kernels. ## Devices From e351902dc0c2f527b286e94a8bf6496f78f36c8e Mon Sep 17 00:00:00 2001 From: jpekkila Date: Thu, 12 Sep 2019 16:41:11 +0000 Subject: [PATCH 2/2] Fixed a failed fix. --- .../API_specification_and_user_manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md b/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md index 45e5930..4ee06dc 100644 --- a/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md +++ b/doc/Astaroth_API_specification_and_user_manual/API_specification_and_user_manual.md @@ -1,4 +1,4 @@ -a# Astaroth specification and user manual +# Astaroth specification and user manual Copyright (C) 2014-2019, Johannes Pekkila, Miikka Vaisala.