openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Shatadru Bandyopadhyay 59176660fd doc: clarify usage of use_multipath_for_image_xfer parameter 
use_multipath_for_image_xfer and enforce_multipath_for_image_xfer need to be
used for each backend section or in [backend_defaults] section in cinder.conf
using it in default section will not have any effect.

This patch fixes multiple driver doc regarding use_multipath_for_image_xfer
and enforce_multipath_for_image_xfer parameter

also added same help text in driver.py so that the sample config file
indicates the same.

Change-Id: I5c9b3e5142833f276e10c432a7705a8cd118be7c
Closes-Bug: 1856612
 		2019-12-19 19:44:21 +05:30
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source doc: clarify usage of use_multipath_for_image_xfer parameter 2019-12-19 19:44:21 +05:30
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
requirements.txt Update docs building 2019-08-10 11:41:14 +02:00

README.rst

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

Developer documentation is built to: https://docs.openstack.org/cinder/latest/

Tools

Sphinx

The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.

Graphviz

Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs