097203968f
135ab5cf Update version 93d95f17 Fix markup 4f15c72f Fix markup e9b19414 Automatically add package to release c3d1f604 Fix markup c96062bf Update changelog and version number f9c97de4 Add note about errno to the documentation 62df6f27 CMakeLists: Use GNUInstallDirs to set install location 493586cb Fix overflow check 1d751bc6 fix warning in header: signed/unsigned comparison 11415bce Update usage.rst 9982dd01 Fix for warning C5030 in VS2015 42e88c4f Silenced MSVC 2017 constant if expression warning 7a9c1ba1 FMT_VARIADIC_CONST - Support for const variadic methods (#591) 324415c0 Use allocator_traits if available. 5f39721c Fix a warning ca96acbe Add examples 708d9509 fix(Clang CodeGen): remove warnings 9328a074 Fix handling of fixed enums in clang (#580) 2c077dd4 Enable stream exceptions (#581) 933a33a7 Added MSVC checking for support for string_view. bef89db6 Fix a bogus -Wduplicated-branches gcc warning (#573) 2a619d96 Make format work with C++17 std::string_view (#571) e051de37 Use less version 2.6.1 and sudo to fix npm install issues on travis 5de459bf Suppress Clang's warning on zero as a null pointer 16589534 Make ArgMap::init not explicitly instantiated (#563) 3e75d3e0 Fix handling of types convertible to int 89654cd1 to_wstring added 37eb419a Fix noreturn attribute detection (#555) 14d85349 Explicitly cast range length to std::size_t to prevent conversion warnings c2201ce0 Accept wide chars as integers to prevent conversion warning 6efbccb3 Add one more CMake warning fix 032c8380 Fix a segfault in test on glibc 2.26 #551, take 2 6655e804 Fix a segfault in test on glibc 2.26 #551 d16c4d20 Suppress warning about missing noreturn attribute (#549) 9c56a8ce Make format_arg() accept class hierarchies ca0e3830 Update README.rst 81790d72 Update format.h to remove C4574 error on MSVC 14.2 30283443 Fix undefined behavior in UDL macro 4045d7fe Fix warning about missing ' character 89c3bc58 Remove warning C4668 in MSVC for FMT_GCC_VERSION and FMT_HAS_GXX_CXX11 4af9421f Adding OpenSpace to the list of projects 1a398b54 Fixed CMake CMP0048 warning. 589ccc16 Bump version c3817046 Add an error on broken includes 16bdd842 Update scripts b492316d Update version list 91f4ce02 Automatically update version in release script (#431) git-subtree-dir: externals/fmt git-subtree-split: 135ab5cf71ed731fc9fa0653051e7d4884a3652f
115 lines
3.9 KiB
ReStructuredText
115 lines
3.9 KiB
ReStructuredText
*****
|
|
Usage
|
|
*****
|
|
|
|
To use the fmt library, add :file:`format.h` and :file:`format.cc` from
|
|
a `release archive <https://github.com/fmtlib/fmt/releases/latest>`_
|
|
or the `Git repository <https://github.com/fmtlib/fmt>`_ to your project.
|
|
Alternatively, you can :ref:`build the library with CMake <building>`.
|
|
|
|
If you are using Visual C++ with precompiled headers, you might need to add
|
|
the line ::
|
|
|
|
#include "stdafx.h"
|
|
|
|
before other includes in :file:`format.cc`.
|
|
|
|
.. _building:
|
|
|
|
Building the library
|
|
====================
|
|
|
|
The included `CMake build script`__ can be used to build the fmt
|
|
library on a wide range of platforms. CMake is freely available for
|
|
download from http://www.cmake.org/download/.
|
|
|
|
__ https://github.com/fmtlib/fmt/blob/master/CMakeLists.txt
|
|
|
|
CMake works by generating native makefiles or project files that can
|
|
be used in the compiler environment of your choice. The typical
|
|
workflow starts with::
|
|
|
|
mkdir build # Create a directory to hold the build output.
|
|
cd build
|
|
cmake <path/to/fmt> # Generate native build scripts.
|
|
|
|
where :file:`{<path/to/fmt>}` is a path to the ``fmt`` repository.
|
|
|
|
If you are on a \*nix system, you should now see a Makefile in the
|
|
current directory. Now you can build the library by running :command:`make`.
|
|
|
|
Once the library has been built you can invoke :command:`make test` to run
|
|
the tests.
|
|
|
|
You can control generation of the make ``test`` target with the ``FMT_TEST``
|
|
CMake option. This can be useful if you include fmt as a subdirectory in
|
|
your project but don't want to add fmt's tests to your ``test`` target.
|
|
|
|
If you use Windows and have Visual Studio installed, a :file:`FORMAT.sln`
|
|
file and several :file:`.vcproj` files will be created. You can then build them
|
|
using Visual Studio or msbuild.
|
|
|
|
On Mac OS X with Xcode installed, an :file:`.xcodeproj` file will be generated.
|
|
|
|
To build a `shared library`__ set the ``BUILD_SHARED_LIBS`` CMake variable to
|
|
``TRUE``::
|
|
|
|
cmake -DBUILD_SHARED_LIBS=TRUE ...
|
|
|
|
__ http://en.wikipedia.org/wiki/Library_%28computing%29#Shared_libraries
|
|
|
|
Header-only usage with CMake
|
|
============================
|
|
|
|
In order to add ``fmtlib`` into an existing ``CMakeLists.txt`` file, you can add the ``fmt`` library directory into your main project, which will enable the ``fmt`` library::
|
|
|
|
add_subdirectory(fmt)
|
|
|
|
If you have a project called ``foo`` that you would like to link against the fmt library in a header-only fashion, you can enable with with::
|
|
|
|
target_link_libraries(foo PRIVATE fmt::fmt-header-only)
|
|
|
|
And then to ensure that the ``fmt`` library does not always get built, you can modify the call to ``add_subdirectory`` to read ::
|
|
|
|
add_subdirectory(fmt EXCLUDE_FROM_ALL)
|
|
|
|
This will ensure that the ``fmt`` library is exluded from calls to ``make``, ``make all``, or ``cmake --build .``.
|
|
|
|
Building the documentation
|
|
==========================
|
|
|
|
To build the documentation you need the following software installed on your
|
|
system:
|
|
|
|
* `Python <https://www.python.org/>`_ with pip and virtualenv
|
|
* `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_
|
|
* `Less <http://lesscss.org/>`_ with ``less-plugin-clean-css``.
|
|
Ubuntu doesn't package the ``clean-css`` plugin so you should use ``npm``
|
|
instead of ``apt`` to install both ``less`` and the plugin::
|
|
|
|
sudo npm install -g less less-plugin-clean-css.
|
|
|
|
First generate makefiles or project files using CMake as described in
|
|
the previous section. Then compile the ``doc`` target/project, for example::
|
|
|
|
make doc
|
|
|
|
This will generate the HTML documentation in ``doc/html``.
|
|
|
|
Android NDK
|
|
===========
|
|
|
|
fmt provides `Android.mk file`__ that can be used to build the library
|
|
with `Android NDK <https://developer.android.com/tools/sdk/ndk/index.html>`_.
|
|
For an example of using fmt with Android NDK, see the
|
|
`android-ndk-example <https://github.com/fmtlib/android-ndk-example>`_
|
|
repository.
|
|
|
|
__ https://github.com/fmtlib/fmt/blob/master/Android.mk
|
|
|
|
Homebrew
|
|
========
|
|
|
|
fmt can be installed on OS X using `Homebrew <http://brew.sh/>`_::
|
|
|
|
brew install fmt
|