From 350fe4d42cb9b2112d0a9971a244d55d65870b7c Mon Sep 17 00:00:00 2001 From: Jules Villard Date: Fri, 18 Nov 2016 09:59:07 -0800 Subject: [PATCH] [docs] update docs Summary: Some minor updating needed. Reviewed By: akotulski Differential Revision: D4204564 fbshipit-source-id: 742238e --- CONTRIBUTING.md | 9 +++------ INSTALL.md | 20 ++++++++------------ 2 files changed, 11 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3eee492e5..065456179 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,12 +9,9 @@ us a line at cla@fb.com. Thanks! ## Submitting Pull Requests -* Please make sure Infer builds: `make -C infer clean `. Refer - to the [installation +* Please make sure Infer builds: `make`. Refer to the [installation document](https://github.com/facebook/infer/blob/master/INSTALL.md) for details. -* If relevant, add a test for your change. Tests are located at - `infer/tests/codetoanalyze/` and - `infer/tests/{endtoend,frontend}/`. To run the all tests, execute - `make test`. +* If relevant, add a test for your change. Tests are located in + `infer/tests/`. To run the all tests, execute `make test`. diff --git a/INSTALL.md b/INSTALL.md index 624478ce1..ada5af401 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -31,7 +31,7 @@ You can install some of these dependencies using ```sh brew install autoconf automake opam caskroom/cask/brew-cask && \ -brew cask install caskroom/versions/java7 +brew cask install java7 ``` @@ -86,8 +86,10 @@ some means other than opam, you can still compile Infer by running: ./autogen.sh ./configure make # or make java -# Install Infer into your PATH +# Install Infer into your PATH... export PATH=`pwd`/infer/bin:$PATH +# ...or, alternatively, install Infer system-wide +sudo make install ``` @@ -168,14 +170,8 @@ sudo update-alternatives \ ### Setting up opam Unfortunately, the version of opam that ships with some Linux -distributions is broken, so you'll have to get it from the web: - -```sh -wget https://github.com/ocaml/opam/releases/download/1.2.2/opam-1.2.2-x86_64-Linux -chmod +x opam-1.2.2-x86_64-Linux -sudo cp opam-1.2.2-x86_64-Linux /usr/local/bin/opam -opam init --comp=4.02.3 -``` +distributions is broken, so you'll have to get it from the +[web](http://opam.ocaml.org/doc/Install.html#Binarydistribution). -Alternatively, follow the instructions [from the opam -webpage](https://opam.ocaml.org/doc/Install.html). +The OCaml dependencies needed by Infer are automatically handled by +opam when running `./build-infer.sh`.