Noticed that a fix has been released to the issue "Create a git.openstack.org mirror system":
https://bugs.launchpad.net/openstack-ci/+bug/1182179
jd released a fix to "replace GitHub by git.openstack.org" in the documentation:
https://review.openstack.org/#/c/43661/
References:
- http://princessleia.com/journal/?p=8412
- http://lists.openstack.org/pipermail/openstack-dev/2013-August/014174.html
The main point is that review.openstack.org will now have a non-commercial
(not GitHub) mirror hosted at git.openstack.org. It is important for
OpenStack to have their own mirror/backup and not depend on an external company.
The GitHub mirror will be kept around, but in the documentation, the official
policy is now to tell people to clone the repos from git.openstack.org and not
GitHub.
-
Reviewed jd's patch "Remove useless doc/requirements"
https://review.openstack.org/#/c/43576/
and gave it a +1
-
Reviewed litong01's patch "install manual last few sections format needs to be fixed" multiple times
In many open source projects, people leave comments in the code with the
keywords TODO and FIXME.
I asked jd what is the difference between TODO and FIXME. I think TODO
means that something hasn't been written yet, whereas FIXME means something has
already been written but it's wrong.
jd says:
That's the spirit. But honestly, I doubt anyone is a stickler on this.
I also asked jd if there are other keywords and he said:
There's also HACK that can be used sometimes to indicate that some part of the following code is HACKish, not obvious to understand because we use an advanced/weird trick to make things work.
I noticed that in the Ceilometer tests, a style is enforced for the TODO
comments by the OpenStack Hacking library https://pypi.python.org/pypi/hacking
For example,
# FIXME
will give an error; the correct form is
# FIXME(name)
See: https://github.com/openstack-dev/hacking/blob/master/hacking/core.py#L135
I asked jd how to install the dependencies for building the Ceilometer documentation.
jd says:
Installing the test-requirements should be enough. That's what the doc target in tox.ini does.
I think the doc/requirements.txt is useless, and not up to date anyway, I've sent a patch to remove it, we'll see:
https://review.openstack.org/#/c/43576/
I asked jd if I should have used tox -e docs to install the Ceilometer
documentation requirements or installed the missing dependencies manually using
sudo pip install. When you run tox -e docs, it installs the documentation
requirements from test-requirements.txt in the Ceilometer repo.
jd's response:
That'll use tox, and therefore a virtualenv to build the doc. That avoids installing the library on your entire system.
There's no real downside on using tox or not in your case. The thing is that if you need different version of, say, oslo.sphinx for different projects, using tox is going to be smoother since each different version is going to be installed in a different virtualenv.
Installing all different versions at the same time in your system is not possible, and would be a nightmare, you'd spend your time upgrading or downgrading following each project you work on.
So "sudo pip install" works most of the time if you hack on one or a small number of project not having weird requirements.
- group by blueprint on Launchpad: https://blueprints.launchpad.net/ceilometer/+spec/api-group-by
- group by blueprint discussion on the OpenStack wiki: https://wiki.openstack.org/wiki/Ceilometer/blueprints/api-group-by
jd gave me a +2 on this patchset after I addressed his comment on Patch Set 5.