Skip to content

Documented the PhpExecutableFinder utility #9182

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

Conversation

javiereguiluz
Copy link
Member

I was going to document #9003 ... but I think we should not explain that because it's an internal detail and the code can be changed/improved at any time and we cannot keep the docs in sync. However, we could document the PhpExecutableFinder utility if we decide is useful enough.

@javiereguiluz
Copy link
Member Author

@nicolas-grekas do you think it's worth it to document this utility or it's something mostly internal? Thanks!

Copy link
Member

@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK to tell about the feature, but maybe give less details (see inline comment)

This component also provides a utility class called
:class:`Symfony\\Component\\Process\\PhpExecutableFinder` which returns the
absolute path of the executable PHP binary available on your server. It looks
for the PHP executable using environment variables like ``PHP_BINARY``,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this sentence: it is inaccurate, and it's complex to explain accurately
let just describe what it does, not how

javiereguiluz added a commit that referenced this pull request Feb 5, 2018
This PR was squashed before being merged into the 2.7 branch (closes #9182).

Discussion
----------

Documented the PhpExecutableFinder utility

I was going to document #9003 ... but I think we should not explain that because it's an internal detail and the code can be changed/improved at any time and we cannot keep the docs in sync. However, we could document the PhpExecutableFinder utility if we decide is useful enough.

Commits
-------

cbd6e2b Documented the PhpExecutableFinder utility
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants