From 383c37e0d8666aa9b52bd0bdd469ee47a97b80ea Mon Sep 17 00:00:00 2001 From: Vipin Balachandran Date: Tue, 13 Sep 2016 10:54:00 +0530 Subject: [PATCH] Fix release notes formatting We use double ticks to format config options, driver FQNs etc. in few release notes to improve readability. This patch updates the remaining release notes to follow the same convention. Change-Id: Ied4e5e02cc781405206edc2322567e5e5e3e170f --- ...ell-SC-ServerOS-Config-Option-bd0e018319758e03.yaml | 2 +- ...-stochastic-scheduling-option-99e10eae023fbcca.yaml | 4 ++-- ...tera-cinder-driver-update-2.1-5c6455b45563adc5.yaml | 3 ++- ...cd_lookupservice_http_support-f6485b38a1feaa15.yaml | 2 +- releasenotes/notes/bug-1570845-efdb0206718f4ca4.yaml | 4 ++-- .../datera-driver-v2-update-930468e8259c8e86.yaml | 4 ++-- ...deprecate-backends-in-default-b9784a2333fe22f2.yaml | 10 +++++----- .../mark-scality-unsupported-530370e034a6f488.yaml | 8 ++++---- ...e-backend-replication-support-59d7537fe3d0eb05.yaml | 2 +- .../notes/os-brick-lock-dir-35bdd8ec0c0ef46d.yaml | 6 +++--- .../notes/pure-list-mangeable-fed4a1b23212f545.yaml | 2 +- .../notes/removed-isertgtadm-7ccefab5d3e89c59.yaml | 4 ++-- ...o-default-volume-provisioning-c648118fcc8f297f.yaml | 2 +- .../notes/scaleio-scaling-qos-50c58e43d4b54247.yaml | 2 +- ...eio-thin-provisioning-support-9c3b9203567771dd.yaml | 10 +++++----- .../use-castellan-key-manager-4911c3c4908ca633.yaml | 2 +- .../notes/vmware-vmdk-config-eb70892e4ccf8f3c.yaml | 4 ++-- .../vmware_vmdk_paravirtual-3d5eeef96dcbcfb7.yaml | 4 ++-- 18 files changed, 38 insertions(+), 37 deletions(-) diff --git a/releasenotes/notes/Dell-SC-ServerOS-Config-Option-bd0e018319758e03.yaml b/releasenotes/notes/Dell-SC-ServerOS-Config-Option-bd0e018319758e03.yaml index 64617e92309..25edcffecc2 100644 --- a/releasenotes/notes/Dell-SC-ServerOS-Config-Option-bd0e018319758e03.yaml +++ b/releasenotes/notes/Dell-SC-ServerOS-Config-Option-bd0e018319758e03.yaml @@ -1,6 +1,6 @@ --- features: - - dell_server_os option added to the Dell SC driver. + - Config option ``dell_server_os`` added to the Dell SC driver. This option allows the selection of the server type used when creating a server on the Dell DSM during initialize connection. This is only used if the diff --git a/releasenotes/notes/add-stochastic-scheduling-option-99e10eae023fbcca.yaml b/releasenotes/notes/add-stochastic-scheduling-option-99e10eae023fbcca.yaml index fa002c67e00..7d811ce0e95 100644 --- a/releasenotes/notes/add-stochastic-scheduling-option-99e10eae023fbcca.yaml +++ b/releasenotes/notes/add-stochastic-scheduling-option-99e10eae023fbcca.yaml @@ -1,10 +1,10 @@ --- features: - - Added a new config option `scheduler_weight_handler`. This is a global + - Added a new config option ``scheduler_weight_handler``. This is a global option which specifies how the scheduler should choose from a listed of weighted pools. By default the existing weigher is used which always chooses the highest weight. - - Added a new weight handler `StochasticHostWeightHandler`. This weight + - Added a new weight handler ``StochasticHostWeightHandler``. This weight handler chooses pools randomly, where the random probabilities are proportional to the weights, so higher weighted pools are chosen more frequently, but not all the time. This weight handler spreads new diff --git a/releasenotes/notes/bp-datera-cinder-driver-update-2.1-5c6455b45563adc5.yaml b/releasenotes/notes/bp-datera-cinder-driver-update-2.1-5c6455b45563adc5.yaml index e97f57289c0..34e608dfe22 100644 --- a/releasenotes/notes/bp-datera-cinder-driver-update-2.1-5c6455b45563adc5.yaml +++ b/releasenotes/notes/bp-datera-cinder-driver-update-2.1-5c6455b45563adc5.yaml @@ -3,5 +3,6 @@ features: - Updating the Datera Elastic DataFabric Storage Driver to version 2.1. This adds ACL support, Multipath support and basic IP pool support. - - Changes config option default for datera_num_replicas +upgrade: + - Changes config option default for ``datera_num_replicas`` from 1 to 3 diff --git a/releasenotes/notes/brcd_lookupservice_http_support-f6485b38a1feaa15.yaml b/releasenotes/notes/brcd_lookupservice_http_support-f6485b38a1feaa15.yaml index 5cec223e0f2..fb0c0a6d3ec 100644 --- a/releasenotes/notes/brcd_lookupservice_http_support-f6485b38a1feaa15.yaml +++ b/releasenotes/notes/brcd_lookupservice_http_support-f6485b38a1feaa15.yaml @@ -1,5 +1,5 @@ --- features: - - Support for use of 'fc_southbound_protocol' + - Support for use of ``fc_southbound_protocol`` configuration setting in the Brocade FC SAN lookup service. diff --git a/releasenotes/notes/bug-1570845-efdb0206718f4ca4.yaml b/releasenotes/notes/bug-1570845-efdb0206718f4ca4.yaml index b247a818052..8ca419bdcba 100644 --- a/releasenotes/notes/bug-1570845-efdb0206718f4ca4.yaml +++ b/releasenotes/notes/bug-1570845-efdb0206718f4ca4.yaml @@ -1,4 +1,4 @@ --- upgrade: - - The 'backup_service_inithost_offload' configuration - option now defaults to 'True' instead of 'False'. + - The ``backup_service_inithost_offload`` configuration + option now defaults to ``True`` instead of ``False``. diff --git a/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml b/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml index fc12369ba3f..3ecf5221f53 100644 --- a/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml +++ b/releasenotes/notes/datera-driver-v2-update-930468e8259c8e86.yaml @@ -8,5 +8,5 @@ upgrade: not be able to utilize this new driver since they still function on v1 of the Datera DataFabric API deprecations: - - datera_api_token -- this has been replaced by - san_login and san_password + - Config option ``datera_api_token`` has been replaced by + options ``san_login`` and ``san_password`` diff --git a/releasenotes/notes/deprecate-backends-in-default-b9784a2333fe22f2.yaml b/releasenotes/notes/deprecate-backends-in-default-b9784a2333fe22f2.yaml index a3952e1ee50..c7f39d1cb74 100644 --- a/releasenotes/notes/deprecate-backends-in-default-b9784a2333fe22f2.yaml +++ b/releasenotes/notes/deprecate-backends-in-default-b9784a2333fe22f2.yaml @@ -1,10 +1,10 @@ --- upgrade: - - Any Volume Drivers configured in the DEFAULT config stanza should be moved - to their own stanza and enabled via the enabled_backends config option. - The older style of config with DEFAULT is deprecated and will be + - Any Volume Drivers configured in the ``DEFAULT`` config stanza should be moved + to their own stanza and enabled via the ``enabled_backends`` config option. + The older style of config with ``DEFAULT`` is deprecated and will be removed in future releases. deprecations: - - Configuring Volume Drivers in the DEFAULT config stanza is not going to be + - Configuring Volume Drivers in the ``DEFAULT`` config stanza is not going to be maintained and will be removed in the next release. All backends should use - the enabled_backends config option with separate stanza's for each. + the ``enabled_backends`` config option with separate stanza's for each. diff --git a/releasenotes/notes/mark-scality-unsupported-530370e034a6f488.yaml b/releasenotes/notes/mark-scality-unsupported-530370e034a6f488.yaml index 0aeb7c0e018..76f4cbbf36c 100644 --- a/releasenotes/notes/mark-scality-unsupported-530370e034a6f488.yaml +++ b/releasenotes/notes/mark-scality-unsupported-530370e034a6f488.yaml @@ -1,11 +1,11 @@ --- upgrade: - The Scality driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. deprecations: - The Scality driver has been marked as unsupported and is - now deprecated. enable_unsupported_drivers will need to - be set to True in cinder.conf to continue to use it. If + now deprecated. ``enable_unsupported_drivers`` will need to + be set to ``True`` in cinder.conf to continue to use it. If its support status does not change it will be removed in the next release. diff --git a/releasenotes/notes/netapp-cDOT-whole-backend-replication-support-59d7537fe3d0eb05.yaml b/releasenotes/notes/netapp-cDOT-whole-backend-replication-support-59d7537fe3d0eb05.yaml index 16864456d2e..f0ce83a0f2d 100644 --- a/releasenotes/notes/netapp-cDOT-whole-backend-replication-support-59d7537fe3d0eb05.yaml +++ b/releasenotes/notes/netapp-cDOT-whole-backend-replication-support-59d7537fe3d0eb05.yaml @@ -4,5 +4,5 @@ features: to the NetApp cDOT drivers (iSCSI, FC, NFS). upgrade: - While configuring NetApp cDOT back ends, new configuration options - ('replication_device' and 'netapp_replication_aggregate_map') must be + (``replication_device`` and ``netapp_replication_aggregate_map``) must be added in order to use the host-level failover feature. diff --git a/releasenotes/notes/os-brick-lock-dir-35bdd8ec0c0ef46d.yaml b/releasenotes/notes/os-brick-lock-dir-35bdd8ec0c0ef46d.yaml index a4fbf456d3f..6e87f17ec6e 100644 --- a/releasenotes/notes/os-brick-lock-dir-35bdd8ec0c0ef46d.yaml +++ b/releasenotes/notes/os-brick-lock-dir-35bdd8ec0c0ef46d.yaml @@ -3,7 +3,7 @@ issues: - When running Nova Compute and Cinder Volume or Backup services on the same host they must use a shared lock directory to avoid rare race conditions that can cause volume operation failures (primarily attach/detach of - volumes). This is done by setting the "lock_path" to the same directory - in the "oslo_concurrency" section of nova.conf and cinder.conf. This issue + volumes). This is done by setting the ``lock_path`` to the same directory + in the ``oslo_concurrency`` section of nova.conf and cinder.conf. This issue affects all previous releases utilizing os-brick and shared operations - on hosts between Nova Compute and Cinder data services. \ No newline at end of file + on hosts between Nova Compute and Cinder data services. diff --git a/releasenotes/notes/pure-list-mangeable-fed4a1b23212f545.yaml b/releasenotes/notes/pure-list-mangeable-fed4a1b23212f545.yaml index a2bed8cc9e1..18170b56d33 100644 --- a/releasenotes/notes/pure-list-mangeable-fed4a1b23212f545.yaml +++ b/releasenotes/notes/pure-list-mangeable-fed4a1b23212f545.yaml @@ -1,4 +1,4 @@ --- features: - - Add get_manageable_volumes and get_manageable_snapshots implementations for + - Add ``get_manageable_volumes`` and ``get_manageable_snapshots`` implementations for Pure Storage Volume Drivers. diff --git a/releasenotes/notes/removed-isertgtadm-7ccefab5d3e89c59.yaml b/releasenotes/notes/removed-isertgtadm-7ccefab5d3e89c59.yaml index 4acf016fb33..89d61ff51eb 100644 --- a/releasenotes/notes/removed-isertgtadm-7ccefab5d3e89c59.yaml +++ b/releasenotes/notes/removed-isertgtadm-7ccefab5d3e89c59.yaml @@ -2,7 +2,7 @@ upgrade: - The ISERTgtAdm target was deprecated in the Kilo release. It has now been removed. You should now just use - LVMVolumeDriver and specify iscsi_helper for the target + LVMVolumeDriver and specify ``iscsi_helper`` for the target driver you wish to use. In order to enable iser, please - set iscsi_protocol=iser with lioadm or tgtadm target + set ``iscsi_protocol=iser`` with lioadm or tgtadm target helpers. diff --git a/releasenotes/notes/scaleio-default-volume-provisioning-c648118fcc8f297f.yaml b/releasenotes/notes/scaleio-default-volume-provisioning-c648118fcc8f297f.yaml index ff9185742c0..4b61f576d36 100644 --- a/releasenotes/notes/scaleio-default-volume-provisioning-c648118fcc8f297f.yaml +++ b/releasenotes/notes/scaleio-default-volume-provisioning-c648118fcc8f297f.yaml @@ -1,5 +1,5 @@ --- upgrade: - EMC ScaleIO driver now uses the config option - san_thin_provision to determine the default + ``san_thin_provision`` to determine the default provisioning type. diff --git a/releasenotes/notes/scaleio-scaling-qos-50c58e43d4b54247.yaml b/releasenotes/notes/scaleio-scaling-qos-50c58e43d4b54247.yaml index f4968a74ee2..eeb26d55964 100644 --- a/releasenotes/notes/scaleio-scaling-qos-50c58e43d4b54247.yaml +++ b/releasenotes/notes/scaleio-scaling-qos-50c58e43d4b54247.yaml @@ -1,4 +1,4 @@ --- features: - Added support for scaling QoS in the ScaleIO driver. - The new QoS keys are maxIOPSperGB and maxBWSperGB. + The new QoS keys are ``maxIOPSperGB`` and ``maxBWSperGB``. diff --git a/releasenotes/notes/scaleio-thin-provisioning-support-9c3b9203567771dd.yaml b/releasenotes/notes/scaleio-thin-provisioning-support-9c3b9203567771dd.yaml index ce4727b9d89..d35068aeb62 100644 --- a/releasenotes/notes/scaleio-thin-provisioning-support-9c3b9203567771dd.yaml +++ b/releasenotes/notes/scaleio-thin-provisioning-support-9c3b9203567771dd.yaml @@ -2,8 +2,8 @@ features: - Added support for oversubscription in thin provisioning in the ScaleIO driver. - Volumes should have extra_specs with the key provisioning:type with value - equals to either 'thick' or 'thin'. - max_oversubscription_ratio can be defined by the global config or for - ScaleIO specific with the config option sio_max_over_subscription_ratio. - The maximum oversubscription ratio supported at the moment is 10.0. \ No newline at end of file + Volumes should have extra_specs with the key ``provisioning:type`` with value + equals to either ``thick`` or ``thin``. + ``max_oversubscription_ratio`` can be defined by the global config or for + ScaleIO specific with the config option ``sio_max_over_subscription_ratio``. + The maximum oversubscription ratio supported at the moment is 10.0. diff --git a/releasenotes/notes/use-castellan-key-manager-4911c3c4908ca633.yaml b/releasenotes/notes/use-castellan-key-manager-4911c3c4908ca633.yaml index 6113dfb0ccb..5f3312ae660 100644 --- a/releasenotes/notes/use-castellan-key-manager-4911c3c4908ca633.yaml +++ b/releasenotes/notes/use-castellan-key-manager-4911c3c4908ca633.yaml @@ -12,4 +12,4 @@ upgrade: deprecations: - All barbican and keymgr config options in Cinder are now deprecated. All of these options are moved to - the key_manager section for the Castellan library. + the ``key_manager`` section for the Castellan library. diff --git a/releasenotes/notes/vmware-vmdk-config-eb70892e4ccf8f3c.yaml b/releasenotes/notes/vmware-vmdk-config-eb70892e4ccf8f3c.yaml index 49e3a576717..f6ae4a77a58 100644 --- a/releasenotes/notes/vmware-vmdk-config-eb70892e4ccf8f3c.yaml +++ b/releasenotes/notes/vmware-vmdk-config-eb70892e4ccf8f3c.yaml @@ -1,4 +1,4 @@ --- upgrade: - - The VMware VMDK driver supports a new config option 'vmware_host_port' - to specify the port number to connect to vCenter server. \ No newline at end of file + - The VMware VMDK driver supports a new config option ``vmware_host_port`` + to specify the port number to connect to vCenter server. diff --git a/releasenotes/notes/vmware_vmdk_paravirtual-3d5eeef96dcbcfb7.yaml b/releasenotes/notes/vmware_vmdk_paravirtual-3d5eeef96dcbcfb7.yaml index c07eeff96b1..28ea6e63328 100644 --- a/releasenotes/notes/vmware_vmdk_paravirtual-3d5eeef96dcbcfb7.yaml +++ b/releasenotes/notes/vmware_vmdk_paravirtual-3d5eeef96dcbcfb7.yaml @@ -1,4 +1,4 @@ --- fixes: - - Added support for images with vmware_adaptertype set to - paraVirtual in the VMDK driver. + - Added support for images with ``vmware_adaptertype`` set to + ``paraVirtual`` in the VMDK driver.