cinder/doc
Gorka Eguileor dbcbfefe51 Add cinder-manage command to remove file locks
This patch adds a new subgroup of commands called `util` with a single
command ``remove_locks` that takes care of deleting locks that will no
longer be used because the resources they are related to are no longer
there.

This works for volumes and snapshots and with the cinder services
running or stopped.

It gets the file locks filtering by name (must have the "cinder-" prefix
and an UUID) and then if the service is online it will not delete file
locks for resources that are still present in the database.

Closes-Bug: #1432387
Change-Id: I2535017e112c8bcb9a2e516876f52a945e9c7da8
2021-08-04 14:42:29 +00:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Add cinder-manage command to remove file locks 2021-08-04 14:42:29 +00:00
.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 Use os-brick 4.3.0 2021-03-25 13:15:43 -04: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