Skip to content

[Messenger] Add reference to PHP docs for SSL context options #20325

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 15, 2024
Merged

[Messenger] Add reference to PHP docs for SSL context options #20325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion messenger.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1694,7 +1694,7 @@ redis_sentinel support is disabled
ssl Map of TLS options. null
======================= ===================================== =================================

The ``ssl`` option can be used to change requirements for the TLS channel, e.g. in tests:
The ``ssl`` option can be used to provide SSL context options (`php.net/context.ssl`_) for the TLS channel, e.g. in tests:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The ``ssl`` option can be used to provide SSL context options (`php.net/context.ssl`_) for the TLS channel, e.g. in tests:
The ``ssl`` option can be used to provide `SSL context options`_ for the TLS channel, e.g. in tests:

WDYT about this for better link integration in text ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we could use the proposed variant if this keeps the reference intact to the PHP docs.

image

See:

symfony-docs/components/cache/adapters/redis_adapter.rst

Line 220 in f39f657

SSL context options. See `php.net/context.ssl`_ for more information.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, @MrYamous proposal is what we usually do in the docs. So, I changed this while merging. See 714113c


.. configuration-block::

Expand Down Expand Up @@ -3488,3 +3488,4 @@ Learn more
.. _`AMQProxy`: https://github.com/cloudamqp/amqproxy
.. _`high connection churn`: https://www.rabbitmq.com/connections.html#high-connection-churn
.. _`article about CQRS`: https://martinfowler.com/bliki/CQRS.html
.. _`php.net/context.ssl`: https://php.net/context.ssl
Loading