summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Fitzgerald <fitzgen@gmail.com>2017-09-07 11:24:20 -0700
committerNick Fitzgerald <fitzgen@gmail.com>2017-09-07 11:24:20 -0700
commit0e12ee912f32be51a4618a0e004d5a8b8c851790 (patch)
treec7aeff76c0529838cfc39e6f3cb206bc3fa2d00e
parent4d04af6f8695f49bf943f38b567968e0ebc78425 (diff)
Don't duplicate large comments; just reference them instead
-rw-r--r--src/options.rs29
1 files changed, 4 insertions, 25 deletions
diff --git a/src/options.rs b/src/options.rs
index 28c4cc60..50238f1c 100644
--- a/src/options.rs
+++ b/src/options.rs
@@ -93,31 +93,10 @@ where
https://github.com/rust-lang-nursery/rust-bindgen/issues/426"),
Arg::with_name("no-recursive-whitelist")
.long("no-recursive-whitelist")
- .help(r#"Disable whitelisting types recursively.
-
-Given that we have explicitly whitelisted the "initiate_dance_party" function in
-this C header:
-
- typedef struct MoonBoots {
- int bouncy_level;
- } MoonBoots;
-
- void initiate_dance_party(MoonBoots* boots);
-
-We would normally generate bindings to both the `initiate_dance_party` function
-and the `MoonBoots` struct that it transitively references. By configuring with
-`--no-recursive-whitelist`, `bindgen` will not emit bindings for anything except
-the explicitly whitelisted items, and there would be no emitted struct
-definition for `MoonBoots`. However, the `initiate_dance_party` function would
-still reference `MoonBoots`!
-
-Disabling this feature will almost certainly cause `bindgen` to emit bindings
-that will not compile! If you disable this feature, then it is your
-responsiblity to provide definitions for every type that is referenced from an
-explicitly whitelisted item. One way to provide the definitions is by using the
-`--raw-line` flag, another would be to define them in Rust and then
-`include!(...)` the bindings immediately afterwards.
-"#),
+ .help("Disable whitelisting types recursively. This will cause \
+ bindgen to emit Rust code that won't compile! See the \
+ `bindgen::Builder::whitelist_recursively` method's \
+ documentation for details."),
Arg::with_name("objc-extern-crate")
.long("objc-extern-crate")
.help("Use extern crate instead of use for objc."),