openstack
/
pbr
Code Issues Proposed changes

Packagers vs package maintainers 

The doc uses a familliar word of "packager", but the real name
should be "package maintainer". This fixes it.

Change-Id: Ieab50fe7ed0d666c9c6eff4c0b986765765f1ac4
This commit is contained in:
Thomas Goirand 2014-12-02 23:18:18 +08:00
parent e0d2674102
commit c8d6048371
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/packagers.rst
View File

@ -1,6 +1,6 @@
=====================
Notes for Packagers
=====================
===============================
Notes for Package maintainers
===============================
If you are maintaining packages of software that uses `pbr`, there are some
features you probably want to be aware of that can make your life easier.
@ -12,10 +12,11 @@ Versioning
`pbr`, when run in a git repo, derives the version of a package from the
git tags. When run in a tarball with a proper egg-info dir, it will happily
pull the version from that. So for the most part, the packager shouldn't need
to care. However, if you are doing something like keeping a git repo with
the sources and the packaging intermixed and it's causing pbr to get confused
about whether its in its own git repo or not, you can set `PBR_VERSION`:
pull the version from that. So for the most part, the package maintainers
shouldn't need to care. However, if you are doing something like keeping a
git repo with the sources and the packaging intermixed and it's causing pbr
to get confused about whether its in its own git repo or not, you can set
`PBR_VERSION`:
::
@ -57,10 +58,10 @@ Tarballs
========
`pbr` includes everything in a source tarball that is in the original `git`
repository. This can again cause havoc if a packager is doing fancy things
with combined `git` repos, and is generating a source tarball using `python
setup.py sdist` from that repo. If that is the workflow the packager is using,
setting `SKIP_GIT_SDIST`:
repository. This can again cause havoc if a package maintainer is doing fancy
things with combined `git` repos, and is generating a source tarball using
`python setup.py sdist` from that repo. If that is the workflow the packager
is using, setting `SKIP_GIT_SDIST`:
::
@ -76,7 +77,7 @@ AUTHORS and ChangeLog
=====================
`pbr` generates AUTHORS and ChangeLog files from git information. This
can cause problem in distro packaging if packager is using git
can cause problem in distro packaging if package maintainer is using git
repository for packaging source. If that is the case setting
`SKIP_GENERATE_AUTHORS`