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

Adjust docs of few toxencrypt function to the code #592

Merged
merged 1 commit into from
Oct 27, 2017
Merged

Adjust docs of few toxencrypt function to the code #592

merged 1 commit into from
Oct 27, 2017

Conversation

Diadlo
Copy link

@Diadlo Diadlo commented Sep 2, 2017

Add correct information about behaviour if input pointer is NULL

Fix #590


This change is Reviewable

@zoff99
Copy link

zoff99 commented Sep 2, 2017

:lgtm_strong:


Reviewed 1 of 1 files at r1.
Review status: all files reviewed at latest revision, all discussions resolved, some commit checks failed.


Comments from Reviewable

@nurupo
Copy link
Member

nurupo commented Sep 2, 2017

You shouldn't edit toxencryptsave.h directly, you should edit toxencryptsave.api.h and run APIDSL on it and then run astyle on the resulting toxencryptsave.h using toxcore's astyle rules.

@Diadlo
Copy link
Author

Diadlo commented Sep 2, 2017

@nurupo IDK what APIDSL is and how does it works. But I hope, that now it's made correct

@nurupo
Copy link
Member

nurupo commented Sep 3, 2017

APIDSL converts files written in a special c-like language that @iphydf came up with, the goal of the language being improving API consistency, to the C language. E.g. (tox.api.h)[https://github.com/TokTok/c-toxcore/blob/master/toxcore/tox.api.h] gets converted into (tox.h)[https://github.com/TokTok/c-toxcore/blob/master/toxcore/tox.h]. I think the plan is to eventually port all public APIs and also toxcore layers to it. There is also this doc on it, though I remember APIDSL on Heroku being outdated, so it might be better to build the latest version of it locally.

Here are the astyle rules.

There is a tests Travis runs that checks if someone forgot to run astyle or edited a header file without editing the corresponding APIDSL file accordingly, which is why your previous change was failing on Travis.

@nurupo
Copy link
Member

nurupo commented Sep 3, 2017

Hm, actually, the tests still fails, toxencryptsave.h and toxencryptsave.api.h are still out of sync in this PR.

@Diadlo
Copy link
Author

Diadlo commented Sep 3, 2017

Thanks for the links. Fixed

@zoff99
Copy link

zoff99 commented Sep 3, 2017

@nurupo maybe you can add somewhere in the docs that if you compile libsodium with
"--enable-minimal"
then 99,9% of tox works (including all A/V stuff) but only 1 function is missing for toxencryptsave
that one will only be built with the full version of libsodium
(function crypto_pwhash_scryptsalsa208sha256)

@robinlinden robinlinden added this to the v0.1.11 milestone Oct 6, 2017
@robinlinden
Copy link
Member

:lgtm_strong:


Reviewed 1 of 1 files at r1, 1 of 1 files at r2.
Review status: all files reviewed at latest revision, all discussions resolved, some commit checks failed.


Comments from Reviewable

@robinlinden
Copy link
Member

Please enable the checkbox "Allow edits from maintainers." on the bottom right.

@Diadlo
Copy link
Author

Diadlo commented Oct 7, 2017

@robinlinden Done

Add correct information about behaviour if input pointer is NULL

Fix #590
@robinlinden robinlinden merged commit 0542ffa into TokTok:master Oct 27, 2017
This pull request was closed.
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.

4 participants