<commit_before>clARMOR - A Buffer Overflow Detector for OpenCL Programs
==================
This is clARMOR, the AMD Research Memory Overflow Reporter for OpenCL. This
tool wraps API calls to OpenCL libraries and dynamically checks for memory
errors caused by OpenCL kernels. When an error is detected (e.g. when a kernel
writes beyond the end of a buffer), error information is printed to the screen
and is optionally logged to an output file.

The details of how this tool works can be found in the ./docs/ directory, and
a deeper introduction can be found in the main README.txt file.

Build Status
--------------------------------------------------------------------------------
| Build branch | master |
|-----|-----|
| GCC+Clang, Linux, AMD64 | [![Build Status](https://travis-ci.org/GPUOpen-ProfessionalCompute-Tools/clARMOR.svg?branch=master)](https://travis-ci.org/GPUOpen-ProfessionalCompute-Tools/clARMOR) |

Setting up and building clARMOR
--------------------------------------------------------------------------------

clARMOR requires a number of utilities in order to properly run. Information
about these prerequisites can be found in the prereqs/ directory. In particular,
the file prereqs/README.txt discusses information about how to set up a system
to run this tool. At this time, clARMOR only runs on Linux.

A simplified list of software required to run clARMOR:

* A working OpenCL 1.1+ installation
* GCC >= 4.7 or LLVM >= 3.3
* Python and Python argparse

Additional software that is useful to have installed when working with clARMOR:

* gdb
* Clang Static Analyzer (scan-build)
* cppcheck
* pylint

Currently, this tool is designed to detect buffer overflows caused by OpenCL
kernels that run on GPUs or CPUs. It has been tested most extensively using the
AMD APP SDK OpenCL runtime implementation and AMD Catalyst GPU drivers.

To build the clARMOR using your default C and C++ compilers, execute the
following from the main directory:

    make<commit_msg>Add develop branch to status display in README.md<commit_after>clARMOR - A Buffer Overflow Detector for OpenCL Programs
==================
This is clARMOR, the AMD Research Memory Overflow Reporter for OpenCL. This
tool wraps API calls to OpenCL libraries and dynamically checks for memory
errors caused by OpenCL kernels. When an error is detected (e.g. when a kernel
writes beyond the end of a buffer), error information is printed to the screen
and is optionally logged to an output file.

The details of how this tool works can be found in the ./docs/ directory, and
a deeper introduction can be found in the main README.txt file.

Build Status
--------------------------------------------------------------------------------
| Build branch | master | develop |
|-----|-----|-----|
| GCC+Clang, Linux, AMD64 | [![Build Status](https://travis-ci.org/GPUOpen-ProfessionalCompute-Tools/clARMOR.svg?branch=master)](https://travis-ci.org/GPUOpen-ProfessionalCompute-Tools/clARMOR/branches) | [![Build Status](https://travis-ci.org/GPUOpen-ProfessionalCompute-Tools/clARMOR.svg?branch=develop)](https://travis-ci.org/GPUOpen-ProfessionalCompute-Tools/clARMOR/branches) |

Setting up and building clARMOR
--------------------------------------------------------------------------------

clARMOR requires a number of utilities in order to properly run. Information
about these prerequisites can be found in the prereqs/ directory. In particular,
the file prereqs/README.txt discusses information about how to set up a system
to run this tool. At this time, clARMOR only runs on Linux.

A simplified list of software required to run clARMOR:

* A working OpenCL 1.1+ installation
* GCC >= 4.7 or LLVM >= 3.3
* Python and Python argparse

Additional software that is useful to have installed when working with clARMOR:

* gdb
* Clang Static Analyzer (scan-build)
* cppcheck
* pylint

Currently, this tool is designed to detect buffer overflows caused by OpenCL
kernels that run on GPUs or CPUs. It has been tested most extensively using the
AMD APP SDK OpenCL runtime implementation and AMD Catalyst GPU drivers.

To build the clARMOR using your default C and C++ compilers, execute the
following from the main directory:

    make
{'fraction_non_alphanumeric': 0.14509617668012348, 'fraction_numerical': 0.00379957254808834, 'mean_word_length': 3.05, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '548870', 'n_tokens_mistral': 1124, 'n_tokens_neox': 1052, 'n_words': 521}