move developer tips from COMPILING to CODING_STANDARD

Daniel Kroening · Daniel Kroening · commit 43683854f470 · 2018-06-23T14:53:58.000+01:00
diff --git a/CODING_STANDARD.md b/CODING_STANDARD.md
@@ -240,3 +240,97 @@ or use a symbolic link. Then, when running git commit, you should get the
 linter output (if any) before being prompted to enter a commit message. To
 bypass the check (e.g. if there was a false positive), add the option
 `--no-verify`.
+
+# CODE COVERAGE
+
+Code coverage metrics are provided using gcov and lcov. Ensure that you have
+installed lcov from http://ltp.sourceforge.net/coverage/lcov.php note for
+ubuntu lcov is available in the standard apt-get repos.
+
+To get coverage metrics run the following script from the regression directory:
+```
+get_coverage.sh
+```
+This will:
+ 1) Rebuild CBMC with gcov enabled
+ 2) Run all the regression tests
+ 3) Collate the coverage metrics
+ 4) Provide an HTML report of the current coverage
+
+# USING CLANG-FORMAT
+
+CBMC uses clang-format to ensure that the formatting of new patches is readable
+and consistent. There are two main ways of running clang-format: remotely, and
+locally.
+
+## RUNNING CLANG-FORMAT REMOTELY
+
+When patches are submitted to CBMC, they are automatically run through
+continuous integration (CI). One of the CI checks will run clang-format over
+the diff that your pull request introduces. If clang-format finds formatting
+issues at this point, the build will be failed, and a patch will be produced
+in the CI output that you can apply to your code so that it conforms to the
+style guidelines.
+
+To apply the patch, copy and paste it into a local file (`patch.txt`) and then
+run:
+```
+patch -p1 -i patch.txt
+```
+Now, you can commit and push the formatting fixes.
+
+## RUNNING CLANG-FORMAT LOCALLY
+
+### INSTALLATION
+
+To avoid waiting until you've made a PR to find formatting issues, you can
+install clang-format locally and run it against your code as you are working.
+
+Different versions of clang-format have slightly different behaviors. CBMC uses
+clang-format-3.8 as it is available the repositories for Ubuntu 16.04 and
+Homebrew.
+To install on a Unix-like system, try installing using the system package
+manager:
+```
+apt-get install clang-format-3.8  # Run this on Ubuntu, Debian etc.
+brew install clang-format@3.8     # Run this on a Mac with Homebrew installed
+```
+
+If your platform doesn't have a package for clang-format, you can download a
+pre-built binary, or compile clang-format yourself using the appropriate files
+from the [LLVM Downloads page](http://releases.llvm.org/download.html).
+
+An installer for Windows (along with a Visual Studio plugin) can be found at
+the [LLVM Snapshot Builds page](http://llvm.org/builds/).
+
+### FORMATTING A RANGE OF COMMITS
+
+Clang-format is distributed with a driver script called git-clang-format-3.8.
+This script can be used to format git diffs (rather than entire files).
+
+After committing some code, it is recommended to run:
+```
+git-clang-format-3.8 upstream/develop
+```
+*Important:* If your branch is based on a branch other than `upstream/develop`,
+use the name or checksum of that branch instead. It is strongly recommended to
+rebase your work onto the tip of the branch it's based on before running
+`git-clang-format` in this way.
+
+### RETROACTIVELY FORMATTING INDIVIDUAL COMMITS
+
+If your works spans several commits and you'd like to keep the formatting
+correct in each individual commit, you can automatically rewrite the commits
+with correct formatting.
+
+The following command will stop at each commit in the range and run
+clang-format on the diff at that point.  This rewrites git history, so it's
+*unsafe*, and you should back up your branch before running this command:
+```
+git filter-branch --tree-filter 'git-clang-format-3.8 upstream/develop' \
+  -- upstream/develop..HEAD
+```
+*Important*: `upstream/develop` should be changed in *both* places in the
+command above if your work is based on a different branch. It is strongly
+recommended to rebase your work onto the tip of the branch it's based on before
+running `git-clang-format` in this way.
diff --git a/COMPILING.md b/COMPILING.md
@@ -19,41 +19,36 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution.
 
 1. You need a C/C++ compiler, Flex and Bison, and GNU make.
    The GNU Make needs to be version 3.81 or higher.
-   On Debian-like distributions, do
+   On Debian-like distributions, do as root:
    ```
    apt-get install g++ gcc flex bison make git libwww-perl patch
    ```
-   On Red Hat/Fedora or derivates, do
+   On Red Hat/Fedora or derivates, do as root:
    ```
-   yum install gcc gcc-c++ flex bison perl-libwww-perl patch devtoolset-6
+   dnf install gcc gcc-c++ flex bison perl-libwww-perl patch
    ```
    Note that you need g++ version 5.0 or newer.
 
    To compile JBMC, you additionally need the JDK and the java-models-library.
-   For the JDK, on Debian-like distributions, do
+   For the JDK, on Debian-like distributions, do as root:
    ```
    apt-get install openjdk-8-jdk
    ```
-   On Red Hat/Fedora or derivates, do
+   On Red Hat/Fedora or derivates, do as root:
    ```
-   yum install java-1.8.0-openjdk-devel
+   dnf install java-1.8.0-openjdk-devel
    ```
 
 2. As a user, get the CBMC source via
    ```
    git clone https://github.com/diffblue/cbmc cbmc-git
+   cd cbmc-git
    ```
 
-3. On Debian or Ubuntu, do
+3. To compile, do
    ```
-   make -C cbmc-git/src minisat2-download
-   make -C cbmc-git/src
-   ```
-   On Redhat/Fedora etc., do
-   ```
-   scl enable devtoolset-6 bash
-   make -C cbmc-git/src minisat2-download
-   make -C cbmc-git/src
+   make -C src minisat2-download
+   make -C src
    ```
 
 4. Linking against an IPASIR SAT solver
@@ -71,8 +66,8 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution.
 
 5. To compile JBMC, do
    ```
-   make -C cbmc-git/jbmc/src java-models-library-download
-   make -C cbmc-git/jbmc/src
+   make -C jbmc/src java-models-library-download
+   make -C jbmc/src
    ```
 
 # COMPILATION ON SOLARIS 11
@@ -87,16 +82,17 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution.
    ```
    export PATH=/opt/csw/bin:$PATH
    git clone https://github.com/diffblue/cbmc cbmc-git
+   cd cbmc-git
    ```
 3. To compile CBMC, type
    ```
-   gmake -C cbmc-git/src minisat2-download DOWNLOADER=wget TAR=gtar
-   gmake -C cbmc-git/src
+   gmake -C src minisat2-download DOWNLOADER=wget TAR=gtar
+   gmake -C src
    ```
 4. To compile JBMC, type
    ```
-   gmake -C cbmc-git/jbmc/src java-models-library-download
-   gmake -C cbmc-git/jbmc/src
+   gmake -C jbmc/src java-models-library-download
+   gmake -C jbmc/src
    ```
 
 # COMPILATION ON FREEBSD 11
@@ -115,13 +111,13 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution.
    ```
 3. To compile CBMC, do
    ```
-   gmake -C cbmc-git/src minisat2-download
-   gmake -C cbmc-git/src
+   gmake -C src minisat2-download
+   gmake -C src
    ```
 4. To compile JBMC, do
    ```
-   gmake -C cbmc-git/jbmc/src java-models-library-download
-   gmake -C cbmc-git/jbmc/src
+   gmake -C jbmc/src java-models-library-download
+   gmake -C jbmc/src
    ```
 
 # COMPILATION ON MACOS X
@@ -137,16 +133,17 @@ Follow these instructions:
 2. Then get the CBMC source via
    ```
    git clone https://github.com/diffblue/cbmc cbmc-git
+   cd cbmc-git
    ```
 3. To compile CBMC, do
    ```
-   make -C cbmc-git/src minisat2-download
-   make -C cbmc-git/src
+   make -C src minisat2-download
+   make -C src
    ```
 4. To compile JBMC, do
    ```
-   make -C cbmc-git/jbmc/src java-models-library-download
-   make -C cbmc-git/jbmc/src
+   make -C jbmc/src java-models-library-download
+   make -C jbmc/src
    ```
 
 # COMPILATION ON WINDOWS
@@ -163,6 +160,7 @@ Follow these instructions:
 2. Get the CBMC source via
    ```
    git clone https://github.com/diffblue/cbmc cbmc-git
+   cd cbmc-git
    ```
 3. Depending on your choice of compiler:
    1. To compile with Visual Studio, change the second line of `src/config.inc`
@@ -171,19 +169,19 @@ Follow these instructions:
       BUILD_ENV = MSVC
       ```
       Open the Developer Command Prompt for Visual Studio, then start the
-	    Cygwin shell with
-	    ```
-	    bash.exe -login
-	    ```
+      Cygwin shell with
+      ```
+      bash.exe -login
+      ```
    2. To compile with MinGW, use Cygwin setup to install a mingw g++ compiler
       package, i.e. one of `mingw{32,64}-{x86_64,i686}-gcc-g++`. You may also
       have to adjust the section in `src/common` that defines `CC` and `CXX`
       for BUILD_ENV = Cygwin.
       Then start the Cygwin shell.
 4. In the Cygwin shell, type
    ```
-   make -C cbmc-git/src DOWNLOADER=wget minisat2-download
-   make -C cbmc-git/src
+   make -C src DOWNLOADER=wget minisat2-download
+   make -C src
    ```
 
 (Optional) A Visual Studio project file can be generated with the script
@@ -278,96 +276,3 @@ To work with Eclipse, do the following:
 5. Click "Finish"
 6. Select Project -> Build All
 
-# CODE COVERAGE
-
-Code coverage metrics are provided using gcov and lcov. Ensure that you have
-installed lcov from http://ltp.sourceforge.net/coverage/lcov.php note for
-ubuntu lcov is available in the standard apt-get repos.
-
-To get coverage metrics run the following script from the regression directory:
-```
-get_coverage.sh
-```
-This will:
- 1) Rebuild CBMC with gcov enabled
- 2) Run all the regression tests
- 3) Collate the coverage metrics
- 4) Provide an HTML report of the current coverage
-
-# USING CLANG-FORMAT
-
-CBMC uses clang-format to ensure that the formatting of new patches is readable
-and consistent. There are two main ways of running clang-format: remotely, and
-locally.
-
-## RUNNING CLANG-FORMAT REMOTELY
-
-When patches are submitted to CBMC, they are automatically run through
-continuous integration (CI). One of the CI checks will run clang-format over
-the diff that your pull request introduces. If clang-format finds formatting
-issues at this point, the build will be failed, and a patch will be produced
-in the CI output that you can apply to your code so that it conforms to the
-style guidelines.
-
-To apply the patch, copy and paste it into a local file (`patch.txt`) and then
-run:
-```
-patch -p1 -i patch.txt
-```
-Now, you can commit and push the formatting fixes.
-
-## RUNNING CLANG-FORMAT LOCALLY
-
-### INSTALLATION
-
-To avoid waiting until you've made a PR to find formatting issues, you can
-install clang-format locally and run it against your code as you are working.
-
-Different versions of clang-format have slightly different behaviors. CBMC uses
-clang-format-3.8 as it is available the repositories for Ubuntu 16.04 and
-Homebrew.
-To install on a Unix-like system, try installing using the system package
-manager:
-```
-apt-get install clang-format-3.8  # Run this on Ubuntu, Debian etc.
-brew install clang-format@3.8     # Run this on a Mac with Homebrew installed
-```
-
-If your platform doesn't have a package for clang-format, you can download a
-pre-built binary, or compile clang-format yourself using the appropriate files
-from the [LLVM Downloads page](http://releases.llvm.org/download.html).
-
-An installer for Windows (along with a Visual Studio plugin) can be found at
-the [LLVM Snapshot Builds page](http://llvm.org/builds/).
-
-### FORMATTING A RANGE OF COMMITS
-
-Clang-format is distributed with a driver script called git-clang-format-3.8.
-This script can be used to format git diffs (rather than entire files).
-
-After committing some code, it is recommended to run:
-```
-git-clang-format-3.8 upstream/develop
-```
-*Important:* If your branch is based on a branch other than `upstream/develop`,
-use the name or checksum of that branch instead. It is strongly recommended to
-rebase your work onto the tip of the branch it's based on before running
-`git-clang-format` in this way.
-
-### RETROACTIVELY FORMATTING INDIVIDUAL COMMITS
-
-If your works spans several commits and you'd like to keep the formatting
-correct in each individual commit, you can automatically rewrite the commits
-with correct formatting.
-
-The following command will stop at each commit in the range and run
-clang-format on the diff at that point.  This rewrites git history, so it's
-*unsafe*, and you should back up your branch before running this command:
-```
-git filter-branch --tree-filter 'git-clang-format-3.8 upstream/develop' \
-  -- upstream/develop..HEAD
-```
-*Important*: `upstream/develop` should be changed in *both* places in the
-command above if your work is based on a different branch. It is strongly
-recommended to rebase your work onto the tip of the branch it's based on before
-running `git-clang-format` in this way.
