Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix grammar #135

Merged
merged 1 commit into from Aug 7, 2016
Merged

docs: fix grammar #135

merged 1 commit into from Aug 7, 2016

Conversation

ghost
Copy link

@ghost ghost commented Aug 1, 2016

No description provided.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.02%) to 90.713% when pulling 48ff662 on frgm:master into 028a291 on pmwkaa:master.

@ghost
Copy link
Author

ghost commented Aug 1, 2016

++
documentation/admin/snapshot.md:

/* take snapshot every 10 minutes */
sp_setint(env, "compaction.0.snapshot_period", 360);

360 / 60 = 6


documentation/crud/cursors.md:

Second and futher sp_get() calls must using previously get object to continue iteration.

is it correct sentence?


documentation/conf/sophia.md:

Get last error description.

How about to replace it with "Get description of the last error"?


documentation/conf/scheduler.md:
What's the difference between function and pointer types?

@ghost
Copy link
Author

ghost commented Aug 1, 2016

+++ sp_setstring():

What does int size argument mean?

if it is 0, it calculates string size by strlen() or alike function ..?
But how to set up an empty string without that calculation..

if it is a size of string, then why is there such code:

char key[] = "key";
sp_setstring(o, "key", key, sizeof(key));

there should be sizeof(key) - 1
as sizeof(key) gives 4

Probably zero keys are bad idea. This is done mostly to simplify configuration. By default all fields are not initialized (unset). So basically, if we zero values we should not set them. This might be confusing.

Yes. You right about example, yet it will work if every key will be zero terminated in the example.

@pmwkaa
Copy link
Owner

pmwkaa commented Aug 2, 2016

++
documentation/admin/snapshot.md:

/* take snapshot every 10 minutes */
sp_setint(env, "compaction.0.snapshot_period", 360);

Yes, that is incorrect. It should be 600 at least or 0. Snapshots are turned off in upcoming v2.2 by default.


documentation/crud/cursors.md:

Second and futher sp_get() calls must using previously get object to continue iteration.

is it correct sentence?

Second and futher sp_get() calls must use previously allocated result object to continue iteration.


documentation/conf/sophia.md:

Get last error description.

How about to replace it with "Get description of the last error"?
Yes, that's better.


documentation/conf/scheduler.md:
What's the difference between function and pointer types?

It is mostly semantical. We can do sp_setstring() (or getstring) on function type field and expect that it will be executed.

@ghost
Copy link
Author

ghost commented Aug 2, 2016

++++
I'm wondering, why do sp_setstring() and sp_getstring() accept
int not unsigned int or just size_t?

@pmwkaa
Copy link
Owner

pmwkaa commented Aug 7, 2016

++++
I'm wondering, why do sp_setstring() and sp_getstring() accept
int not unsigned int or just size_t?

This mostly made for simplicity, eg. FFI support.

@pmwkaa pmwkaa merged commit 5e69f35 into pmwkaa:master Aug 7, 2016
@ghost
Copy link
Author

ghost commented Aug 7, 2016

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants