From 6c75ce543e25799183fa743f6f87f83c8bf0ca01 Mon Sep 17 00:00:00 2001 From: Tony Breeds Date: Wed, 20 Sep 2017 16:11:05 -0400 Subject: [PATCH] [tools] Add a README.txt Change-Id: I1daba8a6852255daca62c0c772a44b822360a84e --- tools/README.txt | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 tools/README.txt diff --git a/tools/README.txt b/tools/README.txt new file mode 100644 index 0000000000..c9c95410ab --- /dev/null +++ b/tools/README.txt @@ -0,0 +1,56 @@ +OpenStack Requirements tools. + +This directory contains a number of tools that are useful to the requirements core team and OpenStack +developers. + +babel-test.sh +------------- +A tool check for regressions with new Babel releases. + +build_wheels.sh +--------------- + +Generate wheels for all of the requirements, ignoring any packages +that won't build wheels so we get as many as possible. This is meant +to be used on a development box combined with devpi and a wheelhouse +configuration setting for pip, such as described in +https://www.berrange.com/posts/2014/11/14/faster-rebuilds-for-python-virtualenv-trees/ + +cap.py +------ + +Take the output of 'pip freeze' and use the installed versions to caps requirements. + +check-install.py +---------------- + +Used in tox environment pip-install. Only installs requirements (as opposed to +test-requirements and verifies that all console-scripts have all modules +needed. + +cruft.sh +-------- + +This script, when run from the root directory of this repository, will search +the default and feature branches of all projects listed in the projects.txt +file for declared dependencies, then output a list of any entries in the +global-requirements.txt file which are not actual dependencies of those +projects. Old dependencies which were removed from projects or which were used +only for projects which have since been removed should be cleaned up, but many +entries likely represent recent additions which still have pending changes to +add them to one or more projects. In most cases, git pickaxe will yield the +answer. + +grep-all.sh +----------- + +List a requirements specification and constratint for a given libarary + +integration.sh +-------------- + +Used in the gate! Install all the "$PROJECTS" to verify that g-r and the each project are compatible + +what-broke.py +------------- +figure out what requirements change likely broke us.