Skip to content

Commit

Permalink
Disable lvgl original comments in bindings
Browse files Browse the repository at this point in the history
We disable the comments generation here because some comments
cause the `cargo test` command to fail. Some of the original
comments have invalid tokens like `TYPEDEFS` causing issues.
We should recommend users to look the original comments in the
original lvgl in their C API docs.
  • Loading branch information
rafaelcaricio committed Mar 6, 2021
1 parent da8bae1 commit bcd771d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ In order to build the `lvgl` project you will need the following system dependen
$ sudo apt install build-essential llvm clang
```

If you want to build the examples, then you will need to install SDL2 as well.

```
$ sudo apt install libsdl2-dev
```

## Usage

Edit your `Cargo.toml` file dependencies with:
Expand Down
1 change: 1 addition & 0 deletions lvgl-sys/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ fn main() {
let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
let bindings = bindgen::Builder::default()
.header(shims_dir.join("lvgl_sys.h").to_str().unwrap())
.generate_comments(false)
.layout_tests(false)
.use_core()
.rustfmt_bindings(true)
Expand Down

0 comments on commit bcd771d

Please sign in to comment.