Skip to content

Commit e173b8d

Browse files
author
Alexander Batashev
authored
[SYCL][NFC] Suggest reading docs on ABI test fail (#2175)
If abi_check.py fails to match symbols, print a message that guides to the ABI policy guide with instructions on how to fix the test. Signed-off-by: Alexander Batashev <[email protected]>
1 parent da6d1dc commit e173b8d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

sycl/tools/abi_check.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,16 @@ def check_symbols(ref_path, target_path):
9191
correct_return = True
9292
if missing_symbols:
9393
correct_return = False
94+
print(("There are missing symbols in the new library. It is a breaking "
95+
"change. Refer to sycl/doc/ABIPolicyGuide.md for further instructions. "
96+
"Do not forget to update ABI version according to the policy."))
9497
print('The following symbols are missing from the new object file:\n')
9598
print("\n".join(missing_symbols))
9699

97100
if new_symbols:
98101
correct_return = False
102+
print(("There are new symbols in the new library. It is a non-breaking "
103+
"change. Refer to sycl/doc/ABIPolicyGuide.md for further instructions."))
99104
print('The following symbols are new to the object file:\n')
100105
print("\n".join(new_symbols))
101106

0 commit comments

Comments
 (0)