Skip to content

Commit 9ef8986

Browse files
committed
Improved documentation of build issues
1 parent 2356564 commit 9ef8986

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,29 @@ SQLite3 has its own [online documentation](http://www.sqlite.org/docs.html).
2828
The `test`-directory in this distribution contains a few simple examples
2929
for testing various features of this library.
3030

31-
### Building
31+
### Build issues
3232

33-
SQLite3-OCaml depends upon `pkg-config` to locate and compile against an [SQLite3](http://www.sqlite.org) library compiled with [Run-Time Loadable Extensions](http://www.sqlite.org/loadext.html). If you're missing this, the build will fail with:
33+
SQLite3-OCaml depends on `pkg-config` to locate and compile against an
34+
[SQLite3](http://www.sqlite.org) library.
35+
36+
If the SQLite3 version is larger than or equal to 3.3.7, it is assumed that it
37+
supports [Run-Time Loadable Extensions](http://www.sqlite.org/loadext.html).
38+
If this feature has been explicitly disabled in the library, the build will
39+
fail with:
3440

3541
```
36-
Undefined symbols for architecture ....:
42+
Undefined symbols for architecture ...:
3743
"_sqlite3_enable_load_extension", referenced from:
3844
_caml_sqlite3_enable_load_extension in libsqlite3_stubs.a(sqlite3_stubs.o)
3945
(maybe you meant: _caml_sqlite3_enable_load_extension)
4046
```
4147

42-
- You can check if your library is missing the extensions by checking for the string `OMIT_LOAD_EXTENSION`.
43-
- If you need to redirect where `pkg-config` finds the library, set the `PKG_CONFIG_PATH` environment variable to the new directory.
48+
* You can check if your library is missing loadable extensions by searching
49+
it for the string `OMIT_LOAD_EXTENSION`.
50+
51+
* If you need to change where `pkg-config` will look for the SQLite3
52+
library, set the `PKG_CONFIG_PATH` environment variable to the new
53+
directory.
4454

4555
Credits
4656
-------
@@ -73,4 +83,4 @@ Up-to-date information should be available at:
7383

7484
Enjoy!
7585

76-
Markus Mottl on July 10, 2012
86+
Markus Mottl on February 9, 2015

0 commit comments

Comments
 (0)