Merge lp:~michihenning/unity-api/fix-readme-install into lp:unity-api

[Michi Henning]

Minor fixed to README and INSTALL files.

Minor fixed to README and INSTALL files.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:35
http://jenkins.qa.ubuntu.com/job/unity-api-ci/8/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-raring-armhf-ci/8
        deb: http://jenkins.qa.ubuntu.com/job/unity-api-raring-armhf-ci/8/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-api-raring-i386-ci/8

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-api-ci/8/rebuild

review: Approve (continuous-integration)

[Michał Sawicz (saviq)]

review: Approve

=== modified file 'INSTALL'
--- INSTALL	2013-03-15 11:14:42 +0000
+++ INSTALL	2013-05-14 04:54:27 +0000
@@ -24,18 +24,7 @@
 Build dependencies
 ------------------
 
-List of packages required to build and test the code:
-
-- cmake (cmake, 2.8.10 with patch (see below) or later)
-- gcovr (gcovr, 2.4-0ubuntu1 or later)
-- lcov (lcov, 1.9-3 with patch (see below) or later)
-- gtest (libgtest-dev, 1.6.0 or later)
-- cppcheck (cppcheck, 1.55-1 or later)
-- doxygen (doxygen, 1.8.1.2-1 or later)
-- graphviz (graphviz, 2.26.3-12ubuntu1 or later)
-- libboost (libboost1.49-dev or later)
-- libboost-thread (libbost-thread1.49-dev or later)
-- libboost-regex-dev (libbost-regex1.49-dev or later)
+See debian/control for the list of packages required to build and test the code.
 
 
 Building the code
@@ -59,7 +48,7 @@
 To build with the flags for coverage testing enabled:
 
     $ mkdir buildcoverage
-    $ cd makecoverage
+    $ cd buildcoverage
     $ cmake -DCMAKE_BUILD_TYPE=coverage
     $ make
 
@@ -85,8 +74,8 @@
     $ make test
     $ make coverage-html
 
-(The coverage-html target is available only if the code was built with -DCMAKE_BUILD_TYPE=coverage.)
-
+This drops the coverage tests into the coveragereport directory. (The coverage-html target is available
+only if the code was built with -DCMAKE_BUILD_TYPE=coverage.)
 
 Note that, with gcc 4.7.2 and cmake 2.8.10, you may get a bunch of
 warnings. To fix this, you can build cmake 2.8.10 with the following patch:
@@ -114,10 +103,10 @@
 
 This deletes all the .gcda files, allowing the merge to succeed again.
 
-If lcov complains about unrecognized lines, apply this patch
-to /usr/bin/geninfo:
+If lcov complains about unrecognized lines involving '=====',
+you can patch geninfo and gcovr as explained here:
 
-https://bugzilla.redhat.com/attachment.cgi?id=590034
+https://bugs.launchpad.net/gcovr/+bug/1086695/comments/2
 
 To run the static C++ checks:
 

=== modified file 'README'
--- README	2013-03-28 06:10:55 +0000
+++ README	2013-05-14 04:54:27 +0000
@@ -59,9 +59,7 @@
 Header file conventions
 -----------------------
 
-TODO: Is include/unity/scopes the correct place?
-
-All header files are underneath include/unity/scopes. Source code always includes
+All header files are underneath include/unity. Source code always includes
 headers using the full pathname, for example:
 
   #include <unity/internal/ExceptionImpl.h>
@@ -73,7 +71,8 @@
 there are no duplicate names, inclusion with angle brackets behaves the
 same way as inclusion with double quotes.)
 
-All headers that are for public consumption appear in unity/scopes.
+All headers that are for public consumption appear in include/unity/*
+(provided the path does not include "internal").
 
 Public header directories contain a private header directory called
 "internal". This directory contains all the headers that are private