Skip to content

Commit

Permalink
Merge pull request #559 from FriendsOfSymfony/cleanup-v3-doc
Browse files Browse the repository at this point in the history
adjust documentation: drop old versionadded notes, adjust link to old…
  • Loading branch information
dbu committed Mar 23, 2024
2 parents 797ae1c + c834200 commit 97af5bb
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 14 deletions.
6 changes: 3 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ This is the documentation for the `FOSHttpCache library <https://github.com/Frie

.. note::

This documentation is for the 2.* version of the library. For the 1.*
version, please refer to the `1.4 documentation`_.
This documentation is for the 3.* version of the library. For the 2.*
version, please refer to the `2.x documentation`_.

This library integrates your PHP applications with HTTP caching proxies such as
Varnish, NGINX or the Symfony HttpCache class. Use this library to send
Expand Down Expand Up @@ -34,4 +34,4 @@ Contents:
testing-your-application
contributing

.. _1.4 documentation: http://foshttpcache.readthedocs.io/en/1.4/
.. _2.x documentation: https://foshttpcache.readthedocs.io/en/2.x/
5 changes: 0 additions & 5 deletions doc/symfony-cache-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,6 @@ one of ``client_ips`` or ``client_matcher``*.
Tagging
~~~~~~~

.. versionadded:: 2.1

Support for tag invalidation with Symfony HttpCache has been added in
version 2.1.

To support :doc:`cache tags <response-tagging>`, require the additional package
``toflar/psr6-symfony-http-cache-store:^1.0`` with composer and register the
``PurgeTagsListener`` in your cache kernel. The purge listener needs your cache
Expand Down
6 changes: 0 additions & 6 deletions doc/testing-your-application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ extend your own (or your framework’s) base test classes. For convenience, you
can also extend the FOSHttpCache base test class suitable for your proxy
server, which includes a sensible set of traits.

.. versionadded:: 2.1

The testing has been updated to support PHPUnit 6 in version 2.1. If you
an older version of FOSHttpCache and want to use the features described in
this chapter, you need to use PHPUnit 5 to run the tests.

By using the traits, you get:

* independent tests: all previously cached content is removed in the test’s
Expand Down

0 comments on commit 97af5bb

Please sign in to comment.