Skip to content

Commit

Permalink
Removing statick_gauntlet tool and documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
tdenewiler committed May 31, 2019
1 parent 3e9a938 commit 0369ad7
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 240 deletions.
59 changes: 0 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,62 +118,3 @@ Here are some example use cases for the level of compliance we are enforcing for
$ . devel/setup.bash
$ mkdir statick_output
$ statick_ws src statick_output


# Statick Gauntlet

The statick gauntlet runs `make` against a set of targets individually from a clean workspace that allows it to catch dependency issues that may crop up on `catkin_make`.
These issues usually manifest themselves as build failures that crop up and seem to magically resolve themselves by running the build again.

## Running

If you are running from an installed version, you will use the `statick_gauntlet` command.
If you are running job from a local version in your workspace, you can run it like `~/src/my_ws/src/ssc/statick/statick_gauntlet`

For a description of all available arguments, pass the `--help` option to the program.

$ gauntlet <path of catkin src> <output path>

"Path of catkin src" is the src dir underneath your catkin workspace root.
There should be the default CMakeLists.txt there from running `catkin_init_workspace` or `catkin_make`.

"Output path" is the path where build and output files are stored.
This should initially be an empty directory separate from your regular source and build directories.
This directory must already exist before running the program.

You must NOT have your workspace sourced before running this tool.
If there is a workspace sourced, it won't do its job properly.

This command can not be run against individual packages, it must be run against a whole workspace.
However, you can use the `--targets_file` option listed below to select which targets get tested.
By default, it tests all targets.

You can pass the `--failed-only` option after a run that has failed targets to run only those targets that failed again.

You can pass the `--targets-file <file>` option to use the given file as a listing of targets to run.
The file contents should look something like

target1
target2
target3

You can pass the `--force-cmake` option to force the gauntlet tool to rerun CMake.
This may resolve any weird issues you experience.

## Example Usage

Here are some example use cases for running the gauntlet.
Note that you are NOT sourcing the `setup.bash`.

### For a whole workspace

$ cd ~/src/my_ws
$ mkdir gauntlet
$ statick_gauntlet src gauntlet

### Running against failed packages

If you have failures, you can rerun the gauntlet against only those failures

$ cd ~/src/my_ws
$ statick_gauntlet src gauntlet --failed-only
9 changes: 0 additions & 9 deletions statick_gauntlet

This file was deleted.

172 changes: 0 additions & 172 deletions statick_tool/gauntlet.py

This file was deleted.

0 comments on commit 0369ad7

Please sign in to comment.