From 0df88297832ce1547a7d11dad205a1e2deea0d6c Mon Sep 17 00:00:00 2001 From: Dulma Rodriguez Date: Wed, 10 Jun 2015 09:33:10 -0100 Subject: [PATCH] [OSS] Adding FILES.md --- FILES.md | 33 +++++++++++++++++++++++++++++++++ INSTALL.md | 4 ++-- 2 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 FILES.md diff --git a/FILES.md b/FILES.md new file mode 100644 index 000000000..4e89b6ab4 --- /dev/null +++ b/FILES.md @@ -0,0 +1,33 @@ +#Files in infer/bin/ + +## Top-level commands + +*infer* : Main command to run Infer. It's a python script. Check out the docs for instructions on how to use it. + +*inferTest* : Shell script for running Infer's tests. Uses Buck for running the tests. +Usage: inferTest {c, objc, java} for the tests about the analysis of C, Objective-C, or Java files. + +*clang_frontend_stats.sh* : Shell script for obtaining statistics about the translation of C and Objective-C files with the clang frontend. It's mostly useful for developers of Infer. + +## Helper commands + +The rest of the commands in infer/bin/ are not meant to be called directly, but are used by the top-level commands above. + +*InferJava* : Binary containing the Java frontend. + +*InferClang* : Binary containing the clang frontend. + +*InferAnalyze* : Binary containing the backend of Infer that performs the analysis. + +*InferPrint* : Binary that prints reports about the analysis such as the specs of methods and a list of bugs found. + +*inferJ* : Command for running the analysis of Java files. + +*BuckAnalyze* : Command for running the analysis of Java projects compiled with Buck. + +*inferlib.py* : Python libraries for the other scripts. + +*utils.py* : Python libraries for the other scripts. + +*jwlib.py* : Python libraries for the other scripts. + diff --git a/INSTALL.md b/INSTALL.md index a68b3ef88..e71d619bb 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,7 +8,7 @@ Otherwise, if you wish to compile Infer, here are also instructions to do so, de - [Mac OS X](INSTALL.md#mac-os-x) - [Linux](INSTALL.md#linux-64-bit) - [Install Infer from source](INSTALL.md#install-infer-from-source) - - [Download Infer](INSTALL.md#download-infer) + - [Download the Infer repository](INSTALL.md#download-the-infer-repository) - [Mac OS X](INSTALL.md#macos-x) - [Linux](INSTALL.md#linux) @@ -51,7 +51,7 @@ The following instructions describe how to compile Infer on different platforms. - Python 2.7 -### Download the Infer repository +### Download the Infer repository git clone https://github.com/facebook/infer.git