Media/compute-runtime
1
0
Fork 0
mirror of https://github.com/intel/compute-runtime.git synced 2025-09-20 13:11:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update & cleanup

Browse Source 
Change-Id: Ia059e15269638319ec97e49deb622b9ceb1a0997
This commit is contained in:
Adam Cetnerowski
2019-02-18 16:07:45 +01:00
committed by sys_ocldev
parent b44d434a89
commit 9523942573
4 changed files with 15 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
documentation/CONTRIB.md
View File

@ -16,8 +16,11 @@ Make sure you adhere to our coding standard - this will be verified by clang-for
### 2. Patch submission
Create a pull request on github once you are confident that your changes are complete and fulfill
the requirements above. Make sure your commit message contains meaningful title (first line).
A few sentences of additional description is also required. All lines in the commit messages have 80 characters limit.
the requirements above. Make sure your commit message follows these rules:
* each line has 80 character limit
* title (first line) should be self-contained (i.e. make sense without looking at the body)
* additional description can be provided in the body
* title and body need to be separated by an empty line
### 3. Initial (cursory) review

13
documentation/FAQ.md
View File

@ -10,7 +10,7 @@ with default / stock configuration (no kernel patches), assuming the underlying
kernel's drm subsystem is 4.7 or higher. Newer platforms will require a kernel version
that provides support for that platform (e.g. Coffee Lake requires kernel 4.14 or higher).
Our default (most frequent) validation config is currently (as of Q1'18) Ubuntu 16.04.3 LTS.
Our default (most frequent) validation config is currently (as of Q4'18) Ubuntu 18.04 LTS.
### What toolchain do you recommend for building NEO on CentOS?
@ -28,8 +28,8 @@ intention to offer that option.
Our Windows release process takes up to several weeks before drivers are available through intel.com
and/or Windows update. Features available in github will be available on Windows later.
This is applicable for most recent driver version (currently 15.65 as of Q1'18)
- older platforms (e.g. Broadwell) are considered to be in maintenance mode for Windows.
Note: Older platforms (e.g. Broadwell) are considered to be in maintenance mode for Windows.
### Does NEO support Android?
@ -115,11 +115,8 @@ Neo will look for string value (REG_SZ) `C:\Program Files\application\app.exe` i
## Who are we?
NEO OpenCL team is part of VPG (Visual and Parallel Computing group). Historically, our team
was responsible for delivery of the closed source OpenCL driver for Windows, Linux, and Android.
With that in mind, we tend to compare NEO against previous closed source releases
(i.e. [SRB5](https://software.intel.com/en-us/articles/opencl-drivers#latest_linux_driver)).
NEO OpenCL team is part of VTT (Visual Technologies Team).
Historically, our team was responsible for delivery of the closed source OpenCL driver for Windows, Linux, and Android.
Most of the developers are located in Poland (UTC+1 timezone).

8
documentation/LIMITATIONS.md
View File

@ -7,14 +7,6 @@ assumed by default. Intel will clearly designate / tag specific builds to
indicate production quality including formal compliance. Other builds should be
considered experimental.
### Build limitations
While NEO can be compiled with various clang/gcc compilers, to compile the whole stack the following are required:
* clang-4.0
* llvm-4.0
* gcc < 7.0
* Python 2.7
### Functional delta
The driver has the following functional delta compared to previously released drivers:

12
documentation/RELEASES.md
View File

@ -2,7 +2,7 @@
## Every commit - must ...
* Build under Linux - using multiple versions of gcc (4.8 ... 7.3) and clang (4.0.1)
* Build under Linux - using clang (6.0, planning switch to 7.0) and multiple versions of gcc (5.2 ... 8.2)
* Build under Windows (this is currently a requirement that cannot be verified externally)
@ -16,12 +16,10 @@
## Weekly
* Once a week, we run extended cycle on a selected driver. When the extended cycle passes, the corresponding commit on github is tagged (e.g. "2018ww08"). Such version is considered recommended for the community use ("latest good")
* Once a week, we run extended cycle on a selected driver.
* For selected weekly tags, we may choose to release binaries (deb, rpm, tarball) - those will usually be considered a Beta driver.
* When the extended cycle passes, the corresponding commit on github is tagged using the format yy.ww.bbbb (yy - year, ww - work week, bbbb - incremental build number).
## Monthly / quarterly releases
* Typically for weekly tags we will post a binary release (e.g. deb).
* For major _driver_ releases, OpenCL driver is expected to be bundled with Media and/or MESA drivers. Cadence and timeline will be coordinated with our OTC colleagues.
* The driver releases (weekly/monthly/quarterly) will then be bundled with software products (Intel(R) Computer Vision SDK, Intel(R) SDK for OpenCL(TM) Applications, Intel(R) Media Server Studio, etc.) as appropriate.
* Quality level of the driver (per platform) will be provided in the Release Notes.