[SYCL][DOC] Move supported extension docs #5421
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move the supported extensions to the "sycl/doc/extensions/supported" directory, and add a README explaining the content of that directory. Each extension document has also been renamed to match the name of its feature-test macro. Links to these extensions have been removed from the table in "sycl/doc/extensions/README.md" because we want to avoid the possibility of that table getting out-of-date with the directory contents. Instead, users can see the list of supported extensions by listing the content of the directory.
pvchupin
reviewed
Jan 29, 2022
sycl/doc/extensions/DiscardQueueEvents/SYCL_EXT_ONEAPI_DISCARD_QUEUE_EVENTS.asciidoc
Outdated
Show resolved
Hide resolved
sycl/doc/extensions/supported/SYCL_EXT_ONEAPI_BACKEND_LEVEL_ZERO.md
Outdated
Show resolved
Hide resolved
| @@ -22,7 +22,7 @@ Requirements | |||
|
|
|||
| Links | |||
| ----- | |||
| .. _Spec: https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/DataFlowPipes/data_flow_pipes.asciidoc | |||
| .. _Spec: https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/supported/SYCL_EXT_INTEL_DATAFLOW_PIPES.asciidoc | |||
There was a problem hiding this comment.
Not sure how to make relative link here :(
There was a problem hiding this comment.
I also don't know reStructuredText that well. When I look at the HTML rendering of this file in GitHub, all the content in this area of the document is missing. It seems like the GitHub renderer doesn't understand the .. code directive. So, there are bigger problems than the absolute vs. relative URL link.
bader
reviewed
Jan 30, 2022
Change absolute links to relative. Co-authored-by: Pavel Chupin <pavel.v.chupin@intel.com>
Fix the link syntax from @pvchupin's suggestion.
pvchupin
previously approved these changes
Jan 31, 2022
againull
previously approved these changes
Jan 31, 2022
kbobrovs
previously approved these changes
Feb 1, 2022
bader
previously approved these changes
Feb 1, 2022
gmlueck
dismissed stale reviews from bader, kbobrovs, againull, steffenlarsen, and pvchupin
via
1d627d4
Conflicts resolved. |
steffenlarsen
approved these changes
Feb 1, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Move the supported extensions to the "sycl/doc/extensions/supported"
directory, and add a README explaining the content of that directory.
Each extension document has also been renamed to match the name of
its feature-test macro.
Links to these extensions have been removed from the table in
"sycl/doc/extensions/README.md" because we want to avoid the
possibility of that table getting out-of-date with the directory
contents. Instead, users can see the list of supported extensions
by listing the content of the directory.