32 Commits

Author SHA1 Message Date
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
lrqrun
3ed4d0b628 Fix PEP8 issues.
Fix some pep8 issues in doc/ext/cinder_todo.py make the code looks pretty.

Change-Id: I137c8bf5af30eb54a44cbff7f1fbc35bc2c3ed9e
2012-08-28 23:28:48 +08:00
Ray Chen
f80f8dfecb Fix PEP8 issues.
Fix some pep8 issues in doc/ext/cinder_todo.py and
doc/source/conf.py and make the code looks pretty.

Change-Id: Ie164bc7328507e20b0ab5993ba97eaadbd74bf63
2012-08-22 11:57:42 +08:00
John Griffith
c3bc1aa3a6 Do not duplicate nova docs in cinder
* 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
2012-07-12 13:11:54 -06:00
Clark Boylan
57d6c5d1bc Move nova-manage.rst to cinder-manage.rst.
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
2012-07-02 14:28:08 -07:00
Monty Taylor
50792c2ff4 Fix up coverage and jenkins test running.
The docs job wasn't working because of an un-renamed file.
Coverage wasn't running in jenkins with the xml output file.
Remove the .cache.bundle support that we're moving away from.

Change-Id: I1140baa53dee8b14ac4d1f8549425a0fdd7a8425
2012-05-21 16:46:25 -04:00
Jenkins
c53d8e343e Initial fork out of Nova. 2012-05-03 10:48:26 -07:00