Skip to content

Commit 1c7087c

Browse files
committed
Merge remote-tracking branch 'upstream/7.3' into 7.3
* upstream/7.3: [Messenger] Fix some syntax issue [Reference] Sort all framework options alphabetically [Reference] Sort debug options alphabetically Fix the top-level key in the DebugBundle reference Tweak reference documents Remove non-existent password_strength setting from the reference Improve the documentation of php_errors in the reference
2 parents 95e66ee + 8644781 commit 1c7087c

File tree

6 files changed

+2400
-2425
lines changed

6 files changed

+2400
-2425
lines changed

messenger.rst

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -543,18 +543,19 @@ command with the ``--all`` option:
543543

544544
The ``--all`` option was introduced in Symfony 7.1.
545545

546-
The ``--keepalive`` option can be used to prevent messages from being prematurely
547-
redelivered during long-running processing. It marks the message as "in progress"
548-
and prevents it from being redelivered until the worker finishes processing it:
546+
Messages that take a long time to process may be redelivered prematurely because
547+
some transports assume that an unacknowledged message is lost. To prevent this
548+
issue, use the ``--keepalive`` command option to specify an interval (in seconds;
549+
default value = ``5``) at which the message is marked as "in progress". This prevents
550+
the message from being redelivered until the worker completes processing it:
549551

550552
.. code-block:: terminal
551553
552-
php bin/console messenger:consume --keepalive=5
554+
$ php bin/console messenger:consume --keepalive
553555
554556
.. note::
555557

556-
This option is only available for supported transports, which are
557-
the Doctrine, Beanstalkd and AmazonSQS transports.
558+
This option is only available for the following transports: Beanstalkd and AmazonSQS.
558559

559560
.. versionadded:: 7.2
560561

@@ -1785,10 +1786,6 @@ The transport has a number of options:
17851786
The message time to run before it is put back in the ready queue - in
17861787
seconds.
17871788

1788-
.. versionadded:: 7.2
1789-
1790-
Keepalive support, using the ``--keepalive`` option, was added in Symfony 7.2.
1791-
17921789
The Beanstalkd transport lets you set the priority of the messages being dispatched.
17931790
Use the ``Symfony\Component\Messenger\Bridge\Beanstalkd\Transport\BeanstalkdPriorityStamp``
17941791
and pass a number to specify the priority (default = ``1024``; lower numbers mean higher priority)::
@@ -2138,10 +2135,6 @@ The transport has a number of options:
21382135
FIFO queues don't support setting a delay per message, a value of ``delay: 0``
21392136
is required in the retry strategy settings.
21402137

2141-
.. versionadded:: 7.2
2142-
2143-
Keepalive support, using the `--keepalive` option, was added in Symfony 7.2.
2144-
21452138
Serializing Messages
21462139
~~~~~~~~~~~~~~~~~~~~
21472140

reference/configuration/debug.rst

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,50 +8,21 @@ key in your application configuration.
88
.. code-block:: terminal
99
1010
# displays the default config values defined by Symfony
11-
$ php bin/console config:dump-reference framework
11+
$ php bin/console config:dump-reference debug
1212
1313
# displays the actual config values used by your application
14-
$ php bin/console debug:config framework
14+
$ php bin/console debug:config debug
1515
1616
# displays the config values used by your application and replaces the
1717
# environment variables with their actual values
18-
$ php bin/console debug:config --resolve-env framework
18+
$ php bin/console debug:config --resolve-env debug
1919
2020
.. note::
2121

2222
When using XML, you must use the ``http://symfony.com/schema/dic/debug``
2323
namespace and the related XSD schema is available at:
2424
``https://symfony.com/schema/dic/debug/debug-1.0.xsd``
2525

26-
Configuration
27-
-------------
28-
29-
max_items
30-
~~~~~~~~~
31-
32-
**type**: ``integer`` **default**: ``2500``
33-
34-
This is the maximum number of items to dump. Setting this option to ``-1``
35-
disables the limit.
36-
37-
min_depth
38-
~~~~~~~~~
39-
40-
**type**: ``integer`` **default**: ``1``
41-
42-
Configures the minimum tree depth until which all items are guaranteed to
43-
be cloned. After this depth is reached, only ``max_items`` items will be
44-
cloned. The default value is ``1``, which is consistent with older Symfony
45-
versions.
46-
47-
max_string_length
48-
~~~~~~~~~~~~~~~~~
49-
50-
**type**: ``integer`` **default**: ``-1``
51-
52-
This option configures the maximum string length before truncating the
53-
string. The default value (``-1``) means that strings are never truncated.
54-
5526
.. _configuration-debug-dump_destination:
5627

5728
dump_destination
@@ -101,3 +72,29 @@ Typically, you would set this to ``php://stderr``:
10172
10273
10374
Configure it to ``"tcp://%env(VAR_DUMPER_SERVER)%"`` in order to use the :ref:`ServerDumper feature <var-dumper-dump-server>`.
75+
76+
max_items
77+
~~~~~~~~~
78+
79+
**type**: ``integer`` **default**: ``2500``
80+
81+
This is the maximum number of items to dump. Setting this option to ``-1``
82+
disables the limit.
83+
84+
max_string_length
85+
~~~~~~~~~~~~~~~~~
86+
87+
**type**: ``integer`` **default**: ``-1``
88+
89+
This option configures the maximum string length before truncating the
90+
string. The default value (``-1``) means that strings are never truncated.
91+
92+
min_depth
93+
~~~~~~~~~
94+
95+
**type**: ``integer`` **default**: ``1``
96+
97+
Configures the minimum tree depth until which all items are guaranteed to
98+
be cloned. After this depth is reached, only ``max_items`` items will be
99+
cloned. The default value is ``1``, which is consistent with older Symfony
100+
versions.

0 commit comments

Comments
 (0)