Skip to content

Commit 58c08ea

Browse files
committed
Revert "Fix the documentation"
This reverts commit dfc8cea.
1 parent da3a7e9 commit 58c08ea

File tree

2 files changed

+0
-13
lines changed

2 files changed

+0
-13
lines changed

docs/source/details/mpi.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Functionality Behavior Description
3030
``::resetDataset`` [1]_ [2]_ *backend-specific* declare, write
3131
``::makeConstant`` [3]_ *backend-specific* declare, write
3232
``::storeChunk`` [1]_ independent write
33-
``::storeChunk`` [5]_ collective Span-based overloads
3433
``::loadChunk`` independent read
3534
``::availableChunks`` [4]_ collective read, immediate result
3635
============================ ================== ================================
@@ -50,8 +49,6 @@ Functionality Behavior Description
5049
.. [4] We usually open iterations delayed on first access. This first access is usually the ``flush()`` call after a ``storeChunk``/``loadChunk`` operation. If the first access is non-collective, an explicit, collective ``Iteration::open()`` can be used to have the files already open.
5150
Alternatively, iterations might be accessed for the first time by immediate operations such as ``::availableChunks()``.
5251
53-
.. [5] The Span-based ``storeChunk`` API calls return a backend-allocated pointer, requiring flush operations. These API calls hence inherit the collective properties of flushing. Use store calls with zero-size extent if a rank does not contribute anything.
54-
5552
.. warning::
5653

5754
The openPMD-api will by default flush only those Iterations which are dirty, i.e. have been written to.

include/openPMD/RecordComponent.hpp

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -406,11 +406,6 @@ class RecordComponent : public BaseRecordComponent
406406
* @brief Overload of storeChunk() that lets the openPMD API allocate
407407
* a buffer.
408408
*
409-
* Collective call: Unlike most other storeChunk() calls, this call returns
410-
* pointers allocated by the IO backends and hence inherits the collective
411-
* properties of flushing. Apply zero-extent storeChunk() calls from ranks
412-
* that do not contribute anything.
413-
*
414409
* This may save memory if the openPMD backend in use is able to provide
415410
* users a view into its own buffers, avoiding the need to allocate
416411
* a new buffer.
@@ -447,11 +442,6 @@ class RecordComponent : public BaseRecordComponent
447442
/**
448443
* Overload of span-based storeChunk() that uses operator new() to create
449444
* a buffer.
450-
*
451-
* Collective call: Unlike most other storeChunk() calls, this call returns
452-
* pointers allocated by the IO backends and hence inherits the collective
453-
* properties of flushing. Apply zero-extent storeChunk() calls from ranks
454-
* that do not contribute anything.
455445
*/
456446
template <typename T>
457447
DynamicMemoryView<T> storeChunk(Offset, Extent);

0 commit comments

Comments
 (0)