Skip to content

Commit

Permalink
Added known issues section
Browse files Browse the repository at this point in the history
  • Loading branch information
outoftardis committed Feb 5, 2020
1 parent 0a3b6c7 commit 9a212d0
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/_static/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ table.optimization-notice td p:last-child {
text-align: right;
}

img.with-border {
border:1px solid #021a40;
}

/*
.rst-content tt.literal, .rst-content code.literal, .highlight {
background: #f0f0f0;
Expand Down
6 changes: 6 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,9 @@ list of features and documentation are available at |daal-docs|_.
:caption: Examples

sycl_examples.rst

.. toctree::
:maxdepth: 1
:caption: Notes

notes/known_issues.rst
Binary file added docs/source/notes/images/runtime_error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions docs/source/notes/known_issues.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. ******************************************************************************
.. * Copyright 2014-2020 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/
Known Issues
============

DLL file not found
******************

If you run your program in Visual Studio and encounter a "sycl.dll was not found" runtime error
or a similar one such as the one shown below, update the project property :guilabel:`Debugging` > :guilabel:`Environment`.
To do this, follow `How to Fix`_ instructions.

.. image:: images/runtime_error.png
:alt: Unable to start a program: the code execution cannot proceed because XXX.dll was not found.
:class: with-border

.. attention::

The issue appears as the result of how Visual Studio 2017 and its later versions
handle additional directories for the ``PATH`` environment variable.

How to Fix
----------

1. Open the project's properties, go to :guilabel:`Debugging` > :guilabel:`Environment` property,
right-click the drop-down menu, and select :guilabel:`Edit`:

.. image:: images/vsproj_debug_step1_open.png
:width: 600
:alt: Changing configuration properties
:class: with-border

2. Copy the default value of the ``PATH`` environment variable from the :guilabel:`Evaluated value`
section and then paste it to the section above it:

.. image:: images/vsproj_debug_step2_copy.png
:width: 600
:alt: Changing configuration properties
:class: with-border

3. Add to ``PATH`` the paths to the dll files that the program needs:

.. image:: images/vsproj_debug_step3_add.png
:width: 600
:alt: Changing configuration properties
:class: with-border

0 comments on commit 9a212d0

Please sign in to comment.