Skip to content

Improve description about "framework.ide" config option #8405

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

aik099
Copy link

@aik099 aik099 commented Sep 18, 2017

According to code in https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php#L179 when both xdebug.file_link_format (in php.ini) and framework.ide (in app/config/config.yml) are defined, then xdebug.file_link_format wins, but documentetion says the opposite.

P.S.

  • PR is targeting the oldest supported documentation branch, where fixed text fragment is present.
  • It should be merged to 3.3 and 3.4 branches as well.
  • The documentation is changed and not mentioned code, because changing code would introduce a BC break.

@ro0NL
Copy link
Contributor

ro0NL commented Sep 18, 2017

symfony/symfony#24129 might need clarification as well 👍

@aik099
Copy link
Author

aik099 commented Sep 18, 2017

@ro0NL , I've left a note in that issue. Hope that helps.

@ro0NL
Copy link
Contributor

ro0NL commented Sep 18, 2017

I think the part as of When running your app in a container or in a virtual machine... should be updated to a config context, we are in fact describing the ide config setting.

Thus instead of

// /path/to/guest/.../file will be opened
// as /path/to/host/.../file on the host
// and /foo/.../file as /bar/.../file also
'myide://%f:%l&/path/to/guest/>/path/to/host/&/foo/>/bar/&...'

I'd say

framework:
    ide: 'myide://%%f:%%l&/path/to/guest/>/path/to/host/&/foo/>/bar/&...'

Thus escaped.

@aik099
Copy link
Author

aik099 commented Sep 18, 2017

#8405 (comment)

@ro0NL , is this related to changes I've made in this PR?

If so, the I don't understand what you want me to change. If you have push access to this repo, then you already can add more commits to my PR branch.

@ro0NL
Copy link
Contributor

ro0NL commented Sep 18, 2017

Not really related. I thought it was an issue (not a PR) so i quickly comment as well :) related to the same subject though.

Ill have a look in different PR soonish otherwise. Issue solved, feel free to ignore :)

@wouterj
Copy link
Member

wouterj commented Sep 19, 2017

👍 Seems correct to me. Thanks for your detailed PR description & patch!

status: reviewed

@xabbuh xabbuh added this to the 3.3 milestone Sep 22, 2017
@xabbuh
Copy link
Member

xabbuh commented Sep 22, 2017

Thank you @aik099.

xabbuh added a commit that referenced this pull request Sep 22, 2017
…aik099)

This PR was submitted for the 3.2 branch but it was merged into the 3.3 branch instead (closes #8405).

Discussion
----------

Improve description about "framework.ide" config option

According to code in https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php#L179 when both `xdebug.file_link_format` (in `php.ini`) and `framework.ide` (in `app/config/config.yml`) are defined, then `xdebug.file_link_format` wins, but documentetion says the opposite.

P.S.

* PR is targeting the oldest supported documentation branch, where fixed text fragment is present.
* It should be merged to `3.3` and `3.4` branches as well.
* The documentation is changed and not mentioned code, because changing code would introduce a BC break.

Commits
-------

432d456 Improve description about "framework.ide" config option
@xabbuh xabbuh closed this Sep 22, 2017
@aik099 aik099 deleted the improve_framework-ide_config_description branch September 24, 2017 10:48
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.

5 participants