Skip to content

Commit 149412a

Browse files
committed
[Test] NFC: Link out to SIL.rst.
Help readers find out what the specify_test instruction allows right away as they peruse the documentation.
1 parent faeb55b commit 149412a

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

SwiftCompilerSources/Sources/SIL/Test.swift

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
// This is done via the specify_test instruction. Using one or more instances
2929
// of it in your test case's SIL function, you can specify which test (instance
3030
// of FunctionTest) should be run and what arguments should be provided to it.
31+
// For full details of the specify_test instruction's grammar, see SIL.rst.
32+
//
3133
// The test grabs the arguments it expects out of the TestArguments instance
3234
// it is provided. It calls some function or functions. It then prints out
3335
// interesting results. These results can then be FileCheck'd.

include/swift/SIL/Test.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@
2626
// of a function. The goal is to get the same effect as calling a function and
2727
// checking its output.
2828
//
29-
// This is done via the specify_test instruction. Using one or more
30-
// instances of it in your test case's SIL function, you can specify which test
31-
// (instance of FunctionTest) should be run and what arguments should be
32-
// provided to it. The test grabs the arguments it expects out of the
33-
// test::Arguments instance it is provided. It calls some function or
34-
// functions. It then prints out interesting results. These results can then
35-
// be FileCheck'd.
29+
// This is done via the specify_test instruction. Using one or more instances
30+
// of it in your test case's SIL function, you can specify which test (instance
31+
// of FunctionTest) should be run and what arguments should be provided to it.
32+
// For full details of the specify_test instruction's grammar, see SIL.rst.
33+
//
34+
// The test grabs the arguments it expects out of the test::Arguments instance
35+
// it is provided. It calls some function or functions. It then prints out
36+
// interesting results. These results can then be FileCheck'd.
3637
//
3738
// CASE STUDY:
3839
// Here's an example of how it works:

0 commit comments

Comments
 (0)