Skip to content

Fix PHP requirement in installation documentation #3198

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

Closed
wants to merge 5 commits into from
Closed

Fix PHP requirement in installation documentation #3198

wants to merge 5 commits into from

Conversation

gnutix
Copy link

@gnutix gnutix commented Nov 17, 2013

Changed minimal PHP requirement from 5.3.8 to 5.3.3, as it's the version required in composer for symfony/symfony. If 5.3.8 (or higher) is the recommended one, I'll suggest to add a comment about it.

Changed minimal PHP requirement from 5.3.8 to 5.3.3, as it's the version required in composer for symfony/symfony. If 5.3.8 (or higher) is the recommended one, I'll suggest to add a comment about it.
@wouterj
Copy link
Member

wouterj commented Nov 17, 2013

I'm against updating it to 5.3.3. From the readme:

Be warned that PHP versions before 5.3.8 are known to be buggy and might not work for you:

However, we can maybe rephrase this a bit to make it clear that you can also use it with 5.3.3 and then link to this section in the readme. Could you please do that?

@gnutix
Copy link
Author

gnutix commented Nov 17, 2013

@wouterj Thanks for the input, that's what I thought too. Is it better now ? If yes, I'll apply it to the other translations as well (at least for French, and ask an Italian speaker for some help :)).

I don't know the syntax enough to add a link on "highly recommended" to the exact section of the README. Could you help on that ?

@garak
Copy link
Contributor

garak commented Nov 17, 2013

+1 for "5.3 with 5.8 warning".
I think also this page should be adapted http://symfony.com/doc/current/reference/requirements.html

@wouterj
Copy link
Member

wouterj commented Nov 17, 2013

@gnutix I think it's better to put the link + caution in the reference/requirements article. This keeps the book article short and not full of lots of side information.

I think the best way is to add a caution directive at the bottom of the 'Required' section on that page. It'll look like:

.. caution::

    Be aware that Symfony2 has some known limitations when using PHP 5.3.8
    or below. For more information see the `Requirements section of the readme`_

.. _`Requirements section of the readme`: https://github.com/symfony/symfony#requirements

The last line should be put on the bottom of the file.

@gnutix
Copy link
Author

gnutix commented Nov 17, 2013

@wouterj done. I'm hesitating if that "caution" block should be on the bottom on the requirements page or bottom of the requirements section. Think it's more visible on the section, as PHP is listed in there. WDYT?

@wouterj
Copy link
Member

wouterj commented Nov 17, 2013

@gnutix the caution block should be in the section. The last line of my snippet is only telling sphinx to which url the text between backticks in the block should link. It is not displayed. This information should be placed at the bottom of the file.

@gnutix
Copy link
Author

gnutix commented Nov 17, 2013

@wouterj Thanks for the tip! Fixed it. (I should really learn that syntax...)

weaverryan added a commit that referenced this pull request Nov 21, 2013
@weaverryan
Copy link
Member

Hi guys!

I really like what you guys have done here - it's a nice warning and also removes duplication in general. So, great work!

I've patched this into the 2.2. branch at:

and small tweaks at sha: f14ef95

Thanks!

@weaverryan weaverryan closed this Nov 21, 2013
@gnutix
Copy link
Author

gnutix commented Nov 21, 2013

Thanks Ryan :)

@garak
Copy link
Contributor

garak commented Nov 22, 2013

@weaverryan looks like only 2.2 branch was updated. What about master and 2.3?

@stof
Copy link
Member

stof commented Nov 22, 2013

@garak 2.2 is merged into 2.3 on a regular basis (and 2.3 into master). So 2.3 will be updated on the next merge (Ryan generally does such a merge after merging a bunch of PRs)

@garak
Copy link
Contributor

garak commented Nov 22, 2013

thanks for clarification stof!

@garak
Copy link
Contributor

garak commented Nov 23, 2013

So, the final wording suggests that PHP 5.3.8 is not good, while Symfony2 README states that it is.
Maybe "versions of PHP before 5.3.8" would be better than "PHP 5.3.8 or below"

@gnutix
Copy link
Author

gnutix commented Nov 23, 2013

@garak Argh, nice catch ! Should be when using a PHP version lower than 5.3.8. Fixed in french PR.
@weaverryan Should we open a new one for English ?

@wouterj
Copy link
Member

wouterj commented Nov 23, 2013

If you look at the bugs, you see a bug for 5.3.8, so that version is also not good

@gnutix
Copy link
Author

gnutix commented Nov 24, 2013

@wouterj https://github.com/symfony/symfony/blob/master/README.md

Requirements

Symfony2 is only supported on PHP 5.3.3 and up.

Be warned that PHP versions before 5.3.8 are known to be buggy and might not work for you:

* before PHP 5.3.4, if you get "Notice: Trying to get property of non-object", you've hit a known PHP bug (see https://bugs.php.net/bug.php?id=52083 and https://bugs.php.net/bug.php?id=50027);

* before PHP 5.3.8, if you get an error involving annotations, you've hit a known PHP bug (see https://bugs.php.net/bug.php?id=55156).

* PHP 5.3.16 has a major bug in the Reflection subsystem and is not suitable to run Symfony2 (https://bugs.php.net/bug.php?id=62715)

So it's buggy with PHP_VERSION < 5.3.8 || PHP_VERSION == 5.3.16

@wouterj
Copy link
Member

wouterj commented Nov 24, 2013

A, "before"... I think I misread it, so yeah could you please open a PR to fix the caution?

@gnutix
Copy link
Author

gnutix commented Nov 24, 2013

@wouterj Done #3223

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.

5 participants