Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This causes docs jobs to fail because we error out on warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
Removing mention of adding your name and email to Author files in
Cinder dev doc.
Change-Id: I5b723dd9ff1153096852a4c1c6a7b59bf0d04d3c
Closes-Bug: #1309581
This patch removes the implementation of ChanceScheduler and SimpleScheduler
as previous changes have made sure they are internally replaced by
FilterScheduler.
The "max_gigabytes" config option is deprecated and will leave it like that
for one more release before we can remove it.
DocImpact: "ChanceScheduler and SimpleScheduler have been deprecated and
their implementation have been removed from Cinder."
Implement bp: deprecate-chance-and-simple-schedulers
Change-Id: Ifb1cb25e3bb4cdf26fa3283336b83fce5c97141e
Fix type/misspelled words found by this handy tools:
https://github.com/lyda/misspell-check
Some 'typo's were intentional since they are part of function name,
so they are left alone.
Change-Id: I4badda869521659b541d018727a6f71f518e2ee0
Yesterday, openstack@lists.launchpad.org was migrated with
all users to openstack@list.openstack.org.
This patch updates references to the old mailing list with the
new, to ensure that people encountering them don't accidentally
try and join the old list!
Change-Id: I7cd33f95b7baa22dbd4abb6e391ee59876998f59
This is a first pass in getting information out of the wiki and into the
dev docs, so changes can be reviewed properly as discussed at the Havana
summit.
Change-Id: I75e71b3e5df69e6b507ee64d330a9ec2455266c5
Unlike other cinder-manage 'list' commands the 'config list'
option doesn't allow users to specify a filter to limit
the output. This commit adds the ability to specify
the flag the user wishes to display.
If no flag is specified the default behavior is still to
display all the configured flags. If the flag requested
is not found, cinder-manage reports that the flag was not
found.
(fixes bug 1187137)
Change-Id: I698f4c06d7e93217d8f307a880e0ae40711151c2
Corrects some rst formatting to eliminate warnings in
the documenation build.
Change-Id: I4026a1c8e7fae1928ca50d80aa1b5440faf754da
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.
blueprint oslo.sphinx
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
Replace FLAGS with cfg.CONF
Rename modules fake_flags to conf_fixture, test_flags to test_conf, declare_flags to declare_conf, runtime_flags to runtime_conf
Renamed cinder.flags, because exactly the same was done in the glance and nova
Fixes: bug #1182037
Change-Id: I3424d0a401b3ef7a3254d3e913263554361a52ff
The cinder-manage man page didn't appear to have been re-written
since splitting from Nova. There were numerous options that
no longer exist documented and references to Nova instead of
Cinder.
This version has been re-written based on the current code in
cinder-manage.
(fixes bug 1174502)
Change-Id: Ia03ca05bbd87444b2213bf719da0ffff96b67699
Rename tools/pip-requires to requirements.txt and tools/test-requires
to test-requirements.txt. These are standard files, and tools in the
general world are growing intelligence about them.
Change-Id: Ifb2735151dc8c7f89ec01d237226669f7051ffa8
Fixes: bug #1179008
Part of fixing bug #995287
Syncs these two commits from oslo-incubator:
Support overriding oslo localedir too
Add a gettextutils.install() helper function
to get a new gettextutils.install() function which allows the default
localedir to be overwritten via an environment variable.
Note that gettextutils.install() must be called before any other cinder
modules are imported since some modules attempt to translate strings
at import time (e.g. in cinder.flags). This is broken and inefficient,
but fixing it involves adding something like sphinx's l_() function and
would be very invaisve.
Change-Id: I86562b3a65d371673bb21f7179eecc7602bc0775
The gettext.install() function installs a builtin _() function which
translates a string in the translation domain supplied to the install()
function. If gettext.install() is called multiple times, it's the last
call to the function which wins and the last supplied translation domain
which is used e.g.
>>> import os
>>> os.environ['LANG'] = 'ja.UTF-8'
>>> import gettext
>>> gettext.install('keystone', unicode=1, localedir='/opt/stack/keystone/keystone/locale')
>>> print _('Invalid syslog facility')
n無効な syslog ファシリティ
>>> gettext.install('cinder', unicode=1, localedir='/opt/stack/nova/cinder/locale')
>>> print _('Invalid syslog facility')
Invalid syslog facility
Usually this function is called early on in a toplevel script and we
assume that no other code will call it and override the installed _().
However, in Cinder, we have taken a shortcut to avoid having to call it
explicitly from each script and instead call it from cinder/__init__.py.
This shortcut would be perfectly fine if we were absolutely sure that
nova modules would never be imported from another program. It's probably
quite incorrect for a program to use cinder code (indeed, if we wanted
to support this, Cinder code shouldn't use the default _() function) but
nevertheless there are some corner cases where it happens. For example,
the keystoneclient auth_token middleware tries to import cfg from
cinder.openstack and this in turn causes gettext.install('cinder') in
other projects like glance or quantum.
To avoid any doubt here, let's just rip out the shortcut and always
call gettext.install() from the top-level script.
However, there's a bit of an annoying detail here - by default,
nosetests starts in the current directly and tries to import all modules
it finds to look for tests. Without the _() builtin installed, importing
some modules like cinder.flags will fail.
Since it only ever makes sense to load tests from the cinder/tests dir,
we can ask nose to do that by using the --tests argument via setup.cfg.
Note, this means that if you previously did this:
$> tox -- cinder.tests.foo cinder.tests.bar
then you must now do this:
$> tox -- --tests cinder.tests.foo,cinder.tests.bar
Change-Id: If4125d6bcbde63df95de129ac5c83b4a6d6f130a
Dev env setup doc hasn't been updated in a while and
needed the addition of the mysql and psql packages.
Tested this on a clean install and it looks like
the addition of these two pkgs should get us up to
date.
Change-Id: I66011478064bd8fb85bfaf56e8b14232226e0efc
Way back when Cinder was inagurated as a separate project, the docs
directory from Nova was used as a seed for the one in the Cinder repo
This patch is simply cleaning out images and files which have no
relation to Cinder at all, and are at best extremely outdated when
applied to Nova.
Aside from the deletions which are mainly images, and files related
to the configuration of CloudPipe, there is one modification to
conf.py which simply removes a reference to a vmware doc that no
longer exists.
Change-Id: I2140035f98bd332f25d7dd7569993bcd960a869e
This code does not work, and is slowly being replaced by
alternative XenServer specific drivers.
Fixes LP bug #1077011
Change-Id: I1af92ecdbb49a57a0ff4c05a70d77bcb69958cb2
Sync up with changes made in Nova, this adds information
about line continuation (PEP8), OpenStack capitalization,
and commit messages.
Change-Id: Id6637307411bcc7a3637ac514c4ec34e26481e0d
* Quick pass at implementing the basics for cinder dev docs
* Remove the N/A compute related stuff
* Clean up the architecture a bit to only show cinder related
* Remove various modules form TOC's that aren't applicable
Change-Id: I0089c388524c9def7494658e836f4ed03a61f5b5
Fix some pep8 issues in doc/ext/cinder_todo.py and
doc/source/conf.py and make the code looks pretty.
Change-Id: Ie164bc7328507e20b0ab5993ba97eaadbd74bf63
* This modifies the index.rst file to give interim info about cinder
* We were regenerating the nova docs copied over which was bad!
* Fixes bug 1022315
Change-Id: I46531976f3e6521cec69cc13276d328d6c2d2da3
Cinder docs were not building because sphinx was looking for
cinder-manage.rst which did not exist. The file was simply misnamed
and renaming it to cinder-manage.rst allows the docs to build.
Change-Id: I68f4ed81230cc277a96bb34dfa172e5ce7788ac4
