56 Commits

Author SHA1 Message Date
Jenkins
6199485a71 Merge "Introduce Guru Meditation Reports into Cinder" 2015-06-16 16:53:06 +00:00
Victor Stinner
8e63cccb65 Replace xrange() with six.moves.range()
Add "from six.moves import range" to replace the builtin range()
function with six.moves.range() to always create an iterator, instead of
creating a temporary list.

Replace "xrange" with "range".

Don't add the import for ranges of 1024 items or less.

Blueprint cinder-python3
Change-Id: If618b4e810e444f7eb6592bb2398805e9d14d548
2015-06-16 10:46:40 +02:00
wanghao
f2dc050e4d Introduce Guru Meditation Reports into Cinder
This commit integrates functionality from the
`openstack.common.report` module into Cinder.
This enables Cinder services to receive SIGUSR1
and print a Guru Meditation Report to stderr.
The required modules were added to
'openstack-common.conf' as well.

It is essentially a copy from implementation of
nova side.

Change-Id: I5bbdc0f97db9b0ebd7b48e50ab7869e2ca33aead
Implements: blueprint guru-meditation-report
2015-06-16 12:01:28 +08:00
Fabien Boucher
b57cc41d93 Complete the doc/README.rst instructions to build docs
Give instructions about how to build the docs using tox
and virtualenv.

Change-Id: I3d7cdbd848158307706d94ee8a35b3b35911900d
2015-04-16 08:13:04 +00:00
Abel Lopez
fa98f4722f cinder-manage man update
Adding section for cinder-manage db purge which was added with
https://review.openstack.org/#/c/146766

Change-Id: Ie84d7b11e60dbbc9d2da8d8ae137310c280d3897
2015-02-24 12:49:44 -08:00
liyingjun
05a6ad4b4f Fixes a small issue in find_autodoc_modules.sh
When generating docs, the modules listed under api all seem to be
missing the first letter after "cinder." at the beginning.

Change-Id: I924e55642350d3bb813ebab7cb978915fdd8b964
Closes-bug: #1408828
2015-01-23 14:38:44 +08:00
Jeremy Stanley
0ced872d5f Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I1e0c546a72c75193e8c742c02dc189d178a0312c
2014-12-05 04:39:45 +00:00
Mathieu Gagné
edd69bf358 Fix find_autodoc_modules.sh to support OSX
When running 'find cinder/' on OSX platforms, all returned paths
will have 2 slashes (//). Because the script only strips
the first slash as per the CINDER_DIR value, we end up
with module names such as "cinder..db.api" in the documentation.

This change trims the leading dot if found to avoid this situation.

Change-Id: I9423b253d9842295850f469757e928bf5856967a
2014-12-01 15:13:28 -05:00
git-harry
0106c02057 Update prerequisite packages in development docs
The packages listed for Linux distros are updated to meet the
prerequisites to run the unit tests.

Change-Id: Iedd9e4d04d7700d418ddb07881ac76ad758466cb
Closes-bug: #1367670
2014-11-19 23:09:36 +00:00
yatin karel
b7b7fc4099 Documentation Bug fix committed
I have corrected the spelling mistakes, that were described in the bug.

Change-Id: I53371b9a70651078bf051d6bc384d1107724d39b
Closes-Bug: #1393133
2014-11-16 18:11:03 +05:30
Alberto Planas
72bc39c946 Adds openSUSE support for developer documentation
Add information for openSUSE as developer platform.

Change-Id: I3d5429f78b06cd38b10756570acea96fb23ed021
2014-09-29 17:25:10 +02:00
Jenkins
a530c5dd05 Merge "Stop using intersphinx" 2014-09-18 06:49:17 +00:00
Jenkins
58eda5d1f4 Merge "Fix help for running specified unit tests" 2014-09-15 08:28:25 +00:00
Andreas Jaeger
3ab7af8dc1 Stop using intersphinx
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
2014-09-12 22:40:23 +02:00
Ivan Kolodyazhny
8d4e09d630 Fix help for running specified unit tests
Change-Id: I385fcf88ae6a2e839c99ef13cd4f410ce3c0ee5f
2014-09-05 12:39:03 +03:00
James Carey
ac33ad9ec9 Use oslo.i18n
oslo.i18n provides the i18n function that were provided by
oslo-incubator's gettextutils module.

Change-Id: I1f361a8321fb02f03b4f3f3e2ef688fcf19514a3
2014-08-08 17:26:41 -05:00
liyingjun
6eba7aa103 fix a small typo in development.environment.rst
virutalenv ==> virtualenv

Change-Id: If090ab7b92230fba15d7be98a84b51cce507bedd
Closes-bug: 1358531
2014-08-08 15:04:35 +08:00
Eiichi Aikawa
11c268bd69 Remove definition of Python Source Code Encodings
The definition of Python Source Code Encodings is no longer needed.
This patch remove those.

Change-Id: I3eebb245e9e41b92c9ec82ebbd2dd6b417704819
2014-07-10 17:33:01 +09:00
Veronica Musso
22d0c38bb9 Update Cinder dev doc
Removing mention of adding your name and email to Author files in
Cinder dev doc.

Change-Id: I5b723dd9ff1153096852a4c1c6a7b59bf0d04d3c
Closes-Bug: #1309581
2014-04-16 08:16:30 -03:00
Jenkins
09de7d676d Merge "Switch over to oslosphinx" 2014-03-15 17:29:03 +00:00
Dirk Mueller
ea7d4a5992 Switch over to oslosphinx
oslosphinx is the new name of oslo.sphinx

Closes-Bug: #1277168
Change-Id: Ib30a4a5eb3a86ad5c03324a59e1a8ee4d4897a70
2014-03-11 14:19:23 +01:00
Joe Gordon
49deb5c304 Add libffi-dev to list of packages to install in dev env
libffi-dev is needed by cffi

Change-Id: Ib91bd2e1a1005dc96f9d9054ae5cb150c5fae7db
2014-03-11 03:38:17 +00:00
Zhiteng Huang
cea7fe21ce Drop Chance/SimpleScheduler Implementation
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
2014-01-09 18:29:27 +08:00
Zhiteng Huang
2e0d1f41ec Fix typo/misspelled words
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
2013-12-03 22:49:12 +08:00
Sean Roberts
338b282283 replace u\2013 char with dash
unicode char causes problems with maven build.

backport:none

closes-bug: #1246569

Change-Id: I3aa5c2debaed03acd2c2fb8d4e7c30738d35f4f3
2013-10-30 22:21:04 -07:00
Jenkins
911ba40af6 Merge "Changed header from LLC to Foundation based on trademark policies" 2013-10-02 22:33:50 +00:00
Chang Bo Guo
765e86e72f Use built-in print() instead of print statement
In python 3 print statement is not supported, so we should use
only print() functions.

Fixes bug 1226943

Change-Id: I7b2e4d52fe9050f6a67c44e4cc1237a15ea90b23
2013-09-18 08:44:28 -07:00
Dirk Mueller
45a3b4471d Changed header from LLC to Foundation based on trademark policies
Fixes: Bug 1214176

Change-Id: Ieda1a75992abec647c267faa7727f5da4f7a88a3
2013-09-10 17:26:42 +02:00
Tom Fifield
19f549f3a3 Update references with new Mailing List location
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
2013-07-28 12:08:20 -07:00
Mike Perez
72ebea66b6 Adding driver minimum features and volume stats to dev doc
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
2013-07-23 23:14:55 -07:00
Jay S. Bryant
15bd189235 Add flag argument to 'cinder-manage config list'
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
2013-07-15 13:40:38 -05:00
Jenkins
d72c7b6abd Merge "Fix a few Sphinx warnings" 2013-07-13 16:10:41 +00:00
Jenkins
3dc700cd60 Merge "Sync install_venv_common from oslo" 2013-07-10 05:27:14 +00:00
Monty Taylor
102c6ea2f0 Sync install_venv_common from oslo
Also grab a related doc reference while we're at it.

Change-Id: I2590970767f043f35a62a4dfa94be4ee86fbf138
2013-07-05 22:37:43 -04:00
Doug Hellmann
17e8d9cf8a Fix a few Sphinx warnings
Corrects some rst formatting to eliminate warnings in
the documenation build.

Change-Id: I4026a1c8e7fae1928ca50d80aa1b5440faf754da
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2013-07-05 16:09:50 -04:00
Doug Hellmann
8b1ae18ba9 Use oslo.sphinx and remove local copy of doc theme
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
2013-07-05 16:09:50 -04:00
Sergey Vilgelm
45a1a564c0 Rename cinder.flags to cinder.common.config
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
2013-07-03 11:28:57 +04:00
Dirk Mueller
5e1502ad89 Fix various Sphinx warnings
Change-Id: I68c9ff6fdf9115d1abb0fb756eb806b92af29286
2013-06-12 15:21:40 +02:00
Jay S. Bryant
4f242adb4e Re-write of the cinder-manage man page.
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
2013-06-03 15:50:09 -05:00
Zhenguo Niu
15a907c491 Rename requires files to standard names.
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
2013-05-31 06:09:05 +08:00
annegentle
e7846829f8 Removes a broken link from the sidebar of Sphinx built pages.
Change-Id: I1c24f015bd8b67b1dc85eda67a0669ac79ca282b
2013-05-21 20:05:11 -05:00
Mark McLoughlin
68f28d257c Add CINDER_LOCALEDIR env variable
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
2013-05-13 23:17:59 +08:00
Mark McLoughlin
7cfb0388ff Remove gettext.install() from cinder/__init__.py
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
2013-05-13 18:45:25 +08:00
Yun Mao
7dad062dd6 Remove outdated cinder test doc
cinder doesn't run pylint test. This was a left over from the
fork in nova-volume.

Change-Id: Id096ec97b37a2019baf7a0b55bfd5bce4e71908f
2013-05-09 17:58:28 -04:00
John Griffith
cb3fb51be8 Add db client packages to dev env setup doc.
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
2013-05-06 10:18:48 -06:00
Tom Fifield
762f2e19cf Cinder devref doc cleanups
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
2013-02-21 21:10:16 +11:00
Monty Taylor
b390454b6d Update to latest oslo-version code.
In prep for tag-based versioning, update to latest oslo-version code.

Change-Id: Ic5046006919e20247481fa1ddbde2dfd456b188a
2013-02-07 02:29:27 -06:00
John Garbutt
aa87498199 Removes the xensm driver
This code does not work, and is slowly being replaced by
alternative XenServer specific drivers.

Fixes LP bug #1077011

Change-Id: I1af92ecdbb49a57a0ff4c05a70d77bcb69958cb2
2012-11-20 14:47:14 +00:00
Eric Harney
b3b1d48d53 Update HACKING.rst and related changes from Nova/PEP8.
Sync up with changes made in Nova, this adds information
about line continuation (PEP8), OpenStack capitalization,
and commit messages.

Change-Id: Id6637307411bcc7a3637ac514c4ec34e26481e0d
2012-10-22 18:41:16 -04:00
John Griffith
922fdd0bdc Update dev docs
* 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
2012-09-03 17:18:10 -06:00