Skip to content

Commit 3849004

Browse files
committed
Replaced caution blocks with warning
Fixes #20371 Both blocks are currently rendered identically. Keeping only one of the two makes it easier to contribute. Some blocks were elevated to danger.
1 parent 119c3df commit 3849004

File tree

143 files changed

+248
-246
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+248
-246
lines changed

.doctor-rst.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ rules:
2323
forbidden_directives:
2424
directives:
2525
- '.. index::'
26+
- '.. caution::'
2627
indention: ~
2728
lowercase_as_in_use_statements: ~
2829
max_blank_lines:

bundles.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The Bundle System
44
=================
55

6-
.. caution::
6+
.. warning::
77

88
In Symfony versions prior to 4.0, it was recommended to organize your own
99
application code using bundles. This is :ref:`no longer recommended <best-practice-no-application-bundles>` and bundles
@@ -63,7 +63,7 @@ Start by creating a new class called ``AcmeBlogBundle``::
6363
The :class:`Symfony\\Component\\HttpKernel\\Bundle\\AbstractBundle` was
6464
introduced in Symfony 6.1.
6565

66-
.. caution::
66+
.. warning::
6767

6868
If your bundle must be compatible with previous Symfony versions you have to
6969
extend from the :class:`Symfony\\Component\\HttpKernel\\Bundle\\Bundle` instead.
@@ -123,7 +123,7 @@ to be adjusted if needed:
123123

124124
.. _bundles-legacy-directory-structure:
125125

126-
.. caution::
126+
.. warning::
127127

128128
The recommended bundle structure was changed in Symfony 5, read the
129129
`Symfony 4.4 bundle documentation`_ for information about the old

bundles/best_practices.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ with Symfony Flex to install a specific Symfony version:
246246
# recommended to have a better output and faster download time)
247247
composer update --prefer-dist --no-progress
248248
249-
.. caution::
249+
.. warning::
250250

251251
If you want to cache your Composer dependencies, **do not** cache the
252252
``vendor/`` directory as this has side-effects. Instead cache

bundles/extension.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Patterns are transformed into the actual class namespaces using the classmap
204204
generated by Composer. Therefore, before using these patterns, you must generate
205205
the full classmap executing the ``dump-autoload`` command of Composer.
206206

207-
.. caution::
207+
.. warning::
208208

209209
This technique can't be used when the classes to compile use the ``__DIR__``
210210
or ``__FILE__`` constants, because their values will change when loading

bundles/override.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For example, to override the ``templates/registration/confirmed.html.twig``
1919
template from the AcmeUserBundle, create this template:
2020
``<your-project>/templates/bundles/AcmeUserBundle/registration/confirmed.html.twig``
2121

22-
.. caution::
22+
.. warning::
2323

2424
If you add a template in a new location, you *may* need to clear your
2525
cache (``php bin/console cache:clear``), even if you are in debug mode.

cache.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -854,7 +854,7 @@ Then, register the ``SodiumMarshaller`` service using this key:
854854
//->addArgument(['env(base64:CACHE_DECRYPTION_KEY)', 'env(base64:OLD_CACHE_DECRYPTION_KEY)'])
855855
->addArgument(new Reference('.inner'));
856856
857-
.. caution::
857+
.. danger::
858858

859859
This will encrypt the values of the cache items, but not the cache keys. Be
860860
careful not to leak sensitive data in the keys.

components/cache/adapters/apcu_adapter.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This adapter is a high-performance, shared memory cache. It can *significantly*
55
increase an application's performance, as its cache contents are stored in shared
66
memory, a component appreciably faster than many others, such as the filesystem.
77

8-
.. caution::
8+
.. warning::
99

1010
**Requirement:** The `APCu extension`_ must be installed and active to use
1111
this adapter.
@@ -30,7 +30,7 @@ and cache items version string as constructor arguments::
3030
$version = null
3131
);
3232

33-
.. caution::
33+
.. warning::
3434

3535
Use of this adapter is discouraged in write/delete heavy workloads, as these
3636
operations cause memory fragmentation that results in significantly degraded performance.

components/cache/adapters/couchbasebucket_adapter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ shared memory; you can store contents independent of your PHP environment.
88
The ability to utilize a cluster of servers to provide redundancy and/or fail-over
99
is also available.
1010

11-
.. caution::
11+
.. warning::
1212

1313
**Requirements:** The `Couchbase PHP extension`_ as well as a `Couchbase server`_
1414
must be installed, active, and running to use this adapter. Version ``2.6`` or

components/cache/adapters/couchbasecollection_adapter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ shared memory; you can store contents independent of your PHP environment.
88
The ability to utilize a cluster of servers to provide redundancy and/or fail-over
99
is also available.
1010

11-
.. caution::
11+
.. warning::
1212

1313
**Requirements:** The `Couchbase PHP extension`_ as well as a `Couchbase server`_
1414
must be installed, active, and running to use this adapter. Version ``3.0`` or

components/cache/adapters/filesystem_adapter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ and cache root path as constructor parameters::
3333
$directory = null
3434
);
3535

36-
.. caution::
36+
.. warning::
3737

3838
The overhead of filesystem IO often makes this adapter one of the *slower*
3939
choices. If throughput is paramount, the in-memory adapters

components/cache/adapters/memcached_adapter.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ shared memory; you can store contents independent of your PHP environment.
88
The ability to utilize a cluster of servers to provide redundancy and/or fail-over
99
is also available.
1010

11-
.. caution::
11+
.. warning::
1212

1313
**Requirements:** The `Memcached PHP extension`_ as well as a `Memcached server`_
1414
must be installed, active, and running to use this adapter. Version ``2.2`` or
@@ -256,7 +256,7 @@ Available Options
256256
executed in a "fire-and-forget" manner; no attempt to ensure the operation
257257
has been received or acted on will be made once the client has executed it.
258258

259-
.. caution::
259+
.. warning::
260260

261261
Not all library operations are tested in this mode. Mixed TCP and UDP
262262
servers are not allowed.

components/cache/adapters/php_files_adapter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ file similar to the following::
2828
handles file includes, this adapter has the potential to be much faster than other
2929
filesystem-based caches.
3030

31-
.. caution::
31+
.. warning::
3232

3333
While it supports updates and because it is using OPcache as a backend, this adapter is
3434
better suited for append-mostly needs. Using it in other scenarios might lead to

components/cache/adapters/redis_adapter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Unlike the :doc:`APCu adapter </components/cache/adapters/apcu_adapter>`, and si
1515
shared memory; you can store contents independent of your PHP environment. The ability
1616
to utilize a cluster of servers to provide redundancy and/or fail-over is also available.
1717

18-
.. caution::
18+
.. warning::
1919

2020
**Requirements:** At least one `Redis server`_ must be installed and running to use this
2121
adapter. Additionally, this adapter requires a compatible extension or library that implements

components/config/definition.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -675,7 +675,7 @@ The separator used in keys is typically ``_`` in YAML and ``-`` in XML.
675675
For example, ``auto_connect`` in YAML and ``auto-connect`` in XML. The
676676
normalization would make both of these ``auto_connect``.
677677

678-
.. caution::
678+
.. warning::
679679

680680
The target key will not be altered if it's mixed like
681681
``foo-bar_moo`` or if it already exists.
@@ -894,7 +894,7 @@ Otherwise the result is a clean array of configuration values::
894894
$configs
895895
);
896896

897-
.. caution::
897+
.. warning::
898898

899899
When processing the configuration tree, the processor assumes that the top
900900
level array key (which matches the extension name) is already stripped off.

components/console/changing_default_command.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This will print the following to the command line:
5252
5353
Hello World
5454
55-
.. caution::
55+
.. warning::
5656

5757
This feature has a limitation: you cannot pass any argument or option to
5858
the default command because they are ignored.

components/console/events.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ the wheel, it uses the Symfony EventDispatcher component to do the work::
1414
$application->setDispatcher($dispatcher);
1515
$application->run();
1616

17-
.. caution::
17+
.. warning::
1818

1919
Console events are only triggered by the main command being executed.
2020
Commands called by the main command will not trigger any event, unless

components/console/helpers/progressbar.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ to display it can be customized::
327327
// the bar width
328328
$progressBar->setBarWidth(50);
329329

330-
.. caution::
330+
.. warning::
331331

332332
For performance reasons, Symfony redraws the screen once every 100ms. If this is too
333333
fast or too slow for your application, use the methods

components/console/helpers/questionhelper.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ convenient for passwords::
329329
return Command::SUCCESS;
330330
}
331331

332-
.. caution::
332+
.. warning::
333333

334334
When you ask for a hidden response, Symfony will use either a binary, change
335335
``stty`` mode or use another trick to hide the response. If none is available,
@@ -392,7 +392,7 @@ method::
392392
return Command::SUCCESS;
393393
}
394394

395-
.. caution::
395+
.. warning::
396396

397397
The normalizer is called first and the returned value is used as the input
398398
of the validator. If the answer is invalid, don't throw exceptions in the
@@ -540,7 +540,7 @@ This way you can test any user interaction (even complex ones) by passing the ap
540540
simulates a user hitting ``ENTER`` after each input, no need for passing
541541
an additional input.
542542

543-
.. caution::
543+
.. warning::
544544

545545
On Windows systems Symfony uses a special binary to implement hidden
546546
questions. This means that those questions don't use the default ``Input``

components/finder.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The ``$file`` variable is an instance of
4141
:class:`Symfony\\Component\\Finder\\SplFileInfo` which extends PHP's own
4242
:phpclass:`SplFileInfo` to provide methods to work with relative paths.
4343

44-
.. caution::
44+
.. warning::
4545

4646
The ``Finder`` object doesn't reset its internal state automatically.
4747
This means that you need to create a new instance if you do not want

components/form.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@ method:
640640
641641
// ...
642642
643-
.. caution::
643+
.. warning::
644644

645645
The form's ``createView()`` method should be called *after* ``handleRequest()`` is
646646
called. Otherwise, when using :doc:`form events </form/events>`, changes done

components/http_kernel.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ you will trigger the ``kernel.terminate`` event where you can perform certain
494494
actions that you may have delayed in order to return the response as quickly
495495
as possible to the client (e.g. sending emails).
496496

497-
.. caution::
497+
.. warning::
498498

499499
Internally, the HttpKernel makes use of the :phpfunction:`fastcgi_finish_request`
500500
PHP function. This means that at the moment, only the `PHP FPM`_ server

components/ldap.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ distinguished name (DN) and the password of a user::
7070

7171
$ldap->bind($dn, $password);
7272

73-
.. caution::
73+
.. danger::
7474

7575
When the LDAP server allows unauthenticated binds, a blank password will always be valid.
7676

0 commit comments

Comments
 (0)