diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 26 |
1 files changed, 11 insertions, 15 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 68dfb68e..33b65a20 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,14 +1,12 @@ ### Input C/C++ Header ```C++ -// Insert your (minimal) C/C++ header here +// Insert your (minimal) C/C++ header here. ``` ### Bindgen Invokation -<!-- - -Place either the `bindgen::Builder` **OR** the command line flags used here. +<!-- Place either the `bindgen::Builder` or the command line flags used here. --> ```Rust bindgen::Builder::default() @@ -17,26 +15,22 @@ bindgen::Builder::default() .unwrap() ``` -OR +or ``` $ bindgen input.h --whatever --flags ``` ---> - ### Actual Results -<!-- - ``` -Insert panic message and backtrace here. +Insert panic message and backtrace (set the `RUST_BACKTRACE=1` env var) here. ``` and/or ```rust -// Insert the (incorrect) generated bindings here +// Insert the (incorrect/buggy) generated bindings here ``` and/or @@ -45,19 +39,21 @@ and/or Insert compilation errors generated when compiling the bindings with rustc here ``` ---> - ### Expected Results <!-- Replace this with a description of what you expected instead of the actual results. The more precise, the better! For example, if a struct in the generated -bindings is missing a field that exists in the C/C++ struct, not that here. +bindings is missing a field that exists in the C/C++ struct, note that here. --> ### `RUST_LOG=bindgen` Output +<details> + ``` -Insert debug logging when running bindgen with the RUST_LOG=bindgen environment +Insert debug logging when running bindgen with the `RUST_LOG=bindgen` environment variable set. ``` + +</details> |