Skip to content

Commit

Permalink
Correcting spelling errors in utilities.qbk
Browse files Browse the repository at this point in the history
  • Loading branch information
aserio committed Sep 28, 2017
1 parent 3aeb079 commit 4e48fee
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/manual/utilities.qbk
Expand Up @@ -16,7 +16,7 @@ facilies.
A common need of users is to periodically backup an application.
This practice provides resiliency and potential restart points in code.
We have developed the concept of a [^checkpoint] to support this
usecase.
use case.

Found in [^hpx/util/checkpoint.hpp] [^checkpoint]s are defined as
objects which hold a serialized version of an object or set of objects
Expand All @@ -31,10 +31,10 @@ like this:
hpx::future<hpx::util::checkpoint> hpx::util::save_checkpoint(a, b, c, ...);
```

[^save_checkpoint] takes arbitrary data containters such as int,
[^save_checkpoint] takes arbitrary data containers such as int,
double, float, vector, and future and serializes them into a newly
created [^checkpoint] object. This function returns a [^future] to a
[^checkpoint] containing the data. Let us look a simple usecase
[^checkpoint] containing the data. Let us look a simple use case
below:

```
Expand All @@ -59,7 +59,7 @@ Sometimes [^checkpoint]s must be declared before they are used.
[^save_checkpoint] allows users to move pre-created [^checkpoint]s into
the function as long as they are the first container passing into the
function (In the case where a launch policy is used the [^checkpoint]
will immediatly follow the launch policy). An example of these features
will immediately follow the launch policy). An example of these features
can be found below:

[import ../../tests/unit/util/checkpoint.cpp]
Expand All @@ -75,15 +75,15 @@ below:

[check_test_2]

[h2 Writing to a File]
[h2 Checkpoint I/O]

The core utility of [^checkpoint] is in its ability to make certain
data persistent. Often this means that the data is needed to be
stored in an object, such as a file, for later use.
For these cases we have provided two solutions: stream
operator overloads and access iterators.

We have created the two stream overleads
We have created the two stream overloads
[^operator<<] and [^operator>>] to stream data
out of and into [^checkpoint]. You can see an
example of the overloads in use below:
Expand All @@ -93,7 +93,7 @@ example of the overloads in use below:
This is the primary way to move data into and out of [^checkpoint]s
which expose stream operators. It is important to note, however,
a feature of these functions. Both [^operator<<] and [^operator>>]
rely on a [^.write()] and a [^.read()] funtion respectively.
rely on a [^.write()] and a [^.read()] function respectively.
In order to know how much data to read from the [^std::istream],
the [^operator<<] will write the size of the [^checkpoint] before writing
the [^checkpoint] data. Correspondingly, the [^operator>>] will
Expand All @@ -108,7 +108,7 @@ overloads she should be aware of this hazardous attribute!
[important Be careful when mixing [^operator<<] and [^operator>>]
with other facilities to read and write to a [^checkpoint].
[^operator<<] writes and extra variable and
[^operator>>] reads this variable back separatly.
[^operator>>] reads this variable back separately.
Used together the user will not see this and therefore can ignore
this detail. However if the user tries to read or write
using another method and then tries to stream that data
Expand All @@ -117,7 +117,7 @@ overloads she should be aware of this hazardous attribute!

Users may also move the data into and out of a [^checkpoint]
using the exposed [^.begin()] and [^.end()] iterators.
An example of this usecase is illustrated below.
An example of this use case is illustrated below.

[check_test_4]

Expand Down

0 comments on commit 4e48fee

Please sign in to comment.