Skip to content

Commit

Permalink
Rename doc subdirectories
Browse files Browse the repository at this point in the history
Rename these two subdirectories based on review feedback.
  • Loading branch information
gmlueck committed Feb 15, 2022
1 parent 4adac8b commit b00236c
Show file tree
Hide file tree
Showing 47 changed files with 48 additions and 48 deletions.
20 changes: 10 additions & 10 deletions sycl/ReleaseNotes.md
Expand Up @@ -15,18 +15,18 @@ Release notes for commit range 4fc5ebe..bd68232
- Added support for SYCL 2020 exceptions [5c0f748][eef07606][5af8c43d]
- Added support for [SYCL_EXT_INTEL_BF16_CONVERSION extension](doc/extensions/experimental/SYCL_EXT_INTEL_BF16_CONVERSION.asciidoc)
[8075463]
- Added support for fallback implementation of [assert feature](doc/internal-design/Assert.md)
- Added support for fallback implementation of [assert feature](doc/design/Assert.md)
[56c9ec4]
- Added support SYCL 2020 `sycl::logical_and` and `sycl::logical_or` operators
[6c077a0]
### Documentation
- Added design document for [optional kernel features](doc/internal-design/OptionalDeviceFeatures.md)
- Added design document for [optional kernel features](doc/design/OptionalDeviceFeatures.md)
[88cfe16]
- Added [SYCL_INTEL_bf16_conversion extension document](doc/extensions/experimental/SYCL_EXT_INTEL_BF16_CONVERSION.asciidoc)
[9f8cc3af]
- Align [SYCL_EXT_ONEAPI_GROUP_MASK extension](doc/extensions/supported/SYCL_EXT_ONEAPI_SUB_GROUP_MASK.asciidoc)
with SYCL 2020 specification [a06bd1fb]
- Added [documentation](doc/internal-design/SYCLInstrumentationUsingXPTI.md) of XPTI related
- Added [documentation](doc/design/SYCLInstrumentationUsingXPTI.md) of XPTI related
tracing in SYCL [1308fe7b]
- Align `SYCL_EXT_ONEAPI_LOCAL_MEMORY` extension
[document](doc/extensions/supported/SYCL_EXT_ONEAPI_LOCAL_MEMORY.asciidoc) with SYCL 2020
Expand Down Expand Up @@ -1104,7 +1104,7 @@ Release notes for commit range c9d50752..5d7e0925
- The SYCL library doesn't guarantee stable API/ABI, so applications compiled
with older version of the SYCL library may not work with new one.
The workaround is to rebuild the application.
[ABI policy guide](doc/development-bkms/ABIPolicyGuide.md)
[ABI policy guide](doc/developer/ABIPolicyGuide.md)
- Using `cl::sycl::program` API to refer to a kernel defined in another
translation unit leads to undefined behavior
- Linkage errors with the following message:
Expand Down Expand Up @@ -1243,7 +1243,7 @@ Release notes for commit range 5976ff0..1fc0e4f
- The SYCL library doesn't guarantee stable API/ABI, so applications compiled
with older version of the SYCL library may not work with new one.
The workaround is to rebuild the application.
[ABI policy guide](doc/development-bkms/ABIPolicyGuide.md)
[ABI policy guide](doc/developer/ABIPolicyGuide.md)
- Using `cl::sycl::program` API to refer to a kernel defined in another
translation unit leads to undefined behavior
- Linkage errors with the following message:
Expand Down Expand Up @@ -1431,7 +1431,7 @@ Release notes for the commit range 75b3dc2..5976ff0
- The SYCL library doesn't guarantee stable API/ABI, so applications compiled
with older version of the SYCL library may not work with new one.
The workaround is to rebuild the application.
[ABI policy guide](doc/development-bkms/ABIPolicyGuide.md)
[ABI policy guide](doc/developer/ABIPolicyGuide.md)
- Using `cl::sycl::program` API to refer to a kernel defined in another
translation unit leads to undefined behavior
- Linkage errors with the following message:
Expand Down Expand Up @@ -1585,7 +1585,7 @@ Release notes for the commit range ba404be..24726df
- The SYCL library doesn't guarantee stable API/ABI, so applications compiled
with older version of the SYCL library may not work with new one.
The workaround is to rebuild the application.
[ABI policy guide](doc/development-bkms/ABIPolicyGuide.md)
[ABI policy guide](doc/developer/ABIPolicyGuide.md)
- Using `cl::sycl::program` API to refer to a kernel defined in another
translation unit leads to undefined behavior
- Linkage errors with the following message:
Expand Down Expand Up @@ -1661,7 +1661,7 @@ Release notes for the commit range ba404be..67d3d9e
- Updated prerequisites in GetStartedGuide(doc/GetStartedGuide.md) [5d0d034]
- Published a [proposal](doc/extensions/KernelRHSAttributes/SYCL_INTEL_attribute_style.asciidoc)
for function-type attributes (right-sided) for kernel attributes [5d5351b]
- The [compiler and runtime design doc](doc/internal-design/CompilerAndRuntimeDesign.md) has
- The [compiler and runtime design doc](doc/design/CompilerAndRuntimeDesign.md) has
been updated to describe the CUDA target and reflect changed action graphs
[91b597b] [212a26c]
- [ExtendedAtomics documentation](doc/extensions/ExtendedAtomics/README.md)
Expand All @@ -1673,7 +1673,7 @@ Release notes for the commit range ba404be..67d3d9e
- Published [device_specific_kernel_queries](doc/extensions/DeviceSpecificKernelQueries/SYCL_INTEL_device_specific_kernel_queries.asciidoc)
extension which rephrases work group queries as device-specific kernel
queries [4c07ff8]
- Added more information about the [plugin interface (PI)](doc/internal-design/PluginInterface.md)
- Added more information about the [plugin interface (PI)](doc/design/PluginInterface.md)
[0614e9a]
- [Contribution guidelines](../CONTRIBUTING.md) were simplified, now sign-off
line is not required [7886fd8]
Expand Down Expand Up @@ -1736,7 +1736,7 @@ Release notes for the commit range ba404be..67d3d9e
- The SYCL library doesn't guarantee stable API/ABI, so applications compiled
with older version of the SYCL library may not work with new one.
The workaround is to rebuild the application.
[ABI policy guide](doc/development-bkms/ABIPolicyGuide.md)
[ABI policy guide](doc/developer/ABIPolicyGuide.md)
- Using `cl::sycl::program` API to refer to a kernel defined in another
translation unit leads to undefined behavior
- Linkage errors with the following message:
Expand Down
4 changes: 2 additions & 2 deletions sycl/doc/FAQ.md
Expand Up @@ -58,7 +58,7 @@ compiler command-line interface in general, please refer to the
To learn more about the concepts behind this flow, and the DPC++
Compiler internals as such, we welcome you to study our
[DPC++ Compiler and Runtime architecture design](
internal-design/CompilerAndRuntimeDesign.md) document.
design/CompilerAndRuntimeDesign.md) document.


## Using applications built with DPC++
Expand Down Expand Up @@ -150,7 +150,7 @@ debugging tools of your choice for the host device code.

Furthermore, developers can extend capabilities of the DPC++ Runtime to
non-OpenCL devices by writing correspondent plugins. To learn more, please
check out our [Plugin Interface Guide](internal-design/PluginInterface.md).
check out our [Plugin Interface Guide](design/PluginInterface.md).

### Q: DPC++ applications hang on Intel GPUs while working well on other devices
**A:** One of the common reasons is Intel GPUs feature called "hang check".
Expand Down
6 changes: 3 additions & 3 deletions sycl/doc/GetStartedGuide.md
Expand Up @@ -54,7 +54,7 @@ docker run --name sycl_build -it -v /local/workspace/dir/:/src ghcr.io/intel/llv
```

This command will start a terminal session, from which you can proceed with the
instructions below. See [Docker BKMs](development-bkms/DockerBKMs.md) for more info on Docker
instructions below. See [Docker BKMs](developer/DockerBKMs.md) for more info on Docker
commands.

### Create DPC++ workspace
Expand Down Expand Up @@ -434,7 +434,7 @@ command:

### Obtain prerequisites for ahead of time (AOT) compilation

[Ahead of time compilation](internal-design/CompilerAndRuntimeDesign.md#ahead-of-time-aot-compilation)
[Ahead of time compilation](design/CompilerAndRuntimeDesign.md#ahead-of-time-aot-compilation)
requires ahead of time compiler available in `PATH`. There is
AOT compiler for each device type:

Expand Down Expand Up @@ -660,7 +660,7 @@ clang++ -fsycl -fsycl-targets=spir64_gen,spir64_x86_64 simple-sycl-app.cpp -o si

Additionally, user can pass specific options of AOT compiler to
the DPC++ compiler using ```-Xsycl-target-backend``` option, see
[Device code formats](internal-design/CompilerAndRuntimeDesign.md#device-code-formats) for
[Device code formats](design/CompilerAndRuntimeDesign.md#device-code-formats) for
more. To find available options, execute:

```ocloc compile --help``` for GPU,
Expand Down
12 changes: 6 additions & 6 deletions sycl/doc/conf.py
Expand Up @@ -51,19 +51,19 @@
'extensions/*',

# Sphinx complains about syntax errors in these files.
'internal-design/DeviceLibExtensions.rst',
'internal-design/SYCLPipesLoweringToSPIRV.rst',
'internal-design/fpga_io_pipes_design.rst',
'internal-design/Reduction_status.md'
'design/DeviceLibExtensions.rst',
'design/SYCLPipesLoweringToSPIRV.rst',
'design/fpga_io_pipes_design.rst',
'design/Reduction_status.md'
]

suppress_warnings = [ 'misc.highlighting_failure' ]

def on_missing_reference(app, env, node, contnode):
# Get the directory that contains the *source* file of the link. These
# files are always relative to the directory containing "conf.py"
# (<top>/sycl/doc). For example, the file "sycl/doc/internal-design/foo.md"
# will have a directory "internal-design".
# (<top>/sycl/doc). For example, the file "sycl/doc/design/foo.md" will
# have a directory "design".
refdoc_components = node['refdoc'].split('/')
dirs = '/'.join(refdoc_components[:-1])
if dirs: dirs += '/'
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
Expand Up @@ -81,7 +81,7 @@ extension.
##### Features not supported with ESIMD extension:
- The [C and C++ Standard libraries support](../supported/C-CXX-StandardLibrary.rst)
- The [Device library extensions](../../../internal-design/DeviceLibExtensions.rst)
- The [Device library extensions](../../../design/DeviceLibExtensions.rst)
- Host device
##### Unsupported standard SYCL APIs:
Expand Down
2 changes: 1 addition & 1 deletion sycl/doc/extensions/supported/C-CXX-StandardLibrary.rst
Expand Up @@ -238,7 +238,7 @@ Device compiler
Device compiler is free to implement these `__devicelib_*` functions.
In order to indicate support for a particular set of functions,
underlying runtime have to support the corresponding OpenCL (PI)
extension. See ``../../internal-design/DeviceLibExtensions.rst`` for
extension. See ``../../design/DeviceLibExtensions.rst`` for
a list of supported functions and corresponding extensions.

Fallback implementation
Expand Down
32 changes: 16 additions & 16 deletions sycl/doc/index.rst
Expand Up @@ -27,26 +27,26 @@ Developing oneAPI DPC++ Compiler
API Reference <https://intel.github.io/llvm-docs/doxygen>
Clang Documentation <https://intel.github.io/llvm-docs/clang>
Clang API Reference <https://intel.github.io/llvm-docs/clang_doxygen>
internal-design/CompilerAndRuntimeDesign
internal-design/KernelParameterPassing
internal-design/PluginInterface
internal-design/SpecializationConstants
internal-design/KernelProgramCache
internal-design/GlobalObjectsInRuntime
internal-design/LinkedAllocations
internal-design/Assert
internal-design/SharedLibraries
internal-design/OptionalDeviceFeatures
internal-design/SYCLInstrumentationUsingXPTI
internal-design/ITTAnnotations
internal-design/DeviceGlobal
internal-design/CompileTimeProperties
design/CompilerAndRuntimeDesign
design/KernelParameterPassing
design/PluginInterface
design/SpecializationConstants
design/KernelProgramCache
design/GlobalObjectsInRuntime
design/LinkedAllocations
design/Assert
design/SharedLibraries
design/OptionalDeviceFeatures
design/SYCLInstrumentationUsingXPTI
design/ITTAnnotations
design/DeviceGlobal
design/CompileTimeProperties

Development BKMs
~~~~~~~~~~~~~~~~

.. toctree::
:maxdepth: 1

development-bkms/DockerBKMs
development-bkms/ABIPolicyGuide
developer/DockerBKMs
developer/ABIPolicyGuide
2 changes: 1 addition & 1 deletion sycl/source/detail/context_impl.hpp
Expand Up @@ -148,7 +148,7 @@ class context_impl {
/// cl_intel_devicelib_complex -> #<pi_program with complex functions>
/// etc.
///
/// See `doc/internal-design/DeviceLibExtensions.rst' for
/// See `doc/design/DeviceLibExtensions.rst' for
/// more details.
///
/// \returns a map with device library programs.
Expand Down
2 changes: 1 addition & 1 deletion sycl/source/detail/program_manager/program_manager.hpp
Expand Up @@ -46,7 +46,7 @@ class context;
namespace detail {

// This value must be the same as in libdevice/device_itt.h.
// See sycl/doc/internal-design/ITTAnnotations.md for more info.
// See sycl/doc/design/ITTAnnotations.md for more info.
static constexpr uint32_t inline ITTSpecConstId = 0xFF747469;

class context_impl;
Expand Down
2 changes: 1 addition & 1 deletion sycl/test/abi/pi_level_zero_symbol_check.dump
@@ -1,6 +1,6 @@
################################################################################
# This file is automatically generated by abi_check.py tool.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
################################################################################

# RUN: env LLVM_BIN_PATH=%llvm_build_bin_dir python %sycl_tools_src_dir/abi_check.py --mode check_symbols --reference %s %sycl_libs_dir/libpi_level_zero.so
Expand Down
2 changes: 1 addition & 1 deletion sycl/test/abi/pi_opencl_symbol_check.dump
@@ -1,6 +1,6 @@
################################################################################
# This file is automatically generated by abi_check.py tool.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
################################################################################

# RUN: env LLVM_BIN_PATH=%llvm_build_bin_dir python %sycl_tools_src_dir/abi_check.py --mode check_symbols --reference %s %sycl_libs_dir/libpi_opencl.so
Expand Down
2 changes: 1 addition & 1 deletion sycl/test/abi/sycl_symbols_linux.dump
@@ -1,6 +1,6 @@
################################################################################
# This file is automatically generated by abi_check.py tool.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
################################################################################

# RUN: env LLVM_BIN_PATH=%llvm_build_bin_dir python %sycl_tools_src_dir/abi_check.py --mode check_symbols --reference %s %sycl_libs_dir/libsycl.so
Expand Down
2 changes: 1 addition & 1 deletion sycl/test/abi/sycl_symbols_windows.dump
@@ -1,6 +1,6 @@
################################################################################
# This file is automatically generated by abi_check.py tool.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
################################################################################

# RUN: env LLVM_BIN_PATH=%llvm_build_bin_dir python %sycl_tools_src_dir/abi_check.py --mode check_symbols --reference %s %llvm_build_bin_dir/sycl.dll
Expand Down
6 changes: 3 additions & 3 deletions sycl/tools/abi_check.py
Expand Up @@ -58,7 +58,7 @@ def dump_symbols(target_path, output):
with open(output, "w") as out:
out.write("################################################################################")
out.write("\n# This file is automatically generated by abi_check.py tool.")
out.write("\n# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.")
out.write("\n# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.")
out.write("\n################################################################################")
out.write("\n\n# RUN: env LLVM_BIN_PATH=%llvm_build_bin_dir python")
out.write(" %sycl_tools_src_dir/abi_check.py --mode check_symbols")
Expand Down Expand Up @@ -109,15 +109,15 @@ def check_symbols(ref_path, target_path):
if missing_symbols:
correct_return = False
print(("There are missing symbols in the new library. It is a breaking "
"change. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for further instructions. "
"change. Refer to sycl/doc/developer/ABIPolicyGuide.md for further instructions. "
"Do not forget to update ABI version according to the policy."))
print('The following symbols are missing from the new object file:\n')
print("\n".join(missing_symbols))

if new_symbols:
correct_return = False
print(("There are new symbols in the new library. It is a non-breaking "
"change. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for further instructions."))
"change. Refer to sycl/doc/developer/ABIPolicyGuide.md for further instructions."))
print('The following symbols are new to the object file:\n')
print("\n".join(new_symbols))

Expand Down

0 comments on commit b00236c

Please sign in to comment.