Skip to content

Commit

Permalink
Merge pull request #132 from frgm/master
Browse files Browse the repository at this point in the history
sophia: documentation: get rid of all wrong 'an'
  • Loading branch information
pmwkaa committed Aug 1, 2016
2 parents d5fa6d8 + e823c9e commit 028a291
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion documentation/admin/ram.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ sp_setint(env, "db.test.mmap", 1);
```
It is a good idea to try this mode, even if your dataset is rather small or you need to handle
a large ratio of read request with an predictable pattern.
a large ratio of read request with a predictable pattern.
Disadvantage of mmap mode, in comparison to RAM Storage, is a possible unpredictable
latency behaviour and a OS cache warmup period after recovery.
2 changes: 1 addition & 1 deletion documentation/api/sp_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sp\_delete(**transaction**, document): do a key deletion as a part of multi-stat
As a part of a transactional statement a key-value document must be prepared using
[sp\_document()](../api/sp_document.md) method. First argument of [sp\_document()](../api/sp_document.md)
method must be an database object.
method must be a database object.
Object must be prepared by setting **key** fields. Value is not used for delete operation.
It is important that while setting **key** fields, only pointers are copied. Real
Expand Down
2 changes: 1 addition & 1 deletion documentation/api/sp_drop.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

**NAME**

sp\_drop - schedule an database drop or an object deletion
sp\_drop - schedule a database drop or an object deletion

**SYNOPSIS**

Expand Down
2 changes: 1 addition & 1 deletion documentation/api/sp_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sp\_get(**database**, document): do a single-statement transaction read.
sp\_get(**transaction**, document): do a key search as a part of multi-statement transaction visibility.
[sp_get()](sp_get.md) method returns an document that is semantically equal to
[sp_get()](sp_get.md) method returns a document that is semantically equal to
[sp_document()](sp_document.md), but is read-only.
For additional information take a look at [sp\_begin()](sp_begin.md)
Expand Down
4 changes: 2 additions & 2 deletions documentation/api/sp_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ sp\_set(**transaction**, document): do a key update as a part of multi-statement
As a part of a transactional statement a key-value document must be prepared using
[sp\_document()](../api/sp_document.md) method. First argument of [sp\_document()](../api/sp_document.md)
method must be an database object.
method must be a database object.
Object must be prepared by setting **key** and **value** fields, where value is optional.
It is important that while setting **key** and **value** fields, only pointers are copied. Real
Expand All @@ -34,7 +34,7 @@ and [Transactions](../crud/transactions.md).
char key[] = "key";
void *o = sp_document(db);
sp_setstring(o, "key", key, sizeof(key));
sp_setstring(o, "value", "hello world", 0));
sp_setstring(o, "value", "hello world", 0);
sp_set(db, o);
```

Expand Down
2 changes: 1 addition & 1 deletion documentation/api/sp_upsert.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ sp\_upsert(**transaction**, document): do a key update as a part of multi-statem
As a part of a transactional statement a key-value document must be prepared using
[sp\_document()](../api/sp_document.md) method. First argument of [sp\_document()](../api/sp_document.md)
method must be an database object.
method must be a database object.
Object must be prepared by setting **key** and **value** fields.
It is important that while setting **key** and **value** fields, only pointers are copied. Real
Expand Down
2 changes: 1 addition & 1 deletion example/transaction.c
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ int main(int argc, char *argv[])
*
* The only difference between crud.c is that
* first argument to sp_set(), sp_get() and sp_delete() is
* an transaction object (not database).
* a transaction object (not database).
*/

/* open or create environment and database */
Expand Down
8 changes: 4 additions & 4 deletions sophia/std/ss_lz4filter.c
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ size_t LZ4F_getFrameInfo(LZ4F_decompressionContext_t ctx,
* LZ4F_getFrameInfo() can also be used *after* starting decompression, on a valid LZ4F_decompressionContext_t.
* The number of bytes read from srcBuffer will be provided within *srcSizePtr (necessarily <= original value).
* You are expected to resume decompression from where it stopped (srcBuffer + *srcSizePtr)
* The function result is an hint of how many srcSize bytes LZ4F_decompress() expects for next call,
* The function result is a hint of how many srcSize bytes LZ4F_decompress() expects for next call,
* or an error code which can be tested using LZ4F_isError().
*/

Expand All @@ -301,7 +301,7 @@ size_t LZ4F_decompress(LZ4F_decompressionContext_t ctx,
* dstBuffer is supposed to be flushed between each call to the function, since its content will be overwritten.
* dst arguments can be changed at will with each consecutive call to the function.
*
* The function result is an hint of how many srcSize bytes LZ4F_decompress() expects for next call.
* The function result is a hint of how many srcSize bytes LZ4F_decompress() expects for next call.
* Schematically, it's the size of the current (or remaining) compressed block + header of next block.
* Respecting the hint provides some boost to performance, since it does skip intermediate buffers.
* This is just a hint, you can always provide any srcSize you want.
Expand Down Expand Up @@ -4660,7 +4660,7 @@ static size_t LZ4F_decodeHeader(LZ4F_dctx_internal_t* dctxPtr, const void* srcVo
* LZ4F_getFrameInfo() can also be used *after* starting decompression, on a valid LZ4F_decompressionContext_t.
* The number of bytes read from srcBuffer will be provided within *srcSizePtr (necessarily <= original value).
* You are expected to resume decompression from where it stopped (srcBuffer + *srcSizePtr)
* The function result is an hint of the better srcSize to use for next call to LZ4F_decompress,
* The function result is a hint of the better srcSize to use for next call to LZ4F_decompress,
* or an error code which can be tested using LZ4F_isError().
*/
LZ4F_errorCode_t LZ4F_getFrameInfo(LZ4F_decompressionContext_t decompressionContext, LZ4F_frameInfo_t* frameInfoPtr, const void* srcBuffer, size_t* srcSizePtr)
Expand Down Expand Up @@ -4768,7 +4768,7 @@ static void LZ4F_updateDict(LZ4F_dctx_internal_t* dctxPtr, const BYTE* dstPtr, s
* If the number of bytes read is < number of bytes provided, then the decompression operation is not complete.
* You will have to call it again, continuing from where it stopped.
*
* The function result is an hint of the better srcSize to use for next call to LZ4F_decompress.
* The function result is a hint of the better srcSize to use for next call to LZ4F_decompress.
* Basically, it's the size of the current (or remaining) compressed block + header of next block.
* Respecting the hint provides some boost to performance, since it allows less buffer shuffling.
* Note that this is just a hint, you can always provide any srcSize you want.
Expand Down

0 comments on commit 028a291

Please sign in to comment.