Add a comment to `parse_bool`.

It's behaviour can be surprising.

diff --git a/src/librustc_session/options.rs b/src/librustc_session/options.rs
index a1ecf4e8528beff31ca17171251a398c3e366498..9fd7b7e2e9beb797ee38607c2e10ddd84e15c734 100644 (file)
--- a/src/librustc_session/options.rs
+++ b/src/librustc_session/options.rs
@@ -299,6 +299,9 @@ pub fn $opt(cg: &mut $struct_name, v: Option<&str>) -> bool {
             }
         )*
 
+        /// Set a flag to true. Note that it cannot set the flag to false, so
+        /// using this parser in combination with a flag that defaults to true
+        /// is useless; the flag will always be true.
         fn parse_bool(slot: &mut bool, v: Option<&str>) -> bool {
             match v {
                 Some(..) => false,