openstack/pbr
Code Issues Proposed changes

Make docs on env vars a little clearer

Browse Source 
It was pointed out that the packager docs don't make it super obvious
that the env var settings that packagers can set are env vars. Add
export statements to the docs to imply it a bit more that we are talking
about env vars here.

Change-Id: I9e9eefa661994237a63b59dcefab11961ef339e1
Fixes-bug: 1724425
This commit is contained in:
Clark Boylan 2018-03-20 14:44:07 -07:00
parent 56c27c21d1
commit 7e2d1666f2
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/user/packagers.rst
View File

@ -20,7 +20,7 @@ to get confused about whether its in its own git repo or not, you can set
::
PBR_VERSION=1.2.3
export PBR_VERSION=1.2.3
and all version calculation logic will be completely skipped and the supplied
version will be considered absolute.
@ -67,7 +67,7 @@ is using, setting `SKIP_GIT_SDIST`:
::
SKIP_GIT_SDIST=1
export SKIP_GIT_SDIST=1
will cause all logic around using git to find the files that should be in the
source tarball to be skipped. Beware though, that because `pbr` packages
@ -85,14 +85,14 @@ repository for packaging source. If that is the case setting
::
SKIP_GENERATE_AUTHORS=1
export SKIP_GENERATE_AUTHORS=1
will cause logic around generating AUTHORS using git information to be
skipped. Similarly setting `SKIP_WRITE_GIT_CHANGELOG`
::
SKIP_WRITE_GIT_CHANGELOG=1
export SKIP_WRITE_GIT_CHANGELOG=1
will cause logic around generating ChangeLog file using git
information to be skipped.