From 6ed7846257af7c2da9d2164916eb8fe150b50ec2 Mon Sep 17 00:00:00 2001
From: Corey Farwell <coreyf@rwell.org>
Date: Tue, 15 Mar 2016 16:33:59 -0400
Subject: [PATCH] Add comment about opt-in nature of compiletest note/help
 messages.

The opt-in functionality was proposed and discussed in
https://github.com/rust-lang/rust/issues/21195
---
 src/compiletest/runtest.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/compiletest/runtest.rs b/src/compiletest/runtest.rs
index 8c3ee3fb5f4..dbb5703978a 100644
--- a/src/compiletest/runtest.rs
+++ b/src/compiletest/runtest.rs
@@ -1009,6 +1009,10 @@ fn check_expected_errors(revision: Option<&str>,
         expected.replace(r"\", "/")
     }).collect::<Vec<String>>();
 
+    // If the testcase being checked contains at least one expected "help"
+    // message, then we'll ensure that all "help" messages are expected.
+    // Otherwise, all "help" messages reported by the compiler will be ignored.
+    // This logic also applies to "note" messages.
     let (expect_help, expect_note) =
         expected_errors.iter()
                         .fold((false, false),