Alembic does lots of new things. Provide docs for how to use this. This
doesn't actually work that well at the moment because it appears our
database migrations are not in sync with the models. Those issues will
have to be resolved separately.
Change-Id: I6645ca951114b94ce9ed5a83e5e11d53879a7cd5
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Add a "mypy" tox environment which runs mypy
type checking against Cinder code.
Taken from Stephen Finucane's Nova work at
https://review.opendev.org/#/c/676208/
Added "show_error_codes" and "pretty" options.
Generates an html report in ./mypy-report/
This adds stubs for oslo.i18n, so that _() calls
are annotated as intended. It may be possible to
do this with less .pyi files carried along here.
Change-Id: I2589d22c1f16f2e177d34730a520591743c0c1e3
When reno 3.x runs under setuptools, it scans all of the branches it can
find, including any that look like they're closed and have an -eol tag.
The old kilo branch in this repository has a jumbled history that
somehow makes it look like it should include tags that it doesn't. We
know that there are no release notes in that branch, because reno wasn't
adopted while it was open. The releasenotes/source/index.rst links to
separate release notes in the wiki.
This patch tells reno to ignore that branch so that it doesn't throw an
exception when it gets confused about the old tag.
Change-Id: Idd56c3f37d5786daae7181c36d38d267cbf1885c
Co-Authored-By: Doug Hellmann <doug@doughellmann.com>
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit adds doc/source/_static/cinder.policy.yaml.sample to
.gitignore which is created by sphinx build.
Change-Id: I6f80c766fed3a98d050290be179b91b218bedcef
There have been a number of changes to LOCI since the introduction
of BlockBox. In particular LOCI now offers a `universal` Dockerfile
and employees bindeps and new ARGS features of Docker to customize
images.
This patch modifies BlockBox to use the new universal LOCI repo and
also cleans up a bunch of cruft and adds an updated conf entry with
key-manager.
This patch also removes the dev environment as it's out dated and
doesn't seem to be gaining much usage. It's easy enough to set
this up on your own, so rather than maintain it just remove it.
Change-Id: Id03ff9310fd53c4e6df300f2866b7a17cba82561
We have tox -e gendriverlist that outputs an RST-ish report of all drivers
in the tree. This output can be used in the docs build to automatically
publish the list of drivers to make it easier to find officially supported
drivers.
This effectively removes the existing drivers.html that was generated prior
that did not actually contain any useful information.
Change-Id: I8de78723af76aabcc976733ac4b248db0b8ca16f
The oslo sphinxconfiggen module was added to the oslo.config
2.3.0 release. This enables config file generation as part of
the sphinx doc generation.
The generated config file will pick up the current config
options from the code base. And as an added bonus, it will
now be published to the docs.openstack.org site for easy
reference or download.
This also puts us inline with what other projects like Nova
are doing for sample config files and is the recommended
method from the Oslo team.
Change-Id: I912a97eb2686d3dc56e50d8641d7bd930179bc18
This patch is for converting API Reference to RST and host it
in the Cinder tree.
This patch contains all the RST for cinder to bring over to their
repos to begin building API reference information from within.
This contains .inc files which have all the contents of the .rst files
but are grouped together for easier editing
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API.
Cleaning task will be done once this part is merged.
As we have removed XML API support in Newton release, we need to
remove XML from API reference as well.
But we still have installations which are using XML.
So implementation plan is to first merge this patch in Newton release
keeping XML for now, then I will backport same to stable branches.
After that I will remove same from Newton release to match API
reference with actual API implementation.
Implements: bp api-reference-to-rst
Change-Id: I865ac922538bfa5bd45c24eb4bc49f5e966dc811
Now that we have some sort of conf checking again in the
tox ini file, we should make sure we don't inadvertenly
commit a generated sample (which I've done twice now).
Change-Id: I51124971ee52a1caf48123c5c2df2759bbcc045d
Ignore all dotfiles in the base dir of the tree except for
.gitignore, .coveragerc, .mailmap, and .testr.conf.
This should solve the "ignore my IDE's files" problem in a
general way.
Change-Id: Ia53fff4b97e4e99b6827030573973377beddb22b
To ignore swap files from getting into repository
currently the implemented ignore is *.swp
however vim adds more swap files if .swp exists,
so improving this with .*.sw?
Closes-Bug: #1255857
Change-Id: I22b6fa351dd565d4783f432c01785c706acd8397
Like some of the other projects (nova, heat, oslo) git ignore eclipse
project files. This will remove manual steps for people developing from
eclipse.
Change-Id: Ib908c8d419072b440f5ec647bea8f13b97e48f7c
lintstack is a pylint-based static analysis tool to find bugs
in Python code.
To run the test via tox: $ tox -e pylint
To run the test directly: $ tools/lintstack.sh
Change-Id: If155f47ed84eb820ac505ee741bdd18edd41b1eb
Stephen Finucane