Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 898 Bytes

MAINTAINERS.md

File metadata and controls

30 lines (22 loc) · 898 Bytes
Raw

Notes for maintainers

Generating docs from bindings

Whenever updating libproj or bindgen you must regenerate the prebuilt bindings at proj-sys/src/bindings_docs-rs.rs.

These prebuilt bindings are only used for generating documentation - e.g. on https://docs.rs. Actual usage of the crate depends on dynamically built bindings, but that entails having libproj installed or built from source, which we can't expect docs.rs to do.

To update the prebuilt bindings

After updating the source in PROJSRC and the build.rs script to reference the new source, The process of updating bindings looks like:

cd proj-sys
cargo clean
cargo build --features=buildtime_bindgen
find ../target/debug/build/proj-sys* -name bindings.rs

copy that file over the src/bindings_docs-rs.rs, but retain the header:

/* THESE ARE NOT LIVE BINDINGS */
/* THEY EXIST FOR USE BY DOCS-RS ONLY */