Skip to content

Commit b00236c

Browse files
committed
Rename doc subdirectories
Rename these two subdirectories based on review feedback.
1 parent 4adac8b commit b00236c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+48
-48
lines changed

sycl/ReleaseNotes.md

Lines changed: 10 additions & 10 deletions

sycl/doc/FAQ.md

Lines changed: 2 additions & 2 deletions

sycl/doc/GetStartedGuide.md

Lines changed: 3 additions & 3 deletions

sycl/doc/conf.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,19 @@
5151
'extensions/*',
5252

5353
# Sphinx complains about syntax errors in these files.
54-
'internal-design/DeviceLibExtensions.rst',
55-
'internal-design/SYCLPipesLoweringToSPIRV.rst',
56-
'internal-design/fpga_io_pipes_design.rst',
57-
'internal-design/Reduction_status.md'
54+
'design/DeviceLibExtensions.rst',
55+
'design/SYCLPipesLoweringToSPIRV.rst',
56+
'design/fpga_io_pipes_design.rst',
57+
'design/Reduction_status.md'
5858
]
5959

6060
suppress_warnings = [ 'misc.highlighting_failure' ]
6161

6262
def on_missing_reference(app, env, node, contnode):
6363
# Get the directory that contains the *source* file of the link. These
6464
# files are always relative to the directory containing "conf.py"
65-
# (<top>/sycl/doc). For example, the file "sycl/doc/internal-design/foo.md"
66-
# will have a directory "internal-design".
65+
# (<top>/sycl/doc). For example, the file "sycl/doc/design/foo.md" will
66+
# have a directory "design".
6767
refdoc_components = node['refdoc'].split('/')
6868
dirs = '/'.join(refdoc_components[:-1])
6969
if dirs: dirs += '/'

sycl/doc/extensions/experimental/SYCL_EXT_INTEL_ESIMD/README.md

Lines changed: 1 addition & 1 deletion

sycl/doc/extensions/supported/C-CXX-StandardLibrary.rst

Lines changed: 1 addition & 1 deletion

sycl/doc/index.rst

Lines changed: 16 additions & 16 deletions

sycl/source/detail/context_impl.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ class context_impl {
148148
/// cl_intel_devicelib_complex -> #<pi_program with complex functions>
149149
/// etc.
150150
///
151-
/// See `doc/internal-design/DeviceLibExtensions.rst' for
151+
/// See `doc/design/DeviceLibExtensions.rst' for
152152
/// more details.
153153
///
154154
/// \returns a map with device library programs.

sycl/source/detail/program_manager/program_manager.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class context;
4646
namespace detail {
4747

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

5252
class context_impl;

sycl/test/abi/pi_level_zero_symbol_check.dump

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
################################################################################
22
# This file is automatically generated by abi_check.py tool.
3-
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
3+
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
44
################################################################################
55

66
# 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

sycl/test/abi/pi_opencl_symbol_check.dump

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
################################################################################
22
# This file is automatically generated by abi_check.py tool.
3-
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
3+
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
44
################################################################################
55

66
# 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

sycl/test/abi/sycl_symbols_linux.dump

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
################################################################################
22
# This file is automatically generated by abi_check.py tool.
3-
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
3+
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
44
################################################################################
55

66
# 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

sycl/test/abi/sycl_symbols_windows.dump

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
################################################################################
22
# This file is automatically generated by abi_check.py tool.
3-
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.
3+
# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.
44
################################################################################
55

66
# 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

sycl/tools/abi_check.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def dump_symbols(target_path, output):
5858
with open(output, "w") as out:
5959
out.write("################################################################################")
6060
out.write("\n# This file is automatically generated by abi_check.py tool.")
61-
out.write("\n# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for more info.")
61+
out.write("\n# DO NOT EDIT IT MANUALLY. Refer to sycl/doc/developer/ABIPolicyGuide.md for more info.")
6262
out.write("\n################################################################################")
6363
out.write("\n\n# RUN: env LLVM_BIN_PATH=%llvm_build_bin_dir python")
6464
out.write(" %sycl_tools_src_dir/abi_check.py --mode check_symbols")
@@ -109,15 +109,15 @@ def check_symbols(ref_path, target_path):
109109
if missing_symbols:
110110
correct_return = False
111111
print(("There are missing symbols in the new library. It is a breaking "
112-
"change. Refer to sycl/doc/development-bkms/ABIPolicyGuide.md for further instructions. "
112+
"change. Refer to sycl/doc/developer/ABIPolicyGuide.md for further instructions. "
113113
"Do not forget to update ABI version according to the policy."))
114114
print('The following symbols are missing from the new object file:\n')
115115
print("\n".join(missing_symbols))
116116

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

0 commit comments

Comments
 (0)