[DOC BLD FIX] Name files for inclusion properly

The Sphinx build was issuing hundreds of warning for
duplicate labels.  The reason for this was because
all of the tables we had were named as .rst files.
This would cause Sphinx to process them twice and it would
think there were duplicated sections.

There were two ways this could be handled:  1) Exclude the tables
directory from the docs build. 2) Name the files as they should
have always been so they weren't build twice.  Given that
option 1 just masked the problem, I am implementing this
patch using option 2.

So, all the tables we are including in our documentation
have been named from .rst to .inc and the .. include::
directives that use them have also been updated to use
the new file name.

Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
This commit is contained in:
Jay S. Bryant 2017-08-04 15:33:52 -05:00
parent 8d43f6ec58
commit 986a6a015f
161 changed files with 96 additions and 96 deletions

View File

@ -42,7 +42,7 @@ To enable the Ceph backup driver, include the following option in the
The following configuration options are available for the Ceph backup
driver.
.. include:: ../../tables/cinder-backups_ceph.rst
.. include:: ../../tables/cinder-backups_ceph.inc
This example shows the default options for the Ceph backup driver.

View File

@ -15,4 +15,4 @@ To enable the GCS backup driver, include the following option in the
The following configuration options are available for the GCS backup
driver.
.. include:: ../../tables/cinder-backups_gcs.rst
.. include:: ../../tables/cinder-backups_gcs.inc

View File

@ -14,4 +14,4 @@ To enable the GlusterFS backup driver, include the following option in the
The following configuration options are available for the GlusterFS backup
driver.
.. include:: ../../tables/cinder-backups_glusterfs.rst
.. include:: ../../tables/cinder-backups_glusterfs.inc

View File

@ -15,4 +15,4 @@ To enable the NFS backup driver, include the following option in the
The following configuration options are available for the NFS back-end
backup driver.
.. include:: ../../tables/cinder-backups_nfs.rst
.. include:: ../../tables/cinder-backups_nfs.inc

View File

@ -15,4 +15,4 @@ option in the ``cinder.conf`` file:
The following configuration options are available for the POSIX
file systems backup driver.
.. include:: ../../tables/cinder-backups_posix.rst
.. include:: ../../tables/cinder-backups_posix.inc

View File

@ -15,7 +15,7 @@ To enable the swift backup driver, include the following option in the
The following configuration options are available for the Swift back-end
backup driver.
.. include:: ../../tables/cinder-backups_swift.rst
.. include:: ../../tables/cinder-backups_swift.inc
To enable the swift backup driver for 1.0, 2.0, or 3.0 authentication version,
specify ``1``, ``2``, or ``3`` correspondingly. For example:

View File

@ -20,7 +20,7 @@ To enable the IBM TSM backup driver, include the following option in
The following configuration options are available for the TSM backup
driver.
.. include:: ../../tables/cinder-backups_tsm.rst
.. include:: ../../tables/cinder-backups_tsm.inc
This example shows the default options for the TSM backup driver.

View File

@ -4,32 +4,32 @@ Additional options
These options can also be set in the ``cinder.conf`` file.
.. include:: ../tables/cinder-api.rst
.. include:: ../tables/cinder-auth.rst
.. include:: ../tables/cinder-backups.rst
.. include:: ../tables/cinder-block-device.rst
.. include:: ../tables/cinder-common.rst
.. include:: ../tables/cinder-compute.rst
.. include:: ../tables/cinder-coordination.rst
.. include:: ../tables/cinder-debug.rst
.. include:: ../tables/cinder-drbd.rst
.. include:: ../tables/cinder-emc.rst
.. include:: ../tables/cinder-eternus.rst
.. include:: ../tables/cinder-flashsystem.rst
.. include:: ../tables/cinder-hgst.rst
.. include:: ../tables/cinder-hpelefthand.rst
.. include:: ../tables/cinder-hpexp.rst
.. include:: ../tables/cinder-huawei.rst
.. include:: ../tables/cinder-hyperv.rst
.. include:: ../tables/cinder-images.rst
.. include:: ../tables/cinder-nas.rst
.. include:: ../tables/cinder-profiler.rst
.. include:: ../tables/cinder-pure.rst
.. include:: ../tables/cinder-quota.rst
.. include:: ../tables/cinder-redis.rst
.. include:: ../tables/cinder-san.rst
.. include:: ../tables/cinder-scheduler.rst
.. include:: ../tables/cinder-scst.rst
.. include:: ../tables/cinder-storage.rst
.. include:: ../tables/cinder-tegile.rst
.. include:: ../tables/cinder-zones.rst
.. include:: ../tables/cinder-api.inc
.. include:: ../tables/cinder-auth.inc
.. include:: ../tables/cinder-backups.inc
.. include:: ../tables/cinder-block-device.inc
.. include:: ../tables/cinder-common.inc
.. include:: ../tables/cinder-compute.inc
.. include:: ../tables/cinder-coordination.inc
.. include:: ../tables/cinder-debug.inc
.. include:: ../tables/cinder-drbd.inc
.. include:: ../tables/cinder-emc.inc
.. include:: ../tables/cinder-eternus.inc
.. include:: ../tables/cinder-flashsystem.inc
.. include:: ../tables/cinder-hgst.inc
.. include:: ../tables/cinder-hpelefthand.inc
.. include:: ../tables/cinder-hpexp.inc
.. include:: ../tables/cinder-huawei.inc
.. include:: ../tables/cinder-hyperv.inc
.. include:: ../tables/cinder-images.inc
.. include:: ../tables/cinder-nas.inc
.. include:: ../tables/cinder-profiler.inc
.. include:: ../tables/cinder-pure.inc
.. include:: ../tables/cinder-quota.inc
.. include:: ../tables/cinder-redis.inc
.. include:: ../tables/cinder-san.inc
.. include:: ../tables/cinder-scheduler.inc
.. include:: ../tables/cinder-scst.inc
.. include:: ../tables/cinder-storage.inc
.. include:: ../tables/cinder-tegile.inc
.. include:: ../tables/cinder-zones.inc

View File

@ -196,7 +196,7 @@ scheduling capabilities.
Configuration options
~~~~~~~~~~~~~~~~~~~~~
.. include:: ../../tables/cinder-blockbridge.rst
.. include:: ../../tables/cinder-blockbridge.inc
.. _cg_configuration_example:

View File

@ -106,4 +106,4 @@ Ceph RADOS Block Device driver.
The ``volume_tmp_dir`` option has been deprecated and replaced by
``image_conversion_dir``.
.. include:: ../../tables/cinder-storage_ceph.rst
.. include:: ../../tables/cinder-storage_ceph.inc

View File

@ -5,4 +5,4 @@ CloudByte volume driver
CloudByte Block Storage driver configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. include:: ../../tables/cinder-cloudbyte.rst
.. include:: ../../tables/cinder-cloudbyte.inc

View File

@ -90,4 +90,4 @@ Coho Data Block Storage driver configuration
#. Restart the ``cinder-volume`` service to enable Coho Data driver.
.. include:: ../../tables/cinder-coho.rst
.. include:: ../../tables/cinder-coho.inc

View File

@ -45,7 +45,7 @@ Driver options
The following table contains the configuration options specific to the
CoprHD volume driver.
.. include:: ../../tables/cinder-coprhd.rst
.. include:: ../../tables/cinder-coprhd.inc
Preparation

View File

@ -32,7 +32,7 @@ Prerequisites
* open-iscsi-utils
* wget
.. include:: ../../tables/cinder-datera.rst
.. include:: ../../tables/cinder-datera.inc

View File

@ -278,4 +278,4 @@ Configuration options
The ScaleIO driver supports these configuration options:
.. include:: ../../tables/cinder-emc_sio.rst
.. include:: ../../tables/cinder-emc_sio.inc

View File

@ -159,7 +159,7 @@ Driver configuration
Driver options
~~~~~~~~~~~~~~
.. include:: ../../tables/cinder-dell_emc_unity.rst
.. include:: ../../tables/cinder-dell_emc_unity.inc
FC or iSCSI ports option
------------------------

View File

@ -28,7 +28,7 @@ dependent upon the generic block storage driver's SSH settings in the
``/etc/cinder/cinder.conf`` file (see
:ref:`block-storage-sample-configuration-file` for reference).
.. include:: ../../tables/cinder-eqlx.rst
.. include:: ../../tables/cinder-eqlx.inc
Default (single-instance) configuration
---------------------------------------

View File

@ -358,4 +358,4 @@ Driver options
The following table contains the configuration options specific to the
Dell Storage Center volume driver.
.. include:: ../../tables/cinder-dellsc.rst
.. include:: ../../tables/cinder-dellsc.inc

View File

@ -165,4 +165,4 @@ Driver-specific options
The following table contains the configuration options that are specific
to the Dot Hill drivers.
.. include:: ../../tables/cinder-dothill.rst
.. include:: ../../tables/cinder-dothill.inc

View File

@ -53,7 +53,7 @@ under a separate section in case of multiple back ends (for example
[XTREMIO]). The configuration file is usually located under the
following path ``/etc/cinder/cinder.conf``.
.. include:: ../../tables/cinder-emc_xtremio.rst
.. include:: ../../tables/cinder-emc_xtremio.inc
For a configuration example, refer to the configuration
:ref:`emc_extremio_configuration_example`.

View File

@ -114,4 +114,4 @@ Driver options
The following table contains the configuration options specific to the
FalconStor FSS storage volume driver.
.. include:: ../../tables/cinder-falconstor.rst
.. include:: ../../tables/cinder-falconstor.inc

View File

@ -155,7 +155,7 @@ Set up Hitachi storage volume driver
This table shows configuration options for Hitachi storage volume driver.
.. include:: ../../tables/cinder-hitachi-hbsd.rst
.. include:: ../../tables/cinder-hitachi-hbsd.inc
#. Restart the Block Storage service.

View File

@ -162,4 +162,4 @@ Driver-specific options
The following table contains the configuration options that are specific to
the HP MSA drivers.
.. include:: ../../tables/cinder-hpmsa.rst
.. include:: ../../tables/cinder-hpmsa.inc

View File

@ -381,4 +381,4 @@ service log files for errors.
The following table contains all the configuration options supported by
the HPE 3PAR Fibre Channel and iSCSI drivers.
.. include:: ../../tables/cinder-hpe3par.rst
.. include:: ../../tables/cinder-hpe3par.inc

View File

@ -74,7 +74,7 @@ in the ``cinder.conf`` as:
The following table contains the configuration options supported by the
Spectrum Scale driver in this deployment mode.
.. include:: ../../tables/cinder-ibm_gpfs.rst
.. include:: ../../tables/cinder-ibm_gpfs.inc
.. note::
@ -114,7 +114,7 @@ in the ``cinder.conf`` as:
The following table contains the configuration options supported by the
Spectrum Scale driver in this deployment mode.
.. include:: ../../tables/cinder-ibm_gpfs_remote.rst
.. include:: ../../tables/cinder-ibm_gpfs_remote.inc
.. note::
@ -149,7 +149,7 @@ in the ``cinder.conf`` as:
The following table contains the configuration options supported by the
Spectrum Scale driver in this deployment mode.
.. include:: ../../tables/cinder-ibm_gpfs_nfs.rst
.. include:: ../../tables/cinder-ibm_gpfs_nfs.inc
Additionally, all the options of the base NFS driver are applicable
for GPFSNFSDriver. The above table lists the basic configuration

View File

@ -51,7 +51,7 @@ follows:
volume_driver = cinder.volume.drivers.ibm.ibm_storage.IBMStorageDriver
.. include:: ../../tables/cinder-ibm_storage.rst
.. include:: ../../tables/cinder-ibm_storage.inc

View File

@ -230,7 +230,7 @@ Storwize family and SVC driver options in cinder.conf
The following options specify default values for all volumes. Some can
be over-ridden using volume types, which are described below.
.. include:: ../../tables/cinder-storwize.rst
.. include:: ../../tables/cinder-storwize.inc
Note the following:

View File

@ -179,4 +179,4 @@ Driver-specific options
The following table contains the configuration options that are specific
to the INFINIDAT driver.
.. include:: ../../tables/cinder-infinidat.rst
.. include:: ../../tables/cinder-infinidat.inc

View File

@ -52,7 +52,7 @@ On ``cinder-volume`` nodes, set the following in your
Driver options
--------------
.. include:: ../../tables/cinder-infortrend.rst
.. include:: ../../tables/cinder-infortrend.inc
iSCSI configuration example
---------------------------

View File

@ -21,4 +21,4 @@ The DISCO driver supports the following features:
Configuration options
~~~~~~~~~~~~~~~~~~~~~
.. include:: ../../tables/cinder-disco.rst
.. include:: ../../tables/cinder-disco.inc

View File

@ -270,4 +270,4 @@ Driver options
The following table contains the configuration options that are specific
to the Kaminario K2 FC and iSCSI Block Storage drivers.
.. include:: ../../tables/cinder-kaminario.rst
.. include:: ../../tables/cinder-kaminario.inc

View File

@ -156,4 +156,4 @@ Driver-specific options
The following table contains the configuration options that are specific
to the Lenovo drivers.
.. include:: ../../tables/cinder-lenovo.rst
.. include:: ../../tables/cinder-lenovo.inc

View File

@ -22,7 +22,7 @@ Use the following options to configure for the iSER transport:
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iser
.. include:: ../../tables/cinder-lvm.rst
.. include:: ../../tables/cinder-lvm.inc
.. caution::

View File

@ -112,7 +112,7 @@ Also, set ``volume_backend_name``.
This table shows configuration options for NEC Storage M series driver.
.. include:: ../../tables/cinder-nec_m.rst
.. include:: ../../tables/cinder-nec_m.inc

View File

@ -96,7 +96,7 @@ setting the ``volume_driver``, ``netapp_storage_family`` and
To use the iSCSI protocol, you must override the default value of
``netapp_storage_protocol`` with ``iscsi``.
.. include:: ../../tables/cinder-netapp_cdot_iscsi.rst
.. include:: ../../tables/cinder-netapp_cdot_iscsi.inc
.. note::
@ -151,7 +151,7 @@ options in the ``cinder.conf`` file as follows:
netapp_password = password
nfs_shares_config = /etc/cinder/nfs_shares
.. include:: ../../tables/cinder-netapp_cdot_nfs.rst
.. include:: ../../tables/cinder-netapp_cdot_nfs.inc
.. note::
@ -263,7 +263,7 @@ extra specs. Use the specs in the following table to configure volumes.
Define Block Storage volume types by using the :command:`openstack volume
type set` command.
.. include:: ../../tables/manual/cinder-netapp_cdot_extraspecs.rst
.. include:: ../../tables/manual/cinder-netapp_cdot_extraspecs.inc
NetApp Data ONTAP operating in 7-Mode storage family
@ -310,7 +310,7 @@ setting the ``volume_driver``, ``netapp_storage_family`` and
To use the iSCSI protocol, you must override the default value of
``netapp_storage_protocol`` with ``iscsi``.
.. include:: ../../tables/cinder-netapp_7mode_iscsi.rst
.. include:: ../../tables/cinder-netapp_7mode_iscsi.inc
.. note::
@ -362,7 +362,7 @@ the ``volume_driver``, ``netapp_storage_family`` and
netapp_password = password
nfs_shares_config = /etc/cinder/nfs_shares
.. include:: ../../tables/cinder-netapp_7mode_nfs.rst
.. include:: ../../tables/cinder-netapp_7mode_nfs.inc
.. note::
@ -439,7 +439,7 @@ NetApp unified driver, E-Series, and iSCSI respectively by setting the
To use the iSCSI protocol, you must override the default value of
``netapp_storage_protocol`` with ``iscsi``.
.. include:: ../../tables/cinder-netapp_eseries_iscsi.rst
.. include:: ../../tables/cinder-netapp_eseries_iscsi.inc
.. tip::

View File

@ -156,4 +156,4 @@ Driver options
Nexenta Driver supports these options:
.. include:: ../../tables/cinder-nexenta_edge.rst
.. include:: ../../tables/cinder-nexenta_edge.inc

View File

@ -138,4 +138,4 @@ Driver options
Nexenta Driver supports these options:
.. include:: ../../tables/cinder-nexenta.rst
.. include:: ../../tables/cinder-nexenta.inc

View File

@ -150,4 +150,4 @@ Driver options
Nexenta Driver supports these options:
.. include:: ../../tables/cinder-nexenta5.rst
.. include:: ../../tables/cinder-nexenta5.inc

View File

@ -33,7 +33,7 @@ in the ``cinder.conf`` configuration file:
The following table contains the options supported by the NFS driver.
.. include:: ../../tables/cinder-storage_nfs.rst
.. include:: ../../tables/cinder-storage_nfs.inc
.. note::

View File

@ -131,4 +131,4 @@ Configuration options
The Nimble storage driver supports these configuration options:
.. include:: ../../tables/cinder-nimble.rst
.. include:: ../../tables/cinder-nimble.inc

View File

@ -101,4 +101,4 @@ service log files for errors.
The following table contains the options supported by the ProphetStor
storage driver.
.. include:: ../../tables/cinder-prophetstor_dpl.rst
.. include:: ../../tables/cinder-prophetstor_dpl.inc

View File

@ -58,4 +58,4 @@ To activate the Quobyte volume driver, configure the corresponding
The following table contains the configuration options supported by the
Quobyte driver:
.. include:: ../../tables/cinder-quobyte.rst
.. include:: ../../tables/cinder-quobyte.inc

View File

@ -65,4 +65,4 @@ file:
scality_sofs_mount_point = /cinder
scality_sofs_config = /etc/sfused.conf
.. include:: ../../tables/cinder-scality.rst
.. include:: ../../tables/cinder-scality.inc

View File

@ -45,4 +45,4 @@ Set the following option in the ``cinder.conf`` file:
The following table contains the configuration options supported by the
Sheepdog driver:
.. include:: ../../tables/cinder-sheepdog.rst
.. include:: ../../tables/cinder-sheepdog.inc

View File

@ -14,4 +14,4 @@ your ``cinder.conf`` file, and use the following options to configure it.
volume_driver = cinder.volume.drivers.smbfs.SmbfsDriver
.. include:: ../../tables/cinder-smbfs.rst
.. include:: ../../tables/cinder-smbfs.inc

View File

@ -48,7 +48,7 @@ To configure the use of a SolidFire cluster with Block Storage, modify your
deployment it is recommended to add the Cluster as if it were a second
backend and disable new deployments to the current back end.
.. include:: ../../tables/cinder-solidfire.rst
.. include:: ../../tables/cinder-solidfire.inc
Supported operations
~~~~~~~~~~~~~~~~~~~~

View File

@ -121,4 +121,4 @@ Configuration options
The Synology DSM driver supports the following configuration options:
.. include:: ../../tables/cinder-synology.rst
.. include:: ../../tables/cinder-synology.inc

View File

@ -78,4 +78,4 @@ following actions:
{vmstore_data_ip}:/tintri/{submount2}
.. include:: ../../tables/cinder-tintri.rst
.. include:: ../../tables/cinder-tintri.inc

View File

@ -56,7 +56,7 @@ driver:
The following table lists various options that the drivers support for the
OpenStack Block Storage configuration (``cinder.conf``):
.. include:: ../../tables/cinder-vmware.rst
.. include:: ../../tables/cinder-vmware.inc
VMDK disk type
~~~~~~~~~~~~~~

View File

@ -11,4 +11,4 @@ options to configure it.
volume_driver = cinder.volume.drivers.vzstorage.VZStorageDriver
.. include:: ../../tables/cinder-vzstorage.rst
.. include:: ../../tables/cinder-vzstorage.inc

View File

@ -107,7 +107,7 @@ configuration sample for using the Windows iSCSI Driver:
The following table contains a reference to the only driver specific
option that will be used by the Block Storage Windows driver:
.. include:: ../../tables/cinder-windows.rst
.. include:: ../../tables/cinder-windows.inc
Run cinder-volume
-----------------

View File

@ -57,7 +57,7 @@ iSCSI
Optional configuration parameters
---------------------------------
.. include:: ../../tables/cinder-xio.rst
.. include:: ../../tables/cinder-xio.inc
Multipath
---------

View File

@ -73,7 +73,7 @@ Driver-specific options
This section contains the configuration options that are specific
to the Zadara Storage VPSA driver.
.. include:: ../../tables/cinder-zadara.rst
.. include:: ../../tables/cinder-zadara.inc
.. note::

View File

@ -262,4 +262,4 @@ Driver options
The Oracle ZFSSA iSCSI Driver supports these options:
.. include:: ../../tables/cinder-zfssa-iscsi.rst
.. include:: ../../tables/cinder-zfssa-iscsi.inc

View File

@ -291,7 +291,7 @@ Driver options
The Oracle ZFS Storage Appliance NFS driver supports these options:
.. include:: ../../tables/cinder-zfssa-nfs.rst
.. include:: ../../tables/cinder-zfssa-nfs.inc
This driver shares additional NFS configuration options with the generic
NFS driver. For a description of these, see :ref:`cinder-storage_nfs`.

View File

@ -155,4 +155,4 @@ Driver-specific options
The following table contains the configuration options that are specific
to the ZTE drivers.
.. include:: ../../tables/cinder-zte.rst
.. include:: ../../tables/cinder-zte.inc

View File

@ -19,7 +19,7 @@ configuration options to enable Fibre Channel Zone Manager.
Make the following changes in the ``/etc/cinder/cinder.conf`` file.
.. include:: ../tables/cinder-zoning.rst
.. include:: ../tables/cinder-zoning.inc
To use different Fibre Channel Zone Drivers, use the parameters
described in this section.
@ -48,12 +48,12 @@ through HTTP, HTTPS, or SSH.
Set the following options in the ``cinder.conf`` configuration file.
.. include:: ../tables/cinder-zoning_manager_brcd.rst
.. include:: ../tables/cinder-zoning_manager_brcd.inc
Configure SAN fabric parameters in the form of fabric groups as
described in the example below:
.. include:: ../tables/cinder-zoning_fabric_brcd.rst
.. include:: ../tables/cinder-zoning_fabric_brcd.inc
.. note::
@ -99,12 +99,12 @@ Set the following options in the ``cinder.conf`` configuration file.
fc_fabric_names = CISCO_FABRIC_EXAMPLE
cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.CiscoFCZoneClientCLI
.. include:: ../tables/cinder-zoning_manager_cisco.rst
.. include:: ../tables/cinder-zoning_manager_cisco.inc
Configure SAN fabric parameters in the form of fabric groups as
described in the example below:
.. include:: ../tables/cinder-zoning_fabric_cisco.rst
.. include:: ../tables/cinder-zoning_fabric_cisco.inc
.. note::

Some files were not shown because too many files have changed in this diff Show More