openstack
/
pbr
Code Issues Proposed changes
Python Build Reasonableness
957 Commits 2 Branches 105 Tags 10 MiB
Python 98%
Shell 1.7%
C 0.3%
Go to file
Stephen Finucane d4e4efd779 Stop building man pages by default 
From pretty much the beginning [1], pbr has defaulted to building both
man page and html output, but has failed to document it anywhere. People
tend to copy-paste their 'setup.py' and 'conf.py', or rely on the
'cookiecutter' project, with very little understanding of what's going
on under the hood (and why would you care - it's docs :)). This means
that the vast majority of folks using 'pbr' (basically everyone in
OpenStack) have been unwittingly building "man pages" as part of their
doc builds for no good reason, which has also led to a lot of confusion
when this magic behavior is the cause of bugs [2][3].

There's no good reason that pbr should default to building both man
pages and html output. For folks that want this functionality, we should
document it so they can use it. For everyone else though, let's do the
sane thing and output html like the standard 'build_sphinx' plugin.

[1] https://github.com/openstack-dev/pbr/commit/5b8b7f1d
[2] https://bugs.launchpad.net/pbr/+bug/1681983
[3] https://bugs.launchpad.net/oslotest/+bug/1379998

Change-Id: I579134a2b7980669180c1666503b848835cc2957
Closes-Bug: #1681983
 		2017-04-14 18:05:22 +00:00
doc/source Stop building man pages by default 2017-04-14 18:05:22 +00:00
pbr Stop building man pages by default 2017-04-14 18:05:22 +00: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 changelog to published documentation 2017-04-11 09:43:27 -04:00
setup.cfg Merge "Remove testr entry point" 2017-03-27 23:12:29 +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 Merge "Remove testr entry point" 2017-03-27 23:12:29 +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.