summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorHuanxuan Ao <huanxuan.ao@easystack.cn>2017-03-08 10:01:16 +0800
committerDean Troyer <dtroyer@gmail.com>2017-04-26 11:07:08 -0500
commit1c49a1f01da73b8eed701809de88b408e738dfed (patch)
treedecfdfb36d616d70d40e98b534ff93ea5390aecc /doc/source
parentbf1f47c1be5bf9f6b25eab21eb06c3b0473bf34f (diff)
downloadpython-openstackclient-1c49a1f01da73b8eed701809de88b408e738dfed.tar.gz
Fix NoneType error for volume snapshot create command
In volume snapshot command, <volume> is the same as <snapshot-name> when --volume is not specified, but <volume> cannot be None, so when <snapshot-name> is not specified (<snapshot-name> is None), a NoneType error appears. So make <snapshot-name> no longer optional, it should be always present. Change-Id: I3d9f10753a8ef601e70816421c160598e2cc811f Closes-bug: #1659894
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/backwards-incompatible.rst15
-rw-r--r--doc/source/command-objects/volume-snapshot.rst2
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/source/backwards-incompatible.rst b/doc/source/backwards-incompatible.rst
index 22c300de..0202e8a5 100644
--- a/doc/source/backwards-incompatible.rst
+++ b/doc/source/backwards-incompatible.rst
@@ -27,6 +27,21 @@ Backwards Incompatible Changes
.. * Remove in: <5.0>
.. * Commit: <tbd>
+Release 3.10
+------------
+
+1. The positional argument ``<snapshot-name>`` of the ``volume snapshot create``
+ command is no longer optional.
+
+ Previously when the ``--volume`` option was
+ present ``<snapshot-name>`` defaulted to the ``--volume`` value. When the
+ ``--volume`` option is not present now it defaults to the value of
+ ``<snapshot-name>``.
+
+ * As of: 3.10
+ * Bug: 1659894
+ * Commit: https://review.openstack.org/440497
+
Release 3.0
-----------
diff --git a/doc/source/command-objects/volume-snapshot.rst b/doc/source/command-objects/volume-snapshot.rst
index 67db62f2..30cc77cc 100644
--- a/doc/source/command-objects/volume-snapshot.rst
+++ b/doc/source/command-objects/volume-snapshot.rst
@@ -49,7 +49,7 @@ Create new volume snapshot
.. _volume_snapshot_create-snapshot-name:
.. describe:: <snapshot-name>
- Name of the new snapshot (default to None)
+ Name of the new snapshot
volume snapshot delete
----------------------