[openstack-dev] [all][oslo] pbr potential breaking change coming

Markus Zoeller mzoeller at linux.vnet.ibm.com
Thu Jun 23 08:43:30 UTC 2016

On 21.06.2016 15:01, Doug Hellmann wrote:
> A while back pbr had a feature that let projects pass "warnerror"
> through to Sphinx during documentation builds, causing any warnings in
> that build to be treated as an error and fail the build. This lets us
> avoid things like links to places that don't exist in the docs, bad but
> renderable rst, typos in directive or role names, etc.
> Somewhat more recently, but still a while ago, that feature "broke"
> with a Sphinx release that was not API compatible. Sachi King has
> fixed this issue within pbr, and so the next release of pbr will
> fix the broken behavior and start correctly passing warnerror again.
> That may result in doc builds breaking where they didn't before.
> The short-term solution is to turn of warnerrors (look in your
> setup.cfg), then fix the issues and turn it back on. Or you could
> preemptively fix any existing warnings in your doc builds before the
> release, but it's simple enough to turn off the feature if there isn't
> time.
> Josh, Sachi, & other Oslo folks, I think we should hold off on
> releasing until next week to give folks time. Is that OK?
> Doug
> PS - Thanks, Sachi, I know that bug wasn't a ton of fun to fix!
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Thanks for the heads up. I checked Nova, and every sphinx-build command
we use in our "tox.ini" file already uses the -W flag to treat warnings
as errors. I guess we're safe with that?

Regards, Markus Zoeller (markus_z)

More information about the OpenStack-dev mailing list