From bc2d9621e2ea970d76562f5d3fb0dfb8e4a357d4 Mon Sep 17 00:00:00 2001 From: Felix Krull Date: Thu, 18 Oct 2018 22:02:43 +0200 Subject: [PATCH] Update readme --- rust-bindings/rust/README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/rust-bindings/rust/README.md b/rust-bindings/rust/README.md index ba2f95e0..41051952 100644 --- a/rust-bindings/rust/README.md +++ b/rust-bindings/rust/README.md @@ -62,18 +62,19 @@ $ make update-gir-files ### Documentation The libostree API documentation is not included in the code by default because of its LGPL license. This means normal `cargo doc` runs don't include API docs -for the generated code. Build the crate with the `lgpl-docs` feature to merge -the API docs into the code: +for the generated code. Run the `merge-lgpl-docs` Makefile target to include +the API docs in the source so they can be consumed by `cargo doc`: ```ShellSession -$ cd libostree/ -$ cargo doc --features "dox lgpl-docs" +$ make merge-lgpl-docs ``` -(The `dox` feature enables all functions etc. regardless of version.) Keep in -mind that if you build the crate with the `lgpl-docs` feature, it is effectively -LGPL-licensed and you need to comply with the LGPL requirements (specifically, -allowing users of your end product to swap out the LGPL'd parts). +Keep in mind that if you build the crate with the API docs included, it is +effectively LGPL-licensed and you need to comply with the LGPL requirements +(specifically, allowing users of your end product to swap out the LGPL'd +parts). + +CI includes the LGPL docs in the documentation build. ### Releases Releases can be done using the publish_* jobs in the pipeline. There's no