Skip to content

Commit ba3f12e

Browse files
committed
update bindings for docs
1 parent e1ba4ef commit ba3f12e

File tree

2 files changed

+288
-18
lines changed

2 files changed

+288
-18
lines changed

proj-sys/MAINTAINERS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Notes for maintainers
2+
3+
## Generating docs from bindings
4+
5+
Whenever updating libproj or bindgen you must regenerate the prebuilt bindings
6+
at `proj-sys/src/bindings_docs-rs.rs`.
7+
8+
These prebuilt bindings are only used for generating documentation - e.g. on
9+
https://docs.rs. Actual usage of the crate depends on dynamically built bindings, but
10+
that entails having libproj installed or built from source, which we can't
11+
expect docs.rs to do.
12+
13+
## To update the prebuilt bindings
14+
15+
Currently the process looks like:
16+
17+
```
18+
cd proj-sys
19+
cargo clean
20+
cargo build
21+
find ../target/proj-sys-* -name bindings_docs-rs.rs
22+
```
23+
24+
copy that file over the `src/bindings_docs-rs.rs`, but retain the header:
25+
26+
```
27+
/* THESE ARE NOT LIVE BINDINGS */
28+
/* THEY EXIST FOR USE BY DOCS-RS ONLY */
29+
```
30+

0 commit comments

Comments
 (0)