Skip to content

Commit 97d10f8

Browse files
committed
Update docs
1 parent 6c1cc2f commit 97d10f8

File tree

1 file changed

+3
-16
lines changed

1 file changed

+3
-16
lines changed

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -204,32 +204,19 @@ You can adjust this behavior in a number of ways:
204204
cargo build --examples
205205
```
206206

207-
3. _Experimental:_ Setting `DUCKDB_DOWNLOAD_LIB=1` makes the build script download
208-
prebuilt DuckDB binaries from the official DuckDB releases for the active `TARGET`.
209-
This is the quickest way to use the official binaries without manually downloading
210-
them, but the feature is still considered experimental.
211-
The archives are cached in `target/duckdb-download/<target>/<version>` (or under
212-
`CARGO_TARGET_DIR` if set) and that directory is added to the linker search path
213-
automatically, including an rpath on Unix so runtime lookup works without
214-
additional environment variables. The downloaded version always matches the
215-
`libduckdb-sys` crate version.
207+
3. _Experimental:_ Setting `DUCKDB_DOWNLOAD_LIB=1` makes the build script download pre-built DuckDB binaries from GitHub Releases. This always links against the dynamic library in the archive (setting `DUCKDB_STATIC` has no effect), and it effectively automates the manual steps above. The archives are cached in `target/duckdb-download/<target>/<version>` and that directory is automatically added to the linker search path. The downloaded version always matches the `libduckdb-sys` crate version.
216208

217209
```shell
218210
DUCKDB_DOWNLOAD_LIB=1 cargo test
219211
```
220212

221-
Supported `TARGET`s include `x86_64-unknown-linux-gnu`, `aarch64-unknown-linux-gnu`,
222-
`x86_64-apple-darwin`, `aarch64-apple-darwin`, `x86_64-pc-windows-msvc`, and
223-
`aarch64-pc-windows-msvc`.
224-
225213
4. Installing the duckdb development packages will usually be all that is required, but
226214
the build helpers for [pkg-config](https://github.com/alexcrichton/pkg-config-rs)
227215
and [vcpkg](https://github.com/mcgoo/vcpkg-rs) have some additional configuration
228216
options. The default when using vcpkg is to dynamically link,
229217
which must be enabled by setting `VCPKGRS_DYNAMIC=1` environment variable before build.
230-
When none of the options above are used, the build script falls back to this discovery
231-
path and will emit the appropriate `cargo:rustc-link-lib` directives if DuckDB is found
232-
on your system.
218+
219+
When none of the options above are used, the build script falls back to this discovery path and will emit the appropriate `cargo:rustc-link-lib` directives if DuckDB is found on your system.
233220

234221
### ICU extension and the bundled feature
235222

0 commit comments

Comments
 (0)