openstack
/
pbr
Code Issues Proposed changes
Python Build Reasonableness
944 Commits 2 Branches 105 Tags 10 MiB
Python 98%
Shell 1.7%
C 0.3%
Go to file
Gage Hugo 3cc5af104e Add Changelog build handling for invalid chars 
This change adds new handling when building a Changelog file
for specific characters that cause documentation building
warnings/errors to be emitted when sphinx tries to generate
a Changelog html page. The changes include:

- Escaping any '*' in a commit, which sphinx will interpret as the
  start of a new line and throw a warning.
- Escaping any '_' in a commit, which in certain cases, sphinx will
  interpret as an invalid link and create an error.
- Escaping any '`' in a commit, which in certain cases will
  cause sphinx to interpet as a literal, and throw a warning.

After this change, any entries in the changelog that contain
the above "invalid" syntax no longer generate sphinx
warnings/errors and the offending entries now generate correctly.

Change-Id: I672ef4c56486e59a384849a4b182d11129726ae9
 		2017-03-27 11:37:24 -05:00
doc/source Stop using 'warnerrors' 2017-02-27 14:20:57 +00:00
pbr Add Changelog build handling for invalid chars 2017-03-27 11:37:24 -05:00
tools Add Constraints support 2017-01-03 19:27:57 +01:00
.coveragerc Update .coveragerc after the removal of openstack directory 2016-10-19 15:16:29 +05:30
.gitignore Move to oslosphinx 2016-06-22 13:18:59 +10:00
.gitreview Rename back to PBR. 2013-03-17 23:27:50 -07:00
.mailmap Clean up hacking and path issues with d2to1 2013-07-11 15:02:12 -04:00
.testr.conf Parallelise integration tests. 2015-05-02 09:05:54 +12:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:42 +00:00
LICENSE Split out oslo.packaging. 2013-03-10 18:02:43 -04:00
README.rst Add shields.io version/downloads links/badges into README.rst 2015-09-24 20:49:31 -04:00
setup.cfg Stop using 'warnerrors' 2017-02-27 14:20:57 +00:00
setup.py Move d2to1 more into the source tree 2013-07-21 10:20:03 -07:00
test-requirements.txt Updated from global requirements 2017-03-02 23:52:51 +00:00
tox.ini tox: Don't set skipsdist=True 2017-02-27 14:23:50 +00:00

README.rst

Introduction

Latest Version

Downloads

PBR is a library that injects some useful and sensible default behaviors into your setuptools run. It started off life as the chunks of code that were copied between all of the OpenStack projects. Around the time that OpenStack hit 18 different projects each with at least 3 active branches, it seemed like a good time to make that code into a proper reusable library.

PBR is only mildly configurable. The basic idea is that there's a decent way to run things and if you do, you should reap the rewards, because then it's simple and repeatable. If you want to do things differently, cool! But you've already got the power of Python at your fingertips, so you don't really need PBR.

PBR builds on top of the work that d2to1 started to provide for declarative configuration. d2to1 is itself an implementation of the ideas behind distutils2. Although distutils2 is now abandoned in favor of work towards PEP 426 and Metadata 2.0, declarative config is still a great idea and specifically important in trying to distribute setup code as a library when that library itself will alter how the setup is processed. As Metadata 2.0 and other modern Python packaging PEPs come out, PBR aims to support them as quickly as possible.