Tooling: set default behaviour

Tools will run on current directory if no input is given.
Add tools/README.rst for brief documentation

Change-Id: Id8c68c12191591d70ae22293b0b99048998fb1a4
This commit is contained in:
Haikel Guemar 2016-07-07 20:42:41 +02:00
parent 5cb1c51f65
commit 220bb64df0
3 changed files with 35 additions and 2 deletions

33
tools/README.rst Normal file
View File

@ -0,0 +1,33 @@
RPM Packaging for OpenStack internal tooling README
===================================================
This directory provides useful tooling for contributors to
the RPM Packaging project.
tools/run_renderspec.sh
+++++++++++++++++++++++
This tool can be used to generate usable spec files for all supported
RPM distributions from shipped templates. It will browse recursively
the directory passed in argument to find spec templates.
If no directory is given, it will search in current directory.
Usage::
tools/run_renderspec.sh <path>
tools/run_speccleaner.sh
++++++++++++++++++++++++
This tool can be used to run spec-cleaner on generated spec files.
It will browse recursively the directory passed in argument and will
display as an unified diff, differences to our standards.
If no directory is given, it will search in current directory.
Usage::
tools/run_speccleaner.sh <path>

View File

@ -2,7 +2,7 @@
set -eux set -eux
basedir=$1 basedir=${1:-$PWD}
specdir=${basedir}/openstack/ specdir=${basedir}/openstack/
WORKSPACE=${WORKSPACE:-$basedir} WORKSPACE=${WORKSPACE:-$basedir}

View File

@ -2,7 +2,7 @@
set -e set -e
basedir=$1 basedir=${1:-$PWD}
WORKSPACE=${WORKSPACE:-$basedir} WORKSPACE=${WORKSPACE:-$basedir}
# tempfile to store the spec-cleaner diff for all specs # tempfile to store the spec-cleaner diff for all specs