llvm icon indicating copy to clipboard operation
llvm copied to clipboard

[SYCL][Doc] Update docs to reflect PI removal.

Open aarongreig opened this issue 1 year ago • 10 comments

Fixes #14928

aarongreig avatar Aug 13 '24 16:08 aarongreig

Also other things:

9 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L46

has to be updated, we don't have sycl/pi_win_proxy_loader anymore.

10 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L125-L131 We need to rename @intel/dpcpp-nativecpu-pi-reviewers as well (to @intel/dpcpp-nativecpu-ur-reviewers ?) @stdale-intel, can you please rename the group? @aarongreig or @stdale-intel, can you please update the CODEOWNERS file after that?

dm-vodopyanov avatar Aug 14 '24 11:08 dm-vodopyanov

+ more

11 https://github.com/intel/llvm/tree/sycl/sycl/test-e2e/Plugin folder has to be renamed? (+ rename in CODEOWNERS after that)

12 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/workflows/sycl-linux-build.yml#L172

13 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/workflows/sycl-macos-build-and-test.yml#L56

14 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/buildbot/configure.py#L54

15 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/buildbot/configure.py#L95

16 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/buildbot/configure.py#L179

17 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/buildbot/configure.py#L71

18 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/buildbot/configure.py#L155-L156

dm-vodopyanov avatar Aug 14 '24 11:08 dm-vodopyanov

+ update XPTI

19 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/xpti/doc/SYCL_Tracing_Implementation.md?plain=1#L66-L70

20 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/source/detail/xpti_registry.hpp#L30

21 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/unittests/xpti_trace/NodeCreation.cpp#L45

22 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/unittests/xpti_trace/QueueIDCheck.cpp#L49

23 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/xptifw/samples/syclpi_collector/README.md?plain=1#L1-L24

24 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/xptifw/samples/syclpi_collector/syclpi_collector.cpp#L41

25 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/xptifw/samples/sycl_perf_collector/sycl_perf_collector.cpp#L842

26 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/xptifw/samples/sycl_perf_collector/sycl-perf.sh#L35

27 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/source/detail/xpti_registry.hpp#L30-L34

28 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/xptifw/samples/syclpi_collector/CMakeLists.txt#L1-L15

(@KseniyaTikhomirova can provide more information about the update of XPTI (if any)).

dm-vodopyanov avatar Aug 14 '24 11:08 dm-vodopyanov

29 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/CONTRIBUTING.md?plain=1#L61

dm-vodopyanov avatar Aug 14 '24 12:08 dm-vodopyanov

+

30 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/doc/GetStartedGuide.md?plain=1#L211-L214

31 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/doc/GetStartedGuide.md?plain=1#L246-L247

dm-vodopyanov avatar Aug 14 '24 12:08 dm-vodopyanov

32 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/sycl/cmake/modules/AddSYCL.cmake#L47-L98

dm-vodopyanov avatar Aug 14 '24 13:08 dm-vodopyanov

@dm-vodopyanov thanks for all the feedback

For point #1, the comment is still correct as it refers to the Plugin object (which arguably should be renamed but that isn't a task for this PR) For points #14, #15 and #16, the cmake variable is still called that. I think I'll spin out a separate PR to rename it. Points #30 and #31 are kind of weird, we still call them "plugin releases" on our website (the page pointed to). That's an issue I can raise internally, but it might be worth leaving the wording as is to match up with what you see if you click the link.

I'm not sure what to do about #23, #24, #25 and #26. The pi_collector example will for sure need re-written now that sycl.pi has been removed, I'll open another sub-ticket on the post-merge work issue to look into this as it's not as trivial as just updating docs.

aarongreig avatar Aug 16 '24 11:08 aarongreig

Points #30 and #31 are kind of weird, we still call them "plugin releases" on our website (the page pointed to). That's an issue I can raise internally, but it might be worth leaving the wording as is to match up with what you see if you click the link.

It isn't clear if we'll change the terminology on the website, but it for sure wont be until after the next release since the current latest release on there is inarguably a PI plugin.

aarongreig avatar Aug 16 '24 11:08 aarongreig

Also other things:

9

https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L46

has to be updated, we don't have sycl/pi_win_proxy_loader anymore.

10

https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L125-L131

We need to rename @intel/dpcpp-nativecpu-pi-reviewers as well (to @intel/dpcpp-nativecpu-ur-reviewers ?) @stdale-intel, can you please rename the group? @aarongreig or @stdale-intel, can you please update the CODEOWNERS file after that?

Adding @stdale-intel to reviewers because of the action above

dm-vodopyanov avatar Aug 19 '24 14:08 dm-vodopyanov

Also other things: 9 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L46

has to be updated, we don't have sycl/pi_win_proxy_loader anymore. 10 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L125-L131

We need to rename @intel/dpcpp-nativecpu-pi-reviewers as well (to @intel/dpcpp-nativecpu-ur-reviewers ?) @stdale-intel, can you please rename the group? @aarongreig or @stdale-intel, can you please update the CODEOWNERS file after that?

Adding @stdale-intel to reviewers because of the action above

maybe we can spin this out into its own issue?

aarongreig avatar Sep 13 '24 10:09 aarongreig

ping @intel/dpcpp-specification-reviewers @intel/dpcpp-devops-reviewers

aarongreig avatar Oct 29 '24 14:10 aarongreig

@steffenlarsen would you mind taking a look at this so we can get it over the line?

aarongreig avatar Nov 01 '24 10:11 aarongreig

Also other things: 9 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L46

has to be updated, we don't have sycl/pi_win_proxy_loader anymore. 10 https://github.com/intel/llvm/blob/07bf3c11ebeafbbb408708dd79f578ec7c974423/.github/CODEOWNERS#L125-L131

We need to rename @intel/dpcpp-nativecpu-pi-reviewers as well (to @intel/dpcpp-nativecpu-ur-reviewers ?) @stdale-intel, can you please rename the group? @aarongreig or @stdale-intel, can you please update the CODEOWNERS file after that?

Adding @stdale-intel to reviewers because of the action above

maybe we can spin this out into its own issue?

@dm-vodopyanov @stdale-intel I've created an issue to track so we can unblock merging this https://github.com/intel/llvm/issues/15956

aarongreig avatar Nov 01 '24 10:11 aarongreig

@bader please take a look so we can get this in for 2025.1

aarongreig avatar Nov 20 '24 16:11 aarongreig

@intel/llvm-gatekeepers I think we're good to merge this

aarongreig avatar Nov 26 '24 17:11 aarongreig