From ab7e5ca9ebfdfb6e93b6e2c66f3fd84bd8900477 Mon Sep 17 00:00:00 2001 From: wangxiyuan Date: Mon, 13 Mar 2017 12:01:39 +0800 Subject: [PATCH] Update purge doc purge command guide is missing. Change-Id: I92dcd1ca025aa1c5982fe22fee000d237c110022 --- doc/source/command/queue.rst | 26 ++++++++++++++++++++++++++ doc/source/index.rst | 2 +- 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/doc/source/command/queue.rst b/doc/source/command/queue.rst index 07039dee..cd483086 100644 --- a/doc/source/command/queue.rst +++ b/doc/source/command/queue.rst @@ -177,3 +177,29 @@ Get queue stats. ```` Name of the queue. + + +.. _openstack_queue_purge: + +openstack queue purge +--------------------- + +.. code-block:: console + + usage: openstack queue purge [-h] [--resource_types ] + + +Purge a queue. All the metadata of the queue will be kept. Use +``--resource_types`` to specify which resource should be pured. If +``--resource_types`` is not specified, all the messages and subscriptions in +the queue will be purged by default. + +**Positional arguments:** + +```` + Name of the queue. + +**Optional arguments:** + +``--resource_types ` + Resource types want to be purged. Support ``messages`` and ``subscriptions``. diff --git a/doc/source/index.rst b/doc/source/index.rst index 5b4bd978..ec8cc038 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -95,4 +95,4 @@ Indices and tables * :ref:`modindex` * :ref:`search` -.. _`Release Page`: https://releases.openstack.org +.. _`Release Page`: https://docs.openstack.org/releasenotes/python-zaqarclient