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 outdated #11

Open
aidantwoods opened this issue Jul 31, 2017 · 4 comments
Open

Docs outdated #11

aidantwoods opened this issue Jul 31, 2017 · 4 comments

Comments

@aidantwoods
Copy link
Contributor

If you run pecl install libsodium (as currently recommended in the install guide in the docs) then you'll get libsodium 2.x which is BC breaking with 1.x. Extension is also now called sodium.so[1] and all the functions are in the global namespace[2] (so e.g. the version verification script in the docs does not work, as it uses \Sodium\... instead of the global namespace).

Not sure if you want to rewrite the docs for 2.x, or include a version constraint in the pecl install (1.x is stated not to receive any more updates[3], so former likely preferable).

References:
[1], [2], [3]: https://github.com/jedisct1/libsodium-php/blob/4e668284deaff4243c7ef36025525f44bbeb8078/README.md

@paragonie-scott
Copy link
Member

I'm not sure what I want to do here either. The whole politics of PHP internals has kind of made a mess of things.

@jedisct1
Copy link

jedisct1 commented Aug 2, 2017

I don't really have time to maintain the 1.x branch, the 2.x branch, and the php-src versions either.

Indeed, the breaking changes required by PHP internals resulted in quite of a mess.

We can write wrappers between the original and the PHP-internals API (actually someone already did that a while back), but it will be yet another thing to maintain.

As much as I don't like the new API, it's too late, I think we don't have any options, but adopt it.

@Arteneko
Copy link

Arteneko commented Aug 3, 2017

Will there be any sodium documentation in the close time ? Or should we keep relying on the old v1.x extension releases (by manually building/installing them) for now ?

@paragonie-scott
Copy link
Member

The documentation has been updated. I'm going to go through it today and make sure it's adequately clean/readable before I tag/sign a release.

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

No branches or pull requests

4 participants