Skip to content

Commit c895a3b

Browse files
committed
docs/building: modernise libuv mentions
libuv is used by the CPP-Rust Driver only for tests and some of the examples, so let's state that clearly. Also, let's remove exact build instructions for libuv, as they are prone to change with new releases and it's better for the user to refer to the libuv documentation.
1 parent 0dd3bd4 commit c895a3b

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

docs/source/topics/building.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,17 @@ ScyllaDB does not support these platforms.
2020
The C/C++ driver depends on the following software:
2121

2222
* [CMake] v2.6.4+
23-
* [libuv] 1.x
23+
* [libuv] 1.x (only for tests and examples, not required for the driver itself)
2424
* [OpenSSL] v1.0.x or v1.1.x \*
2525

2626
__\*__ Use the `CASS_USE_OPENSSL` CMake option to enable/disable OpenSSL
2727
support. Disabling this option will disable SSL/TLS protocol support
2828
within the driver; defaults to `On`.
2929

30+
Note that only `CMake` is mandatory for building the driver. The others:
31+
- `libuv` is only required for building tests and some of the examples, not the driver itself.
32+
- `OpenSSL` is only required if you want to enable TLS support in the driver.
33+
3034
## Linux/Mac OS
3135

3236
The driver is known to build on CentOS/RHEL 6/7/8, Mac OS X 10.10/10.11 (Yosemite
@@ -67,9 +71,9 @@ brew install autoconf automake cmake libtool
6771

6872
#### libuv
6973

70-
libuv v1.x should be used in order to ensure all features of the C/C++ driver
71-
are available. When using a package manager for your operating system make sure
72-
you install v1.x. Recent package repositories tend to have it available.
74+
**libuv is required only for tests and examples, not required for the driver itself.**
75+
libuv v1.x is recommended. When using a package manager for your operating system,
76+
make sure you install v1.x.
7377

7478
##### Ubuntu
7579

@@ -103,17 +107,8 @@ brew install libuv
103107
_The following procedures should be performed if packages are not available for
104108
your system._
105109

106-
```bash
107-
pushd /tmp
108-
wget http://dist.libuv.org/dist/v1.34.0/libuv-v1.35.0.tar.gz
109-
tar xzf libuv-v1.35.0.tar.gz
110-
pushd libuv-v1.35.0
111-
sh autogen.sh
112-
./configure
113-
make install
114-
popd
115-
popd
116-
```
110+
Browse [https://dist.libuv.org/dist/] and download the newest stable version available.
111+
Follow the instructions in the downloaded package to build and install it.
117112

118113
#### OpenSSL
119114

0 commit comments

Comments
 (0)