Skip to content

Commit 296c3ad

Browse files
committed
add note to update docs.rs bindings
[ci skip]
1 parent 24d703d commit 296c3ad

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

allowed_bindings.rs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44
// exist in the bindings file. Which ever script include!s the bindings must
55
// define the `bind` macro. This allows us to have the list in string format
66
// inside the build script and in macro format inside the CLI crate.
7+
//
8+
// NOTE TO EDITORS:
9+
// When updating this file, you must re-generate the `docsrs_bindings.rs`
10+
// file used by docs.rs to build documentation. To perform this:
11+
//
12+
// $ cargo clean
13+
// $ cargo build
14+
// $ cp target/debug/build/ext-php-rs-e2cb315d27898d01/out/bindings.rs
15+
// docsrs_bindings.rs
16+
// $ git add . && git commit -m "update docs.rs bindings"
17+
//
18+
// The hash after `ext-php-rs-` in the bindings path may change. There should
19+
// be two folders beginning with `ext-php-rs-` in `target/debug/build`, so
20+
// check both for the presense of the bindings file.
721

822
bind! {
923
HashTable,

0 commit comments

Comments
 (0)