Refine the method to find pch and pcm files.

When compile user kernels, we need to find the precompiled header
file and the precompiled module file. The previous implementation
will find the build directory then find the system directory.

This is not elegant when it is packaged to a distro. It doesn't
need to search the build directory. So I change the default search
path to the system directory only. And for the deveoper, I change
the build script to set a proper environment variable and make the
gbe bin generator and the utest could find the local pch files and
pcm files firstly.

The only change is now, after the build process. Before the user
run the utests, it need to set up the environment firstly. Just
invoke

. utest/setenv.sh.

Then everything should be the same as previous. This setenv.sh also
set the OCL_KERNEL_PATH, so you don't need to set it manually now.

This patch also update the document.

v2:
add the missing setenv.sh.

Signed-off-by: Zhigang Gong <zhigang.gong@intel.com>
Tested-by: "Song, Ruiling" <ruiling.song@intel.com>

1 files changed, 18 insertions, 2 deletions

diff --git a/docs/Beignet.mdwn b/docs/Beignet.mdwn
index d05950fa..e3b4b1b6 100644
--- a/docs/Beignet.mdwn
+++ b/docs/Beignet.mdwn
@@ -70,8 +70,10 @@ this code also produces various tests to ensure the compiler and the run-time
 consistency. This small test framework uses a simple c++ registration system to
 register all the unit tests.
 
-You need to set the variable `OCL_KERNEL_PATH` to locate the OCL kernels. They
-are with the run-time in `./kernels`.
+You need to call setenv.sh in the utests/ directory to set some environment variables
+firstly as below:
+
+`> . setenv.sh`
 
 Then in `utests/`:
 
@@ -83,6 +85,20 @@ will run all the unit tests one after the others
 
 will only run `some_unit_test0` and `some_unit_test1` tests
 
+How to install
+--------------
+
+Simply invoke:
+`> make install`
+
+It installs libcl.so and the precompiled header/module files and the ocl_stdlib.h file
+into install_prefix/beignet/ direcotry. If the system support ICD, it also installs the
+intel-beignet.icd to /etc/OpenCL/vendors/.
+
+To make beignet support ICD, you need to have the following two packages installed:
+ocl-icd-dev, ocl-icd-libopencl1 (package name for the ubuntu.)
+before your build beignet.
+
 Supported Hardware
 ------------------