Skip to content

Commit

Permalink
Document bundled dependencies and how to disable.
Browse files Browse the repository at this point in the history
Closes #1231. Thanks to Greg Troxel.
  • Loading branch information
ralight committed Apr 26, 2019
1 parent d6c7923 commit 0d01e21
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
1 change: 1 addition & 0 deletions ChangeLog.txt
Expand Up @@ -9,6 +9,7 @@ Clients:

Build:
- Add `make check` target and document testing procedure. Closes #1230.
- Document bundled dependencies and how to disable. Closes #1231.


1.6 - 20190417
Expand Down
10 changes: 7 additions & 3 deletions readme.md
@@ -1,8 +1,8 @@
Eclipse Mosquitto
=================

Mosquitto is an open source implementation of a server for version 3.1 and
3.1.1 of the MQTT protocol. It also includes a C and C++ client library, and
Mosquitto is an open source implementation of a server for version 5.0, 3.1.1,
and 3.1 of the MQTT protocol. It also includes a C and C++ client library, and
the `mosquitto_pub` and `mosquitto_sub` utilities for publishing and
subscribing.

Expand Down Expand Up @@ -66,10 +66,14 @@ already be built. Use `make binary` to skip building the man pages, or install

### Build Dependencies

* c-ares (libc-ares-dev on Debian based systems) - disable with `make WITH_SRV=no`
* c-ares (libc-ares-dev on Debian based systems) - only when compiled with `make WITH_SRV=yes`
* libwebsockets (libwebsockets-dev) - enable with `make WITH_WEBSOCKETS=yes`
* openssl (libssl-dev on Debian based systems) - disable with `make WITH_TLS=no`
* xsltproc (xsltproc and docbook-xsl on Debian based systems) - only needed when building from git sources - disable with `make WITH_DOCS=no`
* uthash / utlist - bundled versions of these headers are provided, disable their use with `make WITH_BUNDLED_DEPS=no`

Equivalent options for enabling/disabling features are available when using the CMake build.


## Credits

Expand Down

0 comments on commit 0d01e21

Please sign in to comment.