[SYCL][DOC] Update docs to reflect devicelib change #1368

hiaselhans · 2020-03-22T14:59:50Z

in sycl/doc/GetStartedGuide.md

add 'libdevice' to external_projects and enable_projects
add 'libdevice_source_dir'
add cross reference to buildbot configuration script

romanovvlad · 2020-03-22T15:11:03Z

@hiaselhans Please, sign-off you commit(git commit -s)

sycl/doc/GetStartedGuide.md

describe the use of buildbot scripts in GetStartedGuide.md * use configure.py and compile.py * describe common flags * remove unacessible opencl-aot flags (->enabled by default) * add cross reference to buildbot configuration script * set DPCPP_HOME to ~/sycl_workspace in unix Signed-off-by: hiaselhans <simon.klemenc@gmail.com>

hiaselhans · 2020-03-22T20:10:34Z

okay, thanks @bader for your feedback, i updated the docs to use the buildbot scripts.

question i have:

should we maybe advice to use --no-ocl by default? It might be the path of least troubles for users (like me :) ) how is that on windows?
i haven't tested all this on windows, but expect it to work more less the same...?

bader · 2020-03-23T04:49:45Z

should we maybe advice to use --no-ocl by default? It might be the path of least troubles for users (like me :) ) how is that on windows?

I think you laid it out perfectly. It might be useful to enable this option by default, but in this case I would not advice users to add this option, but rather change the script. I think it should be done in a separate PR. Does it sound reasonable?

i haven't tested all this on windows, but expect it to work more less the same...?

Looks good to me, although I haven't tried it neither. :-)

Thanks a lot for working on this!

Ruyk · 2020-03-23T15:13:40Z

sycl/doc/GetStartedGuide.md

-mkdir %DPCPP_HOME%\build
-cd %DPCPP_HOME%\build
+python %DPCPP_HOME%\llvm\buildbot\configure.py -s %DPCPP_HOME%\llvm -o %DPCPP_HOME%\build -t release
+python %DPCPP_HOME%\llvm\buildbot\compile.py -s %DPCPP_HOME%\llvm -o %DPCPP_HOME%\build


Does this need a particular python version? Does it work with python3?

i never tried on windows, but in my linux python3 is default and works.

@Ruyk @hiaselhans I don't see anything version-specific in those scripts. I believe both versions are supported. And they definitely work with Python 3, as it's part of CI pipeline.

Ruyk · 2020-03-23T15:19:06Z

sycl/doc/GetStartedGuide.md

-DLLVM_EXTERNAL_SYCL_SOURCE_DIR=$DPCPP_HOME/llvm/sycl \
-DLLVM_EXTERNAL_LLVM_SPIRV_SOURCE_DIR=$DPCPP_HOME/llvm/llvm-spirv \
-$DPCPP_HOME/llvm/llvm
+In case you want to configure Cmake manually the up-to-date reference for variables is in these files.


Suggested change

In case you want to configure Cmake manually the up-to-date reference for variables is in these files.

In case you want to configure CMake manually the up-to-date reference for variables is in these files.

Ruyk · 2020-03-23T15:20:45Z

sycl/doc/GetStartedGuide.md

@@ -36,11 +36,16 @@ Throughout this document `DPCPP_HOME` denotes the path to the local directory
 created as DPC++ workspace. It might be useful to create an environment variable
 with the same name.

+


Why this space?

accidential, fixed it :)

Signed-off-by: hiaselhans <simon.klemenc@gmail.com>

hiaselhans · 2020-03-23T16:04:21Z

Well, thanks for the comments,
two questions that arise from this way to configure CMake:

how can we make --no-ocl default as suggested by @bader but still let it remain in buildbot
build failed with -DSYCL_ENABLE_WERROR=ON on my machine, should i change the script to include a --no-werror flag?

better to open a seperate issue and pr for this?

bader · 2020-03-24T11:00:26Z

Well, thanks for the comments,
two questions that arise from this way to configure CMake:

how can we make --no-ocl default as suggested by @bader but still let it remain in buildbot

build failed with -DSYCL_ENABLE_WERROR=ON on my machine, should i change the script to include a --no-werror flag?

better to open a seperate issue and pr for this?

I suggest handling this issues separately.
Thanks!

alexbatashev · 2020-03-24T11:56:45Z

sycl/doc/GetStartedGuide.md

@@ -55,55 +59,49 @@ Open a developer command prompt using one of two methods:
 ```bat
 set DPCPP_HOME=%USERPROFILE%\sycl_workspace
 mkdir %DPCPP_HOME%
+cd %DPCPP_HOME%
+
+git clone https://github.com/intel/llvm -b sycl


I'm not sure if we really want to do this. But shallow clone would dramatically decrease download times for those who just want's to build the latest version (instead of working on new features/bugfixes).

Suggested change

git clone https://github.com/intel/llvm -b sycl

git clone --depth 1 https://github.com/intel/llvm -b sycl

alexbatashev

LGTM

romanovvlad previously approved these changes Mar 22, 2020

View reviewed changes

romanovvlad linked an issue Mar 22, 2020 that may be closed by this pull request

"libsycl-fallback-cassert.spv" not found #1367

Closed

bader reviewed Mar 22, 2020

View reviewed changes

sycl/doc/GetStartedGuide.md Outdated Show resolved Hide resolved

hiaselhans dismissed romanovvlad’s stale review via 251c76b March 22, 2020 15:13

hiaselhans force-pushed the update_docs branch 6 times, most recently from e97c6f7 to 9d092eb Compare March 22, 2020 20:04

hiaselhans force-pushed the update_docs branch from 9d092eb to 2cf077c Compare March 22, 2020 20:06

bader requested review from Ruyk, vladimirlaz and alexbatashev March 23, 2020 04:45

bader changed the title ~~[SYCL][DOC] update docs to reflect devicelib change~~ [SYCL][DOC] Update docs to reflect devicelib change Mar 23, 2020

bader previously approved these changes Mar 23, 2020

View reviewed changes

Ruyk previously approved these changes Mar 23, 2020

View reviewed changes

hiaselhans dismissed stale reviews from Ruyk and bader via 3ab26d9 March 23, 2020 16:00

fix typos

55b0896

Signed-off-by: hiaselhans <simon.klemenc@gmail.com>

hiaselhans force-pushed the update_docs branch from 3ab26d9 to 55b0896 Compare March 23, 2020 16:01

romanovvlad requested a review from bader March 24, 2020 08:40

bader approved these changes Mar 24, 2020

View reviewed changes

alexbatashev reviewed Mar 24, 2020

View reviewed changes

alexbatashev approved these changes Mar 24, 2020

View reviewed changes

bader merged commit 75ee39b into intel:sycl Mar 24, 2020

hiaselhans mentioned this pull request Mar 31, 2020

[SYCL] Modify configure script #1421

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SYCL][DOC] Update docs to reflect devicelib change #1368

[SYCL][DOC] Update docs to reflect devicelib change #1368

hiaselhans commented Mar 22, 2020

romanovvlad commented Mar 22, 2020

hiaselhans commented Mar 22, 2020

bader commented Mar 23, 2020

Ruyk Mar 23, 2020

hiaselhans Mar 23, 2020

alexbatashev Mar 24, 2020

Ruyk Mar 23, 2020

hiaselhans Mar 23, 2020

Ruyk Mar 23, 2020

hiaselhans Mar 23, 2020

hiaselhans commented Mar 23, 2020

bader commented Mar 24, 2020

alexbatashev Mar 24, 2020

alexbatashev left a comment

	In case you want to configure Cmake manually the up-to-date reference for variables is in these files.
	In case you want to configure CMake manually the up-to-date reference for variables is in these files.

		@@ -36,11 +36,16 @@ Throughout this document `DPCPP_HOME` denotes the path to the local directory
		created as DPC++ workspace. It might be useful to create an environment variable
		with the same name.

	git clone https://github.com/intel/llvm -b sycl
	git clone --depth 1 https://github.com/intel/llvm -b sycl

[SYCL][DOC] Update docs to reflect devicelib change #1368

[SYCL][DOC] Update docs to reflect devicelib change #1368

Conversation

hiaselhans commented Mar 22, 2020

romanovvlad commented Mar 22, 2020

hiaselhans commented Mar 22, 2020

bader commented Mar 23, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hiaselhans commented Mar 23, 2020

bader commented Mar 24, 2020

Choose a reason for hiding this comment

alexbatashev left a comment

Choose a reason for hiding this comment