diff options
Diffstat (limited to 'contrib/libcbor/doc/source/getting_started.rst')
| -rw-r--r-- | contrib/libcbor/doc/source/getting_started.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/contrib/libcbor/doc/source/getting_started.rst b/contrib/libcbor/doc/source/getting_started.rst index 3e56f2c84c08..98c5a3956337 100644 --- a/contrib/libcbor/doc/source/getting_started.rst +++ b/contrib/libcbor/doc/source/getting_started.rst @@ -50,12 +50,11 @@ Option Meaning ``WITH_TESTS`` Build unit tests (see :doc:`development`) ``OFF`` ``ON``, ``OFF`` ======================== ======================================================= ====================== ===================================================================================================================== -The following configuration options will also be defined as macros[#]_ in ``<cbor/common.h>`` and can therefore be used in client code: +The following configuration options will also be defined as macros [#]_ in ``<cbor/common.h>`` and can therefore be used in client code: ======================== ======================================================= ====================== ===================================================================================================================== Option Meaning Default Possible values ------------------------ ------------------------------------------------------- ---------------------- --------------------------------------------------------------------------------------------------------------------- -``CBOR_CUSTOM_ALLOC`` Enable custom allocator support ``OFF`` ``ON``, ``OFF`` ``CBOR_PRETTY_PRINTER`` Include a pretty-printing routine ``ON`` ``ON``, ``OFF`` ``CBOR_BUFFER_GROWTH`` Factor for buffer growth & shrinking ``2`` Decimals > 1 ======================== ======================================================= ====================== ===================================================================================================================== @@ -64,6 +63,10 @@ Option Meaning If you want to pass other custom configuration options, please refer to `<http://www.cmake.org/Wiki/CMake_Useful_Variables>`_. +.. warning:: + ``CBOR_CUSTOM_ALLOC`` has been `removed <https://github.com/PJK/libcbor/pull/237>`_. + Custom allocators (historically a controlled by a build flag) are always enabled. + **Building using make** CMake will generate a Makefile and other configuration files for the build. As a rule of thumb, you should configure the |