explain why we have a fake cfail test

diff --git a/src/test/compile-fail/feature-gate-linker-flavor.rs b/src/test/compile-fail/feature-gate-linker-flavor.rs
index 68679d7dac896a22a04f855fdc6ca7aea911cf22..955ec39cda1e550a3db00ae58f303fccda711e6f 100644 (file)
--- a/src/test/compile-fail/feature-gate-linker-flavor.rs
+++ b/src/test/compile-fail/feature-gate-linker-flavor.rs
@@ -8,6 +8,11 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+// This is a fake compile fail test as there's no way to generate a
+// `#![feature(linker_flavor)]` error. The only reason we have a `linker_flavor`
+// feature gate is to be able to document `-Z linker-flavor` in the unstable
+// book
+
 #[used]
 fn foo() {}
 //~^^ ERROR the `#[used]` attribute is an experimental feature