Skip to content

Added docs for the cache:pool:clear command #7206

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

Merged
merged 2 commits into from
Aug 1, 2017

Conversation

javiereguiluz
Copy link
Member

This fixes #7173.

@chalasr
Copy link
Member

chalasr commented Dec 2, 2016

Should we mention that the command allows to clear multiple cache pools at once?
Otherwise 👍

@javiereguiluz
Copy link
Member Author

@chalasr in docs we usually just mention commands without explaining the details (same as our policy of not documenting the arguments of the methods). But if @xabbuh and @wouterj agrees with you, I'll update this. Thanks!


.. code-block:: terminal

$ ./bin/console cache:pool:clear <cache-pool-name>
Copy link
Member

Choose a reason for hiding this comment

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

should be php bin/console cache:pool:clear <cache-pool-name> (this is the only Windows and Unix compatible command)


.. code-block:: terminal

$ ./bin/console cache:pool:clear <cache-pool-name>
Copy link
Member

Choose a reason for hiding this comment

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

We can use comments to document other usages (IIRC, we do it in other places as well):

# clears the "cache.app" pool
$ php bin/console cache:pool:clear cache.app

# clears the "cache.validation" and "cache.app" pool
$ php bin/console cache:pool:clear cache.validation cache.app

@HeahDude HeahDude added this to the 3.2 milestone Jul 29, 2017
@xabbuh
Copy link
Member

xabbuh commented Aug 1, 2017

Thank you @javiereguiluz.

@xabbuh xabbuh merged commit 3c31e09 into symfony:3.2 Aug 1, 2017
xabbuh added a commit that referenced this pull request Aug 1, 2017
…z, HeahDude)

This PR was merged into the 3.2 branch.

Discussion
----------

Added docs for the cache:pool:clear command

This fixes #7173.

Commits
-------

3c31e09 applying comment from @wouterj
2c220c4 Added docs for the cache:pool:clear command
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.

6 participants