about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorBrad Gibson <b2b@humanenginuity.com>2018-02-20 15:32:17 -0800
committerBrad Gibson <b2b@humanenginuity.com>2018-02-20 15:32:17 -0800
commit6947abdcf3ec34b1e5a88390e663b4661229fedc (patch)
tree4299557f2616ac87c6b887ffd8ffb29c8014e66e /src/doc/rustc-dev-guide
parentbaafc5b354f289210dc0537fe9b646bdf1ae0406 (diff)
downloadrust-6947abdcf3ec34b1e5a88390e663b4661229fedc.tar.gz
rust-6947abdcf3ec34b1e5a88390e663b4661229fedc.zip
added compiletest to summary.md; linked to existing resources for additional information
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/SUMMARY.md1
-rw-r--r--src/doc/rustc-dev-guide/src/compiletest.md6
2 files changed, 5 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md
index 6a3907551bc..1926a58cfc1 100644
--- a/src/doc/rustc-dev-guide/src/SUMMARY.md
+++ b/src/doc/rustc-dev-guide/src/SUMMARY.md
@@ -2,6 +2,7 @@
 
 - [About this guide](./about-this-guide.md)
 - [How to build the compiler and run what you built](./how-to-build-and-run.md)
+    - [Using `compiletest` + commands to control test execution](./compiletest.md)
 - [Using the compiler testing framework](./running-tests.md)
 - [How to add new header commands to `compiletest`](./compiletest.md)
 - [Walkthrough: a typical contribution](./walkthrough.md)
diff --git a/src/doc/rustc-dev-guide/src/compiletest.md b/src/doc/rustc-dev-guide/src/compiletest.md
index 0b10cfbb774..e080e6ce7b5 100644
--- a/src/doc/rustc-dev-guide/src/compiletest.md
+++ b/src/doc/rustc-dev-guide/src/compiletest.md
@@ -6,7 +6,8 @@ configure behavior and expected results of both individual and groups of tests.
 
 `compiletest` tests may check test code for success, for failure or in some cases, even failure to compile.  Tests are
 typically organized as a Rust source file with annotations in comments before and/or within the test code, which serve to
-direct `compiletest` on if or how to run the test, what behavior to expect, and more.
+direct `compiletest` on if or how to run the test, what behavior to expect, and more.  If you are unfamiliar with the compiler
+testing framework, see [`this chapter`](https://github.com/rust-lang-nursery/rustc-guide/blob/master/src/tests/intro.md) for additional background.
 
 The tests themselves are typically (but not always) organized into "suites"--for example, `run-pass`, a folder
 representing tests that should succeed, `run-fail`, a folder holding tests that should compile successfully, but return
@@ -16,8 +17,9 @@ introduction to the different suites of compiler tests along with details about
 [here, at Brian Anderson's blog](https://brson.github.io/2017/07/10/how-rust-is-tested#s-ct).
 
 ## Adding a new test file
-Simply create your new test in the appropriate location under [src/test](https://github.com/rust-lang/rust/tree/master/src/test).  No registration of test files is necessary as 
+Briefly, simply create your new test in the appropriate location under [src/test](https://github.com/rust-lang/rust/tree/master/src/test).  No registration of test files is necessary as 
 `compiletest` will scan the [src/test](https://github.com/rust-lang/rust/tree/master/src/test) subfolder recursively, and will execute any Rust source files it finds as tests.
+See [`Adding new tests`](https://github.com/rust-lang-nursery/rustc-guide/blob/master/src/tests/adding.md) for a complete guide on how to adding new tests. 
 
 ## Header Commands
 Source file annotations which appear in comments near the top of the source file *before* any test code are known as header